summaryrefslogtreecommitdiff
path: root/docs/help
diff options
context:
space:
mode:
authorRobert Bisewski <contact@ibiscybernetics.com>2017-10-05 22:47:15 -0500
committerRobert Bisewski <contact@ibiscybernetics.com>2017-10-05 22:47:15 -0500
commite1e632d31e1d8efc3370db76ddcc4bda200e4d31 (patch)
treecf0f60805d554e876767bcab04c8611b08f88420 /docs/help
parent32f33e7bb34598e8603b9f6a931ef063f6bd31f2 (diff)
downloadirssi-e1e632d31e1d8efc3370db76ddcc4bda200e4d31.zip
correcting and expanding content of statusbar help text
Diffstat (limited to 'docs/help')
-rw-r--r--docs/help/in/statusbar.in33
1 files changed, 21 insertions, 12 deletions
diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in
index ac475dd5..7fff7fb8 100644
--- a/docs/help/in/statusbar.in
+++ b/docs/help/in/statusbar.in
@@ -5,22 +5,31 @@
%9Parameters:%9
- ENABLE: Enables the statusbar.
- DISABLE: Disabled the statusbar.
+ ENABLE: Adds a statusbar to the list of statusbars.
+ DISABLE: Removes a statusbar from the list.
RESET: Restores the default statusbar configuration.
- TYPE: Identifies the type of statusbar.
- PLACEMENT: Identifies the placement of the statusbar.
- POSITION: Identifies the position of the statusbar.
- VISIBLE: Identifies the visibility of the statusbar.
- ADD: Adds a statusbar into the configuration.
- REMOVE: Removes a statusbar from the configuration.
-
- The name of the statusbar; if no argument is given, the list of statusbars
- will be displayed.
+ TYPE: Refers to the type of statusbar, for each split window
+ or only for the current root screen.
+ PLACEMENT: Refers to the placement of the statusbar, either at the
+ top or the bottom of the screen.
+ POSITION: Refers to the position of the statusbar. Represented as
+ an unsigned integer, with 0 implying the first position.
+ VISIBLE: Refers to the visibility of the statusbar or item. If set
+ to always it is visible on all screens, otherwise if set
+ to inactive or active then it is only visible on inactive
+ or active screens, respectively.
+ ADD: Adds an item to the specified statusbar. It can be set to
+ appear before/after another item and left/right aligned
+ to a specified position on the screen.
+ REMOVE: Removes an item from the specified statusbar.
+
+ Where name refers to the name of the statusbar; if no argument is
+ given, the entire list of statusbars will be displayed.
%9Description:%9
- Modified the attributes of the statusbar.
+ Allows adjustment of the attributes and items of a statusbar, as well
+ as where it is located and whether or not it is currently visible.
%9Examples:%9