-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add more document and handle no first window
- Loading branch information
1 parent
b663c64
commit d95d48e
Showing
8 changed files
with
195 additions
and
23 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
name="simple-session" | ||
dir="~/" | ||
select-window="" | ||
select-pane=1 | ||
clear-panes=true | ||
window-scripts=["ls"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
name="single-window-session" | ||
dir="~/Desktop" | ||
|
||
[[windows]] | ||
name="window-one" | ||
dir="~/" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,163 @@ | ||
--- | ||
title: Configuration | ||
--- | ||
|
||
Tmuxctl works with configuration files. Here is the list of possible options | ||
|
||
## name | ||
|
||
You can set a session name | ||
|
||
```toml | ||
name="session-name" | ||
``` | ||
|
||
## dir | ||
|
||
You can set a base directory for your windows | ||
|
||
```toml | ||
dir="~/zad" | ||
``` | ||
|
||
## select-window | ||
|
||
You can choose which window to attach to on start | ||
|
||
```toml | ||
select-window="window-name" | ||
``` | ||
|
||
## select-pane | ||
|
||
You can choose which pane to attach to on start (the index of the pane in the window starting from 1) | ||
|
||
```toml | ||
select-pane=2 | ||
``` | ||
|
||
## clear-panes | ||
|
||
You can clear the panes (C-l) after initialisation | ||
|
||
```toml | ||
clear-panes=true | ||
``` | ||
|
||
## window-scripts | ||
|
||
You can run scripts in every window (runs before anything else in a window) | ||
|
||
```toml | ||
window-scripts=[ | ||
"cd folder", | ||
"ls -larth" | ||
] | ||
``` | ||
|
||
## [[windows]] | ||
|
||
You can add windows like follow | ||
|
||
```toml | ||
name="session-name" | ||
|
||
[[windows]] | ||
|
||
[[windows]] | ||
|
||
[[windows]] | ||
``` | ||
|
||
## name | ||
|
||
You can give a name to a window | ||
|
||
```toml | ||
name="window-name" | ||
``` | ||
|
||
## dir | ||
|
||
You can start a window in a directory (every pane in this window will start there by default) | ||
|
||
```toml | ||
dir="/some-dir" | ||
``` | ||
|
||
## scripts | ||
|
||
You can run scripts in the window before it is splitted in panes (they will run once) | ||
|
||
```toml | ||
scripts=[ | ||
"do sth" | ||
] | ||
``` | ||
|
||
## pane-scripts | ||
|
||
You can run scripts in every pane of a window if needed | ||
|
||
```toml | ||
pane-scripts=[ | ||
"do sth" | ||
] | ||
``` | ||
|
||
## sync | ||
|
||
You can synchronize all the panes of a window | ||
|
||
```toml | ||
sync=true | ||
``` | ||
|
||
## [[windows.panes]] | ||
|
||
You can declare all the paes you want to have in a window | ||
|
||
```toml | ||
name="session-name" | ||
|
||
[[windows]] | ||
name="window-name" | ||
|
||
[[windows.panes]] | ||
|
||
[[windows.panes]] | ||
|
||
[[windows.panes]] | ||
``` | ||
|
||
## dir | ||
|
||
You can start a pane in a specific dir | ||
|
||
```toml | ||
dir="/some-dir" | ||
``` | ||
|
||
## scripts | ||
|
||
You can run a list of scripts in a specific pane | ||
|
||
```toml | ||
scripts=["do stuff"] | ||
``` | ||
|
||
## split | ||
|
||
You can specify the split options to setup a pane size. See [the docs](https://www.systutorials.com/docs/linux/man/1-tmux/) for split-window options | ||
|
||
```toml | ||
split="-f -h" | ||
``` | ||
|
||
## zoom | ||
|
||
You can set a pane as zoomed (only visible pane in the window) on startup | ||
|
||
```toml | ||
zoom=true | ||
``` |