diff options
author | Mikkel Oscar Lyderik <mikkeloscar@gmail.com> | 2016-03-17 15:35:43 +0100 |
---|---|---|
committer | Mikkel Oscar Lyderik <mikkeloscar@gmail.com> | 2016-03-17 15:41:24 +0100 |
commit | db7697b830e50cffb6fb9bf6a2acfccfda81221e (patch) | |
tree | 84ec89d45327609dbd2985c78d0a65d4095da8cd /sway | |
parent | Merge pull request #512 from mikkeloscar/bg-panel-render (diff) | |
download | sway-db7697b830e50cffb6fb9bf6a2acfccfda81221e.tar.gz sway-db7697b830e50cffb6fb9bf6a2acfccfda81221e.tar.zst sway-db7697b830e50cffb6fb9bf6a2acfccfda81221e.zip |
Document swaybar commands
Documents most of the bar commands in sway-bar(5) manpage.
The following command has not been document because they haven't been
fully implemented yet:
* mode
* hidden_state
* modifier
* tray_output
* tray_padding
Close #375
Diffstat (limited to 'sway')
-rw-r--r-- | sway/CMakeLists.txt | 1 | ||||
-rw-r--r-- | sway/sway-bar.5.txt | 112 | ||||
-rw-r--r-- | sway/sway-input.5.txt | 2 | ||||
-rw-r--r-- | sway/sway.5.txt | 2 |
4 files changed, 115 insertions, 2 deletions
diff --git a/sway/CMakeLists.txt b/sway/CMakeLists.txt index e49d1d3d..5b6104f3 100644 --- a/sway/CMakeLists.txt +++ b/sway/CMakeLists.txt | |||
@@ -57,3 +57,4 @@ install( | |||
57 | add_manpage(sway 1) | 57 | add_manpage(sway 1) |
58 | add_manpage(sway 5) | 58 | add_manpage(sway 5) |
59 | add_manpage(sway-input 5) | 59 | add_manpage(sway-input 5) |
60 | add_manpage(sway-bar 5) | ||
diff --git a/sway/sway-bar.5.txt b/sway/sway-bar.5.txt new file mode 100644 index 00000000..c23519a4 --- /dev/null +++ b/sway/sway-bar.5.txt | |||
@@ -0,0 +1,112 @@ | |||
1 | ///// | ||
2 | vim:set ts=4 sw=4 tw=82 noet: | ||
3 | ///// | ||
4 | sway-bar (5) | ||
5 | ============ | ||
6 | |||
7 | Name | ||
8 | ---- | ||
9 | sway-bar - bar configuration file and commands | ||
10 | |||
11 | Description | ||
12 | ----------- | ||
13 | |||
14 | Sway allows for configuration of swaybar within the sway configuation file. | ||
15 | Swaybar commands must be used inside a _bar { }_ block in the config. | ||
16 | |||
17 | |||
18 | Commands | ||
19 | -------- | ||
20 | |||
21 | **status_command** <status command>:: | ||
22 | Executes the bar _status command_ with _sh -c_. | ||
23 | |||
24 | **id** <bar_id>:: | ||
25 | Sets the ID of the bar. | ||
26 | |||
27 | **position** <top|bottom|left|right>:: | ||
28 | Sets position of the bar. Default is _bottom_. | ||
29 | |||
30 | **output** <output>:: | ||
31 | Restrict the bar to a certain output, can be specified multiple times. If the | ||
32 | output command is omitted, the bar will be displayed on all outputs. | ||
33 | |||
34 | **swaybar_command** <command>:: | ||
35 | Executes custom bar command, default is _swaybar_. | ||
36 | |||
37 | **font** <font>:: | ||
38 | Specifies the font to be used in the bar. | ||
39 | |||
40 | **separator_symbol** <symbol>:: | ||
41 | Specifies the separator symbol to separate blocks on the bar. | ||
42 | |||
43 | **workspace_buttons** <yes|no>:: | ||
44 | Enables or disables workspace buttons on the bar. Default is to enable | ||
45 | buttons. | ||
46 | |||
47 | **strip_workspace_numbers** <yes|no>:: | ||
48 | If set to _yes_, then workspace numbers will be omitted from the workspace | ||
49 | button and only the custom name will be shown. | ||
50 | |||
51 | **binding_mode_indicator** <yes|no>:: | ||
52 | Enable or disable binding mode indicator. It's enabled by default. | ||
53 | |||
54 | **height** <height>:: | ||
55 | Sets the height of the bar. Default height will match the font size. | ||
56 | |||
57 | Colors | ||
58 | ------ | ||
59 | |||
60 | Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors | ||
61 | must be defined in hex. E.g. _#fff000_ or _#fff000ff_ when including the alpha | ||
62 | channel. | ||
63 | |||
64 | **background** <color>:: | ||
65 | Background color of the bar. | ||
66 | |||
67 | **statusline** <color>:: | ||
68 | Text color to be used for the statusline. | ||
69 | |||
70 | **separator** <color>:: | ||
71 | Text color to be used for the separator. | ||
72 | |||
73 | **focused_background** <color>:: | ||
74 | Background color of the bar on the currently focused monitor output. If not | ||
75 | used, the color will be taken from _background_. | ||
76 | |||
77 | **focused_statusline** <color>:: | ||
78 | Text color to be used for the statusline on the currently focused monitor | ||
79 | output. If not used, the color will be taken from _statusline_. | ||
80 | |||
81 | **focused_separator** <color>:: | ||
82 | Text color to be used for the separator on the currently focused monitor | ||
83 | output. If not used, the color will be taken from _separator_. | ||
84 | |||
85 | **focused_workspace** <border> <background> <text>:: | ||
86 | Border, background and text color for a workspace button when the workspace | ||
87 | has focus. | ||
88 | |||
89 | **active_workspace** <border> <background> <text>:: | ||
90 | Border, background and text color for a workspace button when the workspace is | ||
91 | active (visible) on some output, but the focus is on another one. You can only | ||
92 | tell this apart from the focused workspace when you are using multiple | ||
93 | monitors. | ||
94 | |||
95 | **inactive_workspace** <border> <background> <text>:: | ||
96 | Border, background and text color for a workspace button when the workspace | ||
97 | does not have focus and is not active (visible) on any output. This will be | ||
98 | the case for most workspaces. | ||
99 | |||
100 | **urgent_workspace** <border> <background> <text>:: | ||
101 | Border, background and text color for a workspace button when the workspace | ||
102 | contains a window with the urgency hint set. | ||
103 | |||
104 | **binding_mode** <border> <background> <text>:: | ||
105 | Border, background and text color for the binding mode indicator. If not used, | ||
106 | the colors will be taken from _urgent_workspace_. | ||
107 | |||
108 | |||
109 | See Also | ||
110 | -------- | ||
111 | |||
112 | **sway**(5) **sway-input**(5) | ||
diff --git a/sway/sway-input.5.txt b/sway/sway-input.5.txt index 1380d1f4..1ef1dbf8 100644 --- a/sway/sway-input.5.txt +++ b/sway/sway-input.5.txt | |||
@@ -48,4 +48,4 @@ Commands | |||
48 | See Also | 48 | See Also |
49 | -------- | 49 | -------- |
50 | 50 | ||
51 | **sway**(5) | 51 | **sway**(5) **sway-bar**(5) |
diff --git a/sway/sway.5.txt b/sway/sway.5.txt index 5c1cf44d..4e73cd45 100644 --- a/sway/sway.5.txt +++ b/sway/sway.5.txt | |||
@@ -242,4 +242,4 @@ Currently supported attributes: | |||
242 | See Also | 242 | See Also |
243 | -------- | 243 | -------- |
244 | 244 | ||
245 | **sway**(1) **sway-input**(5) | 245 | **sway**(1) **sway-input**(5) **sway-bar**(5) |