diff options
-rw-r--r-- | meson.build | 1 | ||||
-rw-r--r-- | sway/sway-bar.5.scd (renamed from sway/sway-bar.5.txt) | 140 | ||||
-rw-r--r-- | sway/sway.5.scd | 4 |
3 files changed, 69 insertions, 76 deletions
diff --git a/meson.build b/meson.build index 38590444..6b0f6a15 100644 --- a/meson.build +++ b/meson.build | |||
@@ -55,6 +55,7 @@ if scdoc.found() | |||
55 | man_files = [ | 55 | man_files = [ |
56 | 'sway/sway.1.scd', | 56 | 'sway/sway.1.scd', |
57 | 'sway/sway.5.scd', | 57 | 'sway/sway.5.scd', |
58 | 'sway/sway-bar.5.scd', | ||
58 | ] | 59 | ] |
59 | foreach filename : man_files | 60 | foreach filename : man_files |
60 | topic = filename.split('.')[-3].split('/')[-1] | 61 | topic = filename.split('.')[-3].split('/')[-1] |
diff --git a/sway/sway-bar.5.txt b/sway/sway-bar.5.scd index 99238952..a61e2829 100644 --- a/sway/sway-bar.5.txt +++ b/sway/sway-bar.5.scd | |||
@@ -1,159 +1,147 @@ | |||
1 | ///// | 1 | sway-bar(5) |
2 | vim:set ts=4 sw=4 tw=82 noet: | 2 | |
3 | ///// | 3 | # NAME |
4 | sway-bar (5) | 4 | |
5 | ============ | ||
6 | |||
7 | Name | ||
8 | ---- | ||
9 | sway-bar - bar configuration file and commands | 5 | sway-bar - bar configuration file and commands |
10 | 6 | ||
11 | Description | 7 | # DESCRIPTION |
12 | ----------- | ||
13 | 8 | ||
14 | Sway allows configuring swaybar in the sway configuration file. | 9 | Sway allows configuring swaybar in the sway configuration file. Swaybar |
15 | Swaybar commands must be used inside a _bar { }_ block in the config file. | 10 | commands must be used inside a _bar { }_ block in the config file. |
16 | 11 | ||
12 | # COMMANDS | ||
17 | 13 | ||
18 | Commands | 14 | *status\_command* <status command> |
19 | -------- | 15 | Executes the bar _status command_ with _sh -c_. Each line of text printed |
16 | to stdout from this command will be displayed in the status area of the | ||
17 | bar. You may also use the i3bar JSON protocol: | ||
20 | 18 | ||
21 | **status_command** <status command>:: | ||
22 | Executes the bar _status command_ with _sh -c_. Each line of text printed to | ||
23 | stdout from this command will be displayed in the status area of the bar. You | ||
24 | may also use the i3bar JSON protocol: | ||
25 | + | ||
26 | https://i3wm.org/docs/i3bar-protocol.html | 19 | https://i3wm.org/docs/i3bar-protocol.html |
27 | 20 | ||
28 | **pango_markup** <enabled|disabled>:: | 21 | *pango\_markup* enabled|disabled |
29 | Enables or disables pango markup for status lines. This has no effect on | 22 | Enables or disables pango markup for status lines. This has no effect on |
30 | status lines using the i3bar JSON protocol. | 23 | status lines using the i3bar JSON protocol. |
31 | 24 | ||
32 | **id** <bar_id>:: | 25 | *id* <bar\_id> |
33 | Sets the ID of the bar. | 26 | Sets the ID of the bar. |
34 | 27 | ||
35 | **position** <top|bottom>:: | 28 | *position* top|bottom |
36 | Sets position of the bar. Default is _bottom_. | 29 | Sets position of the bar. Default is _bottom_. |
37 | 30 | ||
38 | **output** <output>:: | 31 | *output* <output> |
39 | Restrict the bar to a certain output, can be specified multiple times. If the | 32 | Restrict the bar to a certain output, can be specified multiple times. If |
40 | output command is omitted, the bar will be displayed on all outputs. | 33 | the output command is omitted, the bar will be displayed on all outputs. |
41 | 34 | ||
42 | **swaybar_command** <command>:: | 35 | *swaybar\_command* <command> |
43 | Executes custom bar command, default is _swaybar_. | 36 | Executes custom bar command. Default is _swaybar_. |
44 | 37 | ||
45 | **font** <font>:: | 38 | *font* <font> |
46 | Specifies the font to be used in the bar. | 39 | Specifies the font to be used in the bar. |
47 | 40 | ||
48 | **separator_symbol** <symbol>:: | 41 | *separator\_symbol* <symbol> |
49 | Specifies the separator symbol to separate blocks on the bar. | 42 | Specifies the separator symbol to separate blocks on the bar. |
50 | 43 | ||
51 | **wrap_scroll** <yes|no>:: | 44 | *wrap\_scroll* yes|no |
52 | Enables or disables wrapping when scrolling through workspaces with the | 45 | Enables or disables wrapping when scrolling through workspaces with the |
53 | scroll wheel. Default is _no_. | 46 | scroll wheel. Default is _no_. |
54 | 47 | ||
55 | **workspace_buttons** <yes|no>:: | 48 | *workspace\_buttons* yes|no |
56 | Enables or disables workspace buttons on the bar. Default is _yes_. | 49 | Enables or disables workspace buttons on the bar. Default is _yes_. |
57 | 50 | ||
58 | **strip_workspace_numbers** <yes|no>:: | 51 | *strip\_workspace\_numbers* yes|no |
59 | If set to _yes_, then workspace numbers will be omitted from the workspace | 52 | If set to _yes_, then workspace numbers will be omitted from the workspace |
60 | button and only the custom name will be shown. Default is _no_. | 53 | button and only the custom name will be shown. Default is _no_. |
61 | 54 | ||
62 | **binding_mode_indicator** <yes|no>:: | 55 | *binding\_mode\_indicator* yes|no |
63 | Enable or disable binding mode indicator. Default is _yes_. | 56 | Enable or disable binding mode indicator. Default is _yes_. |
64 | 57 | ||
65 | **height** <height>:: | 58 | *height* <height> |
66 | Sets the height of the bar. Default height will match the font size. | 59 | Sets the height of the bar. Default height will match the font size. |
67 | 60 | ||
68 | Tray | 61 | ## TRAY |
69 | ---- | ||
70 | 62 | ||
71 | Swaybar provides a system tray where programs such as NetworkManager, VLC, | 63 | Swaybar provides a system tray where third-party applications may place icons. |
72 | Pidgin, etc. can place little icons. The following commands configure | 64 | The following commands configure the tray. |
73 | interaction with the tray or individual icons. | ||
74 | The _button_ argument in all following commands is a Linux input event code as | ||
75 | defined in linux/input-event-codes.h. This is because wayland defines button | ||
76 | codes in this manner. | ||
77 | 65 | ||
78 | **activate_button** <button>:: | 66 | The _button_ argument in all cases is a platform-specific button code. On Linux |
67 | you can find a list of these at linux/input-event-codes.h. | ||
68 | |||
69 | *activate\_button* <button> | ||
79 | Sets the button to be used for the _activate_ (primary click) tray item | 70 | Sets the button to be used for the _activate_ (primary click) tray item |
80 | event. The default is BTN_LEFT (0x110). | 71 | event. The default is BTN\_LEFT (0x110). |
81 | 72 | ||
82 | **context_button** <button>:: | 73 | *context\_button* <button> |
83 | Sets the button to be used for the _context menu_ (right click) tray item | 74 | Sets the button to be used for the _context menu_ (right click) tray item |
84 | event. The default is BTN_RIGHT (0x111). | 75 | event. The default is BTN\_RIGHT (0x111). |
85 | 76 | ||
86 | **secondary_button** <button>:: | 77 | *secondary\_button* <button> |
87 | Sets the button to be used for the _secondary_ (middle click) tray item | 78 | Sets the button to be used for the _secondary_ (middle click) tray item |
88 | event. The default is BTN_MIDDLE (0x112). | 79 | event. The default is BTN\_MIDDLE (0x112). |
89 | 80 | ||
90 | **tray_output** none|all|<name>:: | 81 | *tray\_output* none|all|<output> |
91 | Sets the output that the tray will appear on or none. Unlike i3bar, swaybar | 82 | Sets the output that the tray will appear on or none. Unlike i3bar, swaybar |
92 | should be able to show icons on any number of bars and outputs without | 83 | is able to show icons on any number of bars and outputs without races. |
93 | races. Because of this, the default value for this is _all_. | 84 | The default is _all_. |
94 | 85 | ||
95 | **tray_padding** <px> [px]:: | 86 | *tray\_padding* <px> [px] |
96 | Sets the pixel padding of the system tray. This padding will surround the | 87 | Sets the pixel padding of the system tray. This padding will surround the |
97 | tray on all sides and between each item. The default value for _px_ is 2. | 88 | tray on all sides and between each item. The default value for _px_ is 2. |
98 | 89 | ||
99 | **icon_theme** <name>:: | 90 | *icon\_theme* <name> |
100 | Sets the icon theme that sway will look for item icons in. This option has | 91 | Sets the icon theme that sway will look for item icons in. This option has |
101 | no default value, because sway will always default to the fallback theme, | 92 | no default value, because sway will always default to the fallback theme, |
102 | hicolor. | 93 | hicolor. |
103 | 94 | ||
104 | Colors | 95 | ## COLORS |
105 | ------ | ||
106 | 96 | ||
107 | Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors | 97 | Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors |
108 | must be defined in hex. i.e. _#rrggbb_ or _#rrggbbaa_ when including the alpha | 98 | must be defined in hex: _#RRGGBB_ or _#RRGGBBAA_. |
109 | channel. | ||
110 | 99 | ||
111 | **background** <color>:: | 100 | *background* <color> |
112 | Background color of the bar. | 101 | Background color of the bar. |
113 | 102 | ||
114 | **statusline** <color>:: | 103 | *statusline* <color> |
115 | Text color to be used for the statusline. | 104 | Text color to be used for the statusline. |
116 | 105 | ||
117 | **separator** <color>:: | 106 | *separator* <color> |
118 | Text color to be used for the separator. | 107 | Text color to be used for the separator. |
119 | 108 | ||
120 | **focused_background** <color>:: | 109 | *focused\_background* <color> |
121 | Background color of the bar on the currently focused monitor output. If not | 110 | Background color of the bar on the currently focused monitor output. If not |
122 | used, the color will be taken from _background_. | 111 | used, the color will be taken from _background_. |
123 | 112 | ||
124 | **focused_statusline** <color>:: | 113 | *focused\_statusline* <color> |
125 | Text color to be used for the statusline on the currently focused monitor | 114 | Text color to be used for the statusline on the currently focused monitor |
126 | output. If not used, the color will be taken from _statusline_. | 115 | output. If not used, the color will be taken from _statusline_. |
127 | 116 | ||
128 | **focused_separator** <color>:: | 117 | *focused\_separator* <color> |
129 | Text color to be used for the separator on the currently focused monitor | 118 | Text color to be used for the separator on the currently focused monitor |
130 | output. If not used, the color will be taken from _separator_. | 119 | output. If not used, the color will be taken from _separator_. |
131 | 120 | ||
132 | **focused_workspace** <border> <background> <text>:: | 121 | *focused\_workspace* <border> <background> <text> |
133 | Border, background and text color for a workspace button when the workspace | 122 | Border, background and text color for a workspace button when the workspace |
134 | has focus. | 123 | has focus. |
135 | 124 | ||
136 | **active_workspace** <border> <background> <text>:: | 125 | *active\_workspace* <border> <background> <text> |
137 | Border, background and text color for a workspace button when the workspace is | 126 | Border, background and text color for a workspace button when the workspace |
138 | active (visible) on some output, but the focus is on another one. You can only | 127 | is active (visible) on some output, but the focus is on another one. You |
139 | tell this apart from the focused workspace when you are using multiple | 128 | can only tell this apart from the focused workspace when you are using |
140 | monitors. | 129 | multiple monitors. |
141 | 130 | ||
142 | **inactive_workspace** <border> <background> <text>:: | 131 | *inactive\_workspace* <border> <background> <text> |
143 | Border, background and text color for a workspace button when the workspace | 132 | Border, background and text color for a workspace button when the workspace |
144 | does not have focus and is not active (visible) on any output. This will be | 133 | does not have focus and is not active (visible) on any output. This will be |
145 | the case for most workspaces. | 134 | the case for most workspaces. |
146 | 135 | ||
147 | **urgent_workspace** <border> <background> <text>:: | 136 | *urgent\_workspace* <border> <background> <text> |
148 | Border, background and text color for a workspace button when the workspace | 137 | Border, background and text color for a workspace button when the workspace |
149 | contains a window with the urgency hint set. | 138 | contains a window with the urgency hint set. |
150 | 139 | ||
151 | **binding_mode** <border> <background> <text>:: | 140 | *binding\_mode* <border> <background> <text> |
152 | Border, background and text color for the binding mode indicator. If not used, | 141 | Border, background and text color for the binding mode indicator. If not used, |
153 | the colors will be taken from _urgent_workspace_. | 142 | the colors will be taken from _urgent\_workspace_. |
154 | 143 | ||
144 | # SEE ALSO | ||
155 | 145 | ||
156 | See Also | 146 | *sway*(5) |
157 | -------- | ||
158 | 147 | ||
159 | **sway**(5) | ||
diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 75f1bf9d..f5ccc53a 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd | |||
@@ -576,3 +576,7 @@ The following attributes may be matched with: | |||
576 | Compare against the workspace name for this view. Can be a regular | 576 | Compare against the workspace name for this view. Can be a regular |
577 | expression. If the value is \_\_focused\_\_, then all the views on the | 577 | expression. If the value is \_\_focused\_\_, then all the views on the |
578 | currently focused workspace matches. | 578 | currently focused workspace matches. |
579 | |||
580 | # SEE ALSO | ||
581 | |||
582 | *sway*(1) *sway-input*(5) *sway-bar*(5) | ||