From 18134822666691a25050eff1a46df82a4108de3f Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Fri, 11 May 2018 21:13:43 -0400 Subject: Add sway-bar(5) --- meson.build | 1 + sway/sway-bar.5.scd | 147 ++++++++++++++++++++++++++++++++++++++++++++++++ sway/sway-bar.5.txt | 159 ---------------------------------------------------- sway/sway.5.scd | 4 ++ 4 files changed, 152 insertions(+), 159 deletions(-) create mode 100644 sway/sway-bar.5.scd delete mode 100644 sway/sway-bar.5.txt 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() 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.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 @@ +sway-bar(5) + +# NAME + +sway-bar - bar configuration file and commands + +# DESCRIPTION + +Sway allows configuring swaybar in the sway configuration file. Swaybar +commands must be used inside a _bar { }_ block in the config file. + +# 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: + + https://i3wm.org/docs/i3bar-protocol.html + +*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* + Sets the ID of the bar. + +*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. + +*swaybar\_command* + Executes custom bar command. Default is _swaybar_. + +*font* + Specifies the font to be used in the bar. + +*separator\_symbol* + Specifies the separator symbol to separate blocks on the bar. + +*wrap\_scroll* yes|no + Enables or disables wrapping when scrolling through workspaces with the + scroll wheel. Default is _no_. + +*workspace\_buttons* yes|no + Enables or disables workspace buttons on the bar. Default is _yes_. + +*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 + Enable or disable binding mode indicator. Default is _yes_. + +*height* + Sets the height of the bar. Default height will match the font size. + +## TRAY + +Swaybar provides a system tray where third-party applications may place icons. +The following commands configure the tray. + +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*