diff --git a/meson.build b/meson.build index 38590444d..6b0f6a158 100644 --- a/meson.build +++ b/meson.build @@ -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] diff --git a/sway/sway-bar.5.txt b/sway/sway-bar.5.scd similarity index 52% rename from sway/sway-bar.5.txt rename to sway/sway-bar.5.scd index 992389520..a61e28299 100644 --- a/sway/sway-bar.5.txt +++ b/sway/sway-bar.5.scd @@ -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* + 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** :: - 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** :: +*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** :: +*id* Sets the ID of the bar. -**position** :: +*position* top|bottom Sets position of the bar. Default is _bottom_. -**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* + 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** :: - Executes custom bar command, default is _swaybar_. +*swaybar\_command* + Executes custom bar command. Default is _swaybar_. -**font** :: +*font* Specifies the font to be used in the bar. -**separator_symbol** :: +*separator\_symbol* Specifies the separator symbol to separate blocks on the bar. -**wrap_scroll** :: +*wrap\_scroll* yes|no Enables or disables wrapping when scrolling through workspaces with the scroll wheel. Default is _no_. -**workspace_buttons** :: +*workspace\_buttons* yes|no Enables or disables workspace buttons on the bar. Default is _yes_. -**strip_workspace_numbers** :: +*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** :: +*binding\_mode\_indicator* yes|no Enable or disable binding mode indicator. Default is _yes_. -**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**