@@ -172,16 +172,18 @@ $ tmux source-file ~/.tmux.conf
172172If you want to open a playbook from a script you can use the ` tome-open-playbook ` command. It can be found where you installed the tmux plugin.
173173
174174```
175- Usage: tome-open-playbook [-s] [-l height ]
175+ Usage: tome-open-playbook [-s] [-l size] [-H | -V ]
176176```
177177
178- - ` -s ` will open a scratchpad
179- - ` -l ` allows you to specify a height
178+ Uses the defaults set in tmux, you can override them with the options
180179
180+ - ` -s ` will open a scratchpad
181+ - ` -l ` allows you to specify a size in lines/columns or as a percentage (e.g. ` 8 ` or ` 50% ` )
182+ - ` -H ` horizontal split
183+ - ` -V ` vertical split
181184
182185## Configuration
183186
184-
185187### Vim options
186188
187189By default Tome has the following mappings:
@@ -194,7 +196,6 @@ xmap <Leader>p <Plug>(TomePlaySelection)
194196
195197[ See ` help TomeConfig ` ] ( doc/tome.txt ) in Vim to change them, and for more options.
196198
197-
198199### tmux options
199200
200201You can set any of these options by adding them to your ` ~/.tmux.conf ` file:
@@ -203,14 +204,17 @@ You can set any of these options by adding them to your `~/.tmux.conf` file:
203204set -g <option> "<value>"
204205```
205206
206- Where ` <option> ` and ` <value> ` correspond to one of the options specified below
207+ Where ` <option> ` and ` <value> ` correspond to one of the options specified below:
207208
208209| Option | Default | Description |
209210| :--- | :---: | :--- |
210211| ` @tome_key ` | ` p ` | The key binding to open a Tome playbook. |
211212| ` @tome_scratch_key ` | ` P ` | The key binding to open a Tome scratchpad. |
212- | ` @tome_height ` | ` 8 ` | Height of the playbook vertial split. |
213+ | ` @tome_split ` | ` vertical ` | Split the window ` vertical ` panes stacked (top/bottom) or ` horizontal ` side by side (left/right). |
214+ | ` @tome_size ` | ` 8 ` or ` 50% ` (h) | Size of the playbook split:<br >- ` 8 ` lines when vertical<br >- ` 50% ` columns when horizontal. |
215+ | ` @tome_height ` | * (deprecated)* | Legacy option kept for backward compatibility. Prefer ` @tome_size ` . |
213216| ` @tome_editor ` | detect (n)vim | Manually set your preferred editor. |
214217| ` @tome_playbook ` | ` .playbook.sh ` | Name of the playbook to open. |
215218
216219
220+
0 commit comments