diff options
| author | Ian Fan <ianfan0@gmail.com> | 2018-10-13 21:44:08 +0100 |
|---|---|---|
| committer | Ian Fan <ianfan0@gmail.com> | 2018-10-14 13:33:12 +0100 |
| commit | 85dd36e92b2fb3d4b5fefa36927abf8f35f84c5c (patch) | |
| tree | c405121528d191ba74fe329fdb18093810d9b73c | |
| parent | 4dba7c084acb6ca1c9d220f8eac918c046c199ad (diff) | |
| download | sway-85dd36e92b2fb3d4b5fefa36927abf8f35f84c5c.tar.xz | |
swaybar: add documentation for hide/hidden_state subcommands
| -rw-r--r-- | sway/sway-bar.5.scd | 16 | ||||
| -rw-r--r-- | sway/sway.5.scd | 12 |
2 files changed, 28 insertions, 0 deletions
diff --git a/sway/sway-bar.5.scd b/sway/sway-bar.5.scd index 6729c9ac..873741c0 100644 --- a/sway/sway-bar.5.scd +++ b/sway/sway-bar.5.scd @@ -65,6 +65,22 @@ Sway allows configuring swaybar in the sway configuration file. is given, when mouse button _n_ has been released). To disable the default behavior for a button, use the command _nop_. +*mode* dock|hide|invisible + Specifies the visibility of the bar. In _dock_ mode, it is permanently + visible at one edge of the screen. In _hide_ mode, it is hidden unless the + modifier key is pressed, though this behaviour depends on the hidden state. + In _invisible_ mode, it is permanently hidden. Default is _dock_. + +*hidden\_state* hide|show + Specifies the behaviour of the bar when it is in _hide_ mode. When the + hidden state is _hide_, then it is normally hidden, and only unhidden by + pressing the modifier key or in case of urgency hints. When the hidden + state is _show_, then it is permanently visible, drawn on top of the + currently visible workspace. Default is _hide_. + +*modifier* <Modifier>|none + Specifies the modifier key that shows a hidden bar. Default is _Mod4_. + ## TRAY Swaybar provides a system tray where third-party applications may place icons. diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 2e1d13a8..67cc1cb1 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd @@ -614,6 +614,18 @@ match any output by using the output name "\*". *workspace\_layout* default|stacking|tabbed Specifies the initial layout for new workspaces. +# BAR CONTROL + +*bar hidden\_state* hide|show|toggle [<bar\_id>] + Sets the hidden state of the bar (see *sway-bar*(5)), either individually, + by specifying a bar id, or if none is given, for all bar instances. + _toggle_ switches between _hide_ and _show_. + +*bar mode* dock|hide|invisible|toggle [<bar\_id>] + Sets the mode of the bar (see *sway-bar*(5)), either individually, + by specifying a bar id, or if none is given, for all bar instances. + _toggle_ switches between _dock_ and _hide_. + # CRITERIA A criteria is a string in the form of, for example: |