mirror of
https://github.com/swaywm/sway.git
synced 2024-11-10 12:33:50 +01:00
Add sway-bar(5)
This commit is contained in:
Drew DeVault
parent
432256ad84
commit
1813482266
@ -55,6 +55,7 @@ if scdoc.found()
|
||||
man_files = [
|
||||
'sway/sway.1.scd',
|
||||
'sway/sway.5.scd',
|
||||
'sway/sway-bar.5.scd',
|
||||
]
|
||||
foreach filename : man_files
|
||||
topic = filename.split('.')[-3].split('/')[-1]
|
||||
|
||||
@ -1,159 +1,147 @@
|
||||
/////
|
||||
vim:set ts=4 sw=4 tw=82 noet:
|
||||
/////
|
||||
sway-bar (5)
|
||||
============
|
||||
sway-bar(5)
|
||||
|
||||
# NAME
|
||||
|
||||
Name
|
||||
----
|
||||
sway-bar - bar configuration file and commands
|
||||
|
||||
Description
|
||||
-----------
|
||||
# DESCRIPTION
|
||||
|
||||
Sway allows configuring swaybar in the sway configuration file.
|
||||
Swaybar commands must be used inside a _bar { }_ block in the config file.
|
||||
Sway allows configuring swaybar in the sway configuration file. Swaybar
|
||||
commands must be used inside a _bar { }_ block in the config file.
|
||||
|
||||
# COMMANDS
|
||||
|
||||
Commands
|
||||
--------
|
||||
*status\_command* <status command>
|
||||
Executes the bar _status command_ with _sh -c_. Each line of text printed
|
||||
to stdout from this command will be displayed in the status area of the
|
||||
bar. You may also use the i3bar JSON protocol:
|
||||
|
||||
**status_command** <status command>::
|
||||
Executes the bar _status command_ with _sh -c_. Each line of text printed to
|
||||
stdout from this command will be displayed in the status area of the bar. You
|
||||
may also use the i3bar JSON protocol:
|
||||
+
|
||||
https://i3wm.org/docs/i3bar-protocol.html
|
||||
|
||||
**pango_markup** <enabled|disabled>::
|
||||
*pango\_markup* enabled|disabled
|
||||
Enables or disables pango markup for status lines. This has no effect on
|
||||
status lines using the i3bar JSON protocol.
|
||||
|
||||
**id** <bar_id>::
|
||||
*id* <bar\_id>
|
||||
Sets the ID of the bar.
|
||||
|
||||
**position** <top|bottom>::
|
||||
*position* top|bottom
|
||||
Sets position of the bar. Default is _bottom_.
|
||||
|
||||
**output** <output>::
|
||||
Restrict the bar to a certain output, can be specified multiple times. If the
|
||||
output command is omitted, the bar will be displayed on all outputs.
|
||||
*output* <output>
|
||||
Restrict the bar to a certain output, can be specified multiple times. If
|
||||
the output command is omitted, the bar will be displayed on all outputs.
|
||||
|
||||
**swaybar_command** <command>::
|
||||
Executes custom bar command, default is _swaybar_.
|
||||
*swaybar\_command* <command>
|
||||
Executes custom bar command. Default is _swaybar_.
|
||||
|
||||
**font** <font>::
|
||||
*font* <font>
|
||||
Specifies the font to be used in the bar.
|
||||
|
||||
**separator_symbol** <symbol>::
|
||||
*separator\_symbol* <symbol>
|
||||
Specifies the separator symbol to separate blocks on the bar.
|
||||
|
||||
**wrap_scroll** <yes|no>::
|
||||
*wrap\_scroll* yes|no
|
||||
Enables or disables wrapping when scrolling through workspaces with the
|
||||
scroll wheel. Default is _no_.
|
||||
|
||||
**workspace_buttons** <yes|no>::
|
||||
*workspace\_buttons* yes|no
|
||||
Enables or disables workspace buttons on the bar. Default is _yes_.
|
||||
|
||||
**strip_workspace_numbers** <yes|no>::
|
||||
*strip\_workspace\_numbers* yes|no
|
||||
If set to _yes_, then workspace numbers will be omitted from the workspace
|
||||
button and only the custom name will be shown. Default is _no_.
|
||||
|
||||
**binding_mode_indicator** <yes|no>::
|
||||
*binding\_mode\_indicator* yes|no
|
||||
Enable or disable binding mode indicator. Default is _yes_.
|
||||
|
||||
**height** <height>::
|
||||
*height* <height>
|
||||
Sets the height of the bar. Default height will match the font size.
|
||||
|
||||
Tray
|
||||
----
|
||||
## TRAY
|
||||
|
||||
Swaybar provides a system tray where programs such as NetworkManager, VLC,
|
||||
Pidgin, etc. can place little icons. The following commands configure
|
||||
interaction with the tray or individual icons.
|
||||
The _button_ argument in all following commands is a Linux input event code as
|
||||
defined in linux/input-event-codes.h. This is because wayland defines button
|
||||
codes in this manner.
|
||||
Swaybar provides a system tray where third-party applications may place icons.
|
||||
The following commands configure the tray.
|
||||
|
||||
**activate_button** <button>::
|
||||
The _button_ argument in all cases is a platform-specific button code. On Linux
|
||||
you can find a list of these at linux/input-event-codes.h.
|
||||
|
||||
*activate\_button* <button>
|
||||
Sets the button to be used for the _activate_ (primary click) tray item
|
||||
event. The default is BTN_LEFT (0x110).
|
||||
event. The default is BTN\_LEFT (0x110).
|
||||
|
||||
**context_button** <button>::
|
||||
*context\_button* <button>
|
||||
Sets the button to be used for the _context menu_ (right click) tray item
|
||||
event. The default is BTN_RIGHT (0x111).
|
||||
event. The default is BTN\_RIGHT (0x111).
|
||||
|
||||
**secondary_button** <button>::
|
||||
*secondary\_button* <button>
|
||||
Sets the button to be used for the _secondary_ (middle click) tray item
|
||||
event. The default is BTN_MIDDLE (0x112).
|
||||
event. The default is BTN\_MIDDLE (0x112).
|
||||
|
||||
**tray_output** none|all|<name>::
|
||||
*tray\_output* none|all|<output>
|
||||
Sets the output that the tray will appear on or none. Unlike i3bar, swaybar
|
||||
should be able to show icons on any number of bars and outputs without
|
||||
races. Because of this, the default value for this is _all_.
|
||||
is able to show icons on any number of bars and outputs without races.
|
||||
The default is _all_.
|
||||
|
||||
**tray_padding** <px> [px]::
|
||||
*tray\_padding* <px> [px]
|
||||
Sets the pixel padding of the system tray. This padding will surround the
|
||||
tray on all sides and between each item. The default value for _px_ is 2.
|
||||
|
||||
**icon_theme** <name>::
|
||||
*icon\_theme* <name>
|
||||
Sets the icon theme that sway will look for item icons in. This option has
|
||||
no default value, because sway will always default to the fallback theme,
|
||||
hicolor.
|
||||
|
||||
Colors
|
||||
------
|
||||
## COLORS
|
||||
|
||||
Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors
|
||||
must be defined in hex. i.e. _#rrggbb_ or _#rrggbbaa_ when including the alpha
|
||||
channel.
|
||||
must be defined in hex: _#RRGGBB_ or _#RRGGBBAA_.
|
||||
|
||||
**background** <color>::
|
||||
*background* <color>
|
||||
Background color of the bar.
|
||||
|
||||
**statusline** <color>::
|
||||
*statusline* <color>
|
||||
Text color to be used for the statusline.
|
||||
|
||||
**separator** <color>::
|
||||
*separator* <color>
|
||||
Text color to be used for the separator.
|
||||
|
||||
**focused_background** <color>::
|
||||
*focused\_background* <color>
|
||||
Background color of the bar on the currently focused monitor output. If not
|
||||
used, the color will be taken from _background_.
|
||||
|
||||
**focused_statusline** <color>::
|
||||
*focused\_statusline* <color>
|
||||
Text color to be used for the statusline on the currently focused monitor
|
||||
output. If not used, the color will be taken from _statusline_.
|
||||
|
||||
**focused_separator** <color>::
|
||||
*focused\_separator* <color>
|
||||
Text color to be used for the separator on the currently focused monitor
|
||||
output. If not used, the color will be taken from _separator_.
|
||||
|
||||
**focused_workspace** <border> <background> <text>::
|
||||
*focused\_workspace* <border> <background> <text>
|
||||
Border, background and text color for a workspace button when the workspace
|
||||
has focus.
|
||||
|
||||
**active_workspace** <border> <background> <text>::
|
||||
Border, background and text color for a workspace button when the workspace is
|
||||
active (visible) on some output, but the focus is on another one. You can only
|
||||
tell this apart from the focused workspace when you are using multiple
|
||||
monitors.
|
||||
*active\_workspace* <border> <background> <text>
|
||||
Border, background and text color for a workspace button when the workspace
|
||||
is active (visible) on some output, but the focus is on another one. You
|
||||
can only tell this apart from the focused workspace when you are using
|
||||
multiple monitors.
|
||||
|
||||
**inactive_workspace** <border> <background> <text>::
|
||||
*inactive\_workspace* <border> <background> <text>
|
||||
Border, background and text color for a workspace button when the workspace
|
||||
does not have focus and is not active (visible) on any output. This will be
|
||||
the case for most workspaces.
|
||||
|
||||
**urgent_workspace** <border> <background> <text>::
|
||||
*urgent\_workspace* <border> <background> <text>
|
||||
Border, background and text color for a workspace button when the workspace
|
||||
contains a window with the urgency hint set.
|
||||
|
||||
**binding_mode** <border> <background> <text>::
|
||||
*binding\_mode* <border> <background> <text>
|
||||
Border, background and text color for the binding mode indicator. If not used,
|
||||
the colors will be taken from _urgent_workspace_.
|
||||
the colors will be taken from _urgent\_workspace_.
|
||||
|
||||
# SEE ALSO
|
||||
|
||||
See Also
|
||||
--------
|
||||
*sway*(5)
|
||||
|
||||
**sway**(5)
|
||||
@ -576,3 +576,7 @@ The following attributes may be matched with:
|
||||
Compare against the workspace name for this view. Can be a regular
|
||||
expression. If the value is \_\_focused\_\_, then all the views on the
|
||||
currently focused workspace matches.
|
||||
|
||||
# SEE ALSO
|
||||
|
||||
*sway*(1) *sway-input*(5) *sway-bar*(5)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user