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
This commit is contained in:
Mikkel Oscar Lyderik 2016-03-17 15:35:43 +01:00
parent 93109674d0
commit db7697b830
4 changed files with 115 additions and 2 deletions

View file

@ -57,3 +57,4 @@ install(
add_manpage(sway 1)
add_manpage(sway 5)
add_manpage(sway-input 5)
add_manpage(sway-bar 5)

112
sway/sway-bar.5.txt Normal file
View file

@ -0,0 +1,112 @@
/////
vim:set ts=4 sw=4 tw=82 noet:
/////
sway-bar (5)
============
Name
----
sway-bar - bar configuration file and commands
Description
-----------
Sway allows for configuration of swaybar within the sway configuation file.
Swaybar commands must be used inside a _bar { }_ block in the config.
Commands
--------
**status_command** <status command>::
Executes the bar _status command_ with _sh -c_.
**id** <bar_id>::
Sets the ID of the bar.
**position** <top|bottom|left|right>::
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.
**swaybar_command** <command>::
Executes custom bar command, default is _swaybar_.
**font** <font>::
Specifies the font to be used in the bar.
**separator_symbol** <symbol>::
Specifies the separator symbol to separate blocks on the bar.
**workspace_buttons** <yes|no>::
Enables or disables workspace buttons on the bar. Default is to enable
buttons.
**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.
**binding_mode_indicator** <yes|no>::
Enable or disable binding mode indicator. It's enabled by default.
**height** <height>::
Sets the height of the bar. Default height will match the font size.
Colors
------
Colors are defined within a _colors { }_ block inside a _bar { }_ block. Colors
must be defined in hex. E.g. _#fff000_ or _#fff000ff_ when including the alpha
channel.
**background** <color>::
Background color of the bar.
**statusline** <color>::
Text color to be used for the statusline.
**separator** <color>::
Text color to be used for the separator.
**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>::
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>::
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>::
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.
**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>::
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>::
Border, background and text color for the binding mode indicator. If not used,
the colors will be taken from _urgent_workspace_.
See Also
--------
**sway**(5) **sway-input**(5)

View file

@ -48,4 +48,4 @@ Commands
See Also
--------
**sway**(5)
**sway**(5) **sway-bar**(5)

View file

@ -242,4 +242,4 @@ Currently supported attributes:
See Also
--------
**sway**(1) **sway-input**(5)
**sway**(1) **sway-input**(5) **sway-bar**(5)