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 | swaybar: when hiding bar, save old height to be restored upon reshow (diff) | |
download | sway-85dd36e92b2fb3d4b5fefa36927abf8f35f84c5c.tar.gz sway-85dd36e92b2fb3d4b5fefa36927abf8f35f84c5c.tar.zst sway-85dd36e92b2fb3d4b5fefa36927abf8f35f84c5c.zip |
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. | |||
65 | is given, when mouse button _n_ has been released). To disable the default | 65 | is given, when mouse button _n_ has been released). To disable the default |
66 | behavior for a button, use the command _nop_. | 66 | behavior for a button, use the command _nop_. |
67 | 67 | ||
68 | *mode* dock|hide|invisible | ||
69 | Specifies the visibility of the bar. In _dock_ mode, it is permanently | ||
70 | visible at one edge of the screen. In _hide_ mode, it is hidden unless the | ||
71 | modifier key is pressed, though this behaviour depends on the hidden state. | ||
72 | In _invisible_ mode, it is permanently hidden. Default is _dock_. | ||
73 | |||
74 | *hidden\_state* hide|show | ||
75 | Specifies the behaviour of the bar when it is in _hide_ mode. When the | ||
76 | hidden state is _hide_, then it is normally hidden, and only unhidden by | ||
77 | pressing the modifier key or in case of urgency hints. When the hidden | ||
78 | state is _show_, then it is permanently visible, drawn on top of the | ||
79 | currently visible workspace. Default is _hide_. | ||
80 | |||
81 | *modifier* <Modifier>|none | ||
82 | Specifies the modifier key that shows a hidden bar. Default is _Mod4_. | ||
83 | |||
68 | ## TRAY | 84 | ## TRAY |
69 | 85 | ||
70 | Swaybar provides a system tray where third-party applications may place icons. | 86 | 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 "\*". | |||
614 | *workspace\_layout* default|stacking|tabbed | 614 | *workspace\_layout* default|stacking|tabbed |
615 | Specifies the initial layout for new workspaces. | 615 | Specifies the initial layout for new workspaces. |
616 | 616 | ||
617 | # BAR CONTROL | ||
618 | |||
619 | *bar hidden\_state* hide|show|toggle [<bar\_id>] | ||
620 | Sets the hidden state of the bar (see *sway-bar*(5)), either individually, | ||
621 | by specifying a bar id, or if none is given, for all bar instances. | ||
622 | _toggle_ switches between _hide_ and _show_. | ||
623 | |||
624 | *bar mode* dock|hide|invisible|toggle [<bar\_id>] | ||
625 | Sets the mode of the bar (see *sway-bar*(5)), either individually, | ||
626 | by specifying a bar id, or if none is given, for all bar instances. | ||
627 | _toggle_ switches between _dock_ and _hide_. | ||
628 | |||
617 | # CRITERIA | 629 | # CRITERIA |
618 | 630 | ||
619 | A criteria is a string in the form of, for example: | 631 | A criteria is a string in the form of, for example: |