Skip to content

Commit 915e119

Browse files
author
Bruno Sutic
committed
Describe various options in the readme
Closes #15
1 parent ddcee50 commit 915e119

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
### master
44
- more options for customizing tree sidebar
5+
- describe various options in the readme
56

67
### v0.5.0, Sep 04, 2014
78
- key bindings work from the sidebar now too

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,33 @@ Reload TMUX environment:
5959

6060
You should now be able to use the plugin.
6161

62+
### Options
63+
64+
You can customize `tmux-sidebar` by placing the options to `.tmux.conf` and
65+
reloading Tmux environment.
66+
67+
> Can I have the sidebar on the right?
68+
69+
set -g @sidebar-tree-position 'right'
70+
71+
> I don't like the default 'prefix + Tab' key binding. Can I change it to be
72+
'prefix + e'?
73+
74+
set -g @sidebar-tree 'e'
75+
76+
> How can I change the default 'prefix + Backspace' to be 'prefix + w'?
77+
78+
set -g @sidebar-tree-focus 'w'
79+
80+
> I see the tree sidebar uses 'less' as a pager. I would like to use 'more'.
81+
82+
set -g @sidebar-tree-pager 'more'
83+
84+
> The default sidebar width is 40 columns. I want the sidebar to be wider by
85+
default!
86+
87+
set -g @sidebar-tree-width '60'
88+
6289
### Other goodies
6390

6491
- [tmux-copycat](https://github.com/tmux-plugins/tmux-copycat) - a plugin for

0 commit comments

Comments
 (0)