diff options
Diffstat (limited to 'sway/sway-bar.5.scd')
-rw-r--r-- | sway/sway-bar.5.scd | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/sway/sway-bar.5.scd b/sway/sway-bar.5.scd new file mode 100644 index 00000000..a61e2829 --- /dev/null +++ b/sway/sway-bar.5.scd | |||
@@ -0,0 +1,147 @@ | |||
1 | sway-bar(5) | ||
2 | |||
3 | # NAME | ||
4 | |||
5 | sway-bar - bar configuration file and commands | ||
6 | |||
7 | # DESCRIPTION | ||
8 | |||
9 | Sway allows configuring swaybar in the sway configuration file. Swaybar | ||
10 | commands must be used inside a _bar { }_ block in the config file. | ||
11 | |||
12 | # COMMANDS | ||
13 | |||
14 | *status\_command* <status command> | ||
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: | ||
18 | |||
19 | https://i3wm.org/docs/i3bar-protocol.html | ||
20 | |||
21 | *pango\_markup* enabled|disabled | ||
22 | Enables or disables pango markup for status lines. This has no effect on | ||
23 | status lines using the i3bar JSON protocol. | ||
24 | |||
25 | *id* <bar\_id> | ||
26 | Sets the ID of the bar. | ||
27 | |||
28 | *position* top|bottom | ||
29 | Sets position of the bar. Default is _bottom_. | ||
30 | |||
31 | *output* <output> | ||
32 | Restrict the bar to a certain output, can be specified multiple times. If | ||
33 | the output command is omitted, the bar will be displayed on all outputs. | ||
34 | |||
35 | *swaybar\_command* <command> | ||
36 | Executes custom bar command. Default is _swaybar_. | ||
37 | |||
38 | *font* <font> | ||
39 | Specifies the font to be used in the bar. | ||
40 | |||
41 | *separator\_symbol* <symbol> | ||
42 | Specifies the separator symbol to separate blocks on the bar. | ||
43 | |||
44 | *wrap\_scroll* yes|no | ||
45 | Enables or disables wrapping when scrolling through workspaces with the | ||
46 | scroll wheel. Default is _no_. | ||
47 | |||
48 | *workspace\_buttons* yes|no | ||
49 | Enables or disables workspace buttons on the bar. Default is _yes_. | ||
50 | |||
51 | *strip\_workspace\_numbers* yes|no | ||
52 | If set to _yes_, then workspace numbers will be omitted from the workspace | ||
53 | button and only the custom name will be shown. Default is _no_. | ||
54 | |||
55 | *binding\_mode\_indicator* yes|no | ||
56 | Enable or disable binding mode indicator. Default is _yes_. | ||
57 | |||
58 | *height* <height> | ||
59 | Sets the height of the bar. Default height will match the font size. | ||
60 | |||
61 | ## TRAY | ||
62 | |||
63 | Swaybar provides a system tray where third-party applications may place icons. | ||
64 | The following commands configure the tray. | ||
65 | |||
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> | ||
70 | Sets the button to be used for the _activate_ (primary click) tray item | ||
71 | event. The default is BTN\_LEFT (0x110). | ||
72 | |||
73 | *context\_button* <button> | ||
74 | Sets the button to be used for the _context menu_ (right click) tray item | ||
75 | event. The default is BTN\_RIGHT (0x111). | ||
76 | |||
77 | *secondary\_button* <button> | ||
78 | Sets the button to be used for the _secondary_ (middle click) tray item | ||
79 | event. The default is BTN\_MIDDLE (0x112). | ||
80 | |||
81 | *tray\_output* none|all|<output> | ||
82 | Sets the output that the tray will appear on or none. Unlike i3bar, swaybar | ||
83 | is able to show icons on any number of bars and outputs without races. | ||
84 | The default is _all_. | ||
85 | |||
86 | *tray\_padding* <px> [px] | ||
87 | Sets the pixel padding of the system tray. This padding will surround the | ||
88 | tray on all sides and between each item. The default value for _px_ is 2. | ||
89 | |||
90 | *icon\_theme* <name> | ||
91 | Sets the icon theme that sway will look for item icons in. This option has | ||
92 | no default value, because sway will always default to the fallback theme, | ||
93 | hicolor. | ||
94 | |||
95 | ## COLORS | ||
96 | |||
97 | Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors | ||
98 | must be defined in hex: _#RRGGBB_ or _#RRGGBBAA_. | ||
99 | |||
100 | *background* <color> | ||
101 | Background color of the bar. | ||
102 | |||
103 | *statusline* <color> | ||
104 | Text color to be used for the statusline. | ||
105 | |||
106 | *separator* <color> | ||
107 | Text color to be used for the separator. | ||
108 | |||
109 | *focused\_background* <color> | ||
110 | Background color of the bar on the currently focused monitor output. If not | ||
111 | used, the color will be taken from _background_. | ||
112 | |||
113 | *focused\_statusline* <color> | ||
114 | Text color to be used for the statusline on the currently focused monitor | ||
115 | output. If not used, the color will be taken from _statusline_. | ||
116 | |||
117 | *focused\_separator* <color> | ||
118 | Text color to be used for the separator on the currently focused monitor | ||
119 | output. If not used, the color will be taken from _separator_. | ||
120 | |||
121 | *focused\_workspace* <border> <background> <text> | ||
122 | Border, background and text color for a workspace button when the workspace | ||
123 | has focus. | ||
124 | |||
125 | *active\_workspace* <border> <background> <text> | ||
126 | Border, background and text color for a workspace button when the workspace | ||
127 | is active (visible) on some output, but the focus is on another one. You | ||
128 | can only tell this apart from the focused workspace when you are using | ||
129 | multiple monitors. | ||
130 | |||
131 | *inactive\_workspace* <border> <background> <text> | ||
132 | Border, background and text color for a workspace button when the workspace | ||
133 | does not have focus and is not active (visible) on any output. This will be | ||
134 | the case for most workspaces. | ||
135 | |||
136 | *urgent\_workspace* <border> <background> <text> | ||
137 | Border, background and text color for a workspace button when the workspace | ||
138 | contains a window with the urgency hint set. | ||
139 | |||
140 | *binding\_mode* <border> <background> <text> | ||
141 | Border, background and text color for the binding mode indicator. If not used, | ||
142 | the colors will be taken from _urgent\_workspace_. | ||
143 | |||
144 | # SEE ALSO | ||
145 | |||
146 | *sway*(5) | ||
147 | |||