Skip to content

Commit a2719a6

Browse files
author
Bruno Sutic
committed
Move customization options to a separate docs page
1 parent 93084c7 commit a2719a6

File tree

3 files changed

+44
-38
lines changed

3 files changed

+44
-38
lines changed

CHANGELOG.md

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

33
### master
4+
- move customization options to a separate docs document
45

56
### v0.8.0, Apr 05, 2015
67
- do not colorize `tree` output because a pager application might not handle it

README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -56,45 +56,9 @@ Reload TMUX environment:
5656

5757
You should now be able to use the plugin.
5858

59-
### Options
59+
### Docs
6060

61-
Customize `tmux-sidebar` by placing options in `.tmux.conf` and reloading Tmux
62-
environment.
63-
64-
> How can I run some other command in the sidebar?
65-
66-
set -g @sidebar-tree-command 'ls -1'
67-
68-
> Can I have the sidebar on the right?
69-
70-
set -g @sidebar-tree-position 'right'
71-
72-
> I don't like the default 'prefix + Tab' key binding. Can I change it to be
73-
'prefix + e'?
74-
75-
set -g @sidebar-tree 'e'
76-
77-
> How can I change the default 'prefix + Backspace' to be 'prefix + w'?
78-
79-
set -g @sidebar-tree-focus 'w'
80-
81-
> I see the tree sidebar uses 'less' as a pager. I would like to use 'view'.
82-
83-
set -g @sidebar-tree-pager 'view -'
84-
85-
> The default sidebar width is 40 columns. I want the sidebar to be wider by
86-
default!
87-
88-
set -g @sidebar-tree-width '60'
89-
90-
> Can I colorize the ``tree`` directory listing in the sidebar?
91-
92-
set -g @sidebar-tree-command 'tree -C'
93-
94-
> Bear in mind that the command used to page the directory listing
95-
(``@sidebar-tree-pager``, if set) must support color codes. If it does not,
96-
unusual characters - the color control codes - will be visible in the
97-
sidebar.
61+
- [customization options](docs/options.md)
9862

9963
### Other goodies
10064

docs/options.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Options
2+
3+
Customize `tmux-sidebar` by placing options in `.tmux.conf` and reloading Tmux
4+
environment.
5+
6+
> How can I run some other command in the sidebar?
7+
8+
set -g @sidebar-tree-command 'ls -1'
9+
10+
> Can I have the sidebar on the right?
11+
12+
set -g @sidebar-tree-position 'right'
13+
14+
> I don't like the default 'prefix + Tab' key binding. Can I change it to be
15+
'prefix + e'?
16+
17+
set -g @sidebar-tree 'e'
18+
19+
> How can I change the default 'prefix + Backspace' to be 'prefix + w'?
20+
21+
set -g @sidebar-tree-focus 'w'
22+
23+
> I see the tree sidebar uses 'less' as a pager. I would like to use 'view'.
24+
25+
set -g @sidebar-tree-pager 'view -'
26+
27+
> The default sidebar width is 40 columns. I want the sidebar to be wider by
28+
default!
29+
30+
set -g @sidebar-tree-width '60'
31+
32+
> Can I colorize the ``tree`` directory listing in the sidebar?
33+
34+
set -g @sidebar-tree-command 'tree -C'
35+
36+
### Notes
37+
38+
The command used to display the directory listing
39+
(`@sidebar-tree-pager`, if set) must support color codes. If it does not,
40+
unusual characters - the color control codes - will be visible in the sidebar.
41+

0 commit comments

Comments
 (0)