Merge pull request #858 from ailin-nemui/sbar

change the statusbar commands so that no accidential status bars are created

1 files changed, 32 insertions, 19 deletions

diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in
index 7d64b816..9d68d1c9 100644
--- a/docs/help/in/statusbar.in
+++ b/docs/help/in/statusbar.in
@@ -5,27 +5,35 @@
 
 %9Parameters:%9
 
-    ENABLE:       Adds a statusbar to the list of statusbars.
-    DISABLE:      Removes a statusbar from the list. Note that for
-                  built-in statusbars they can be enabled again should the
-                  user wish to add back the default statusbars.
+    ADD:          Adds a statusbar to the list of statusbars.
+    MODIFY:       Modifies the configuration of a statusbar.
     RESET:        Restores the default statusbar configuration.
-    TYPE:         Sets the type of statusbar, for each split window or only
+    ADDITEM:      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.
+    MODIFYITEM:   Changes an item position inside a bar.
+    REMOVEITEM:   Removes an item from the specified statusbar.
+    INFO:         List the current details and items of the specified
+                  statusbar.
+
+    -disable:     Removes a statusbar from the list.
+    -type:        Sets the type of statusbar, for each split window or only
                   for the current root screen.
-    PLACEMENT:    Sets the placement of the statusbar, either at the top or
+    -placement:   Sets the placement of the statusbar, either at the top or
                   the bottom of the screen.
-    POSITION:     Sets the position of the statusbar. Represented as a
+    -position:    Sets the position of the statusbar. Represented as a
                   number, with 0 implying the first position.
-    VISIBLE:      Sets the visibility of the statusbar or item. If set to
+    -visible:     Sets 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.
+    -before:      This item is added before the other item.
+    -after:       This item is added after the other item.
+    -priority:    When the statusbar items overflow, the item with the
+                  lowest priority is removed first
+    -alignment:   Display the item on the right side.
 
-    Where name refers to the name of the statusbar; if no argument is
+    Where statusbar refers to the name of the statusbar; if no argument is
     given, the entire list of statusbars will be displayed.
 
 %9Description:%9
@@ -36,12 +44,17 @@
 %9Examples:%9
 
     /STATUSBAR
-    /STATUSBAR window
-    /STATUSBAR window REMOVE time
-    /STATUSBAR window ADD time
-    /STATUSBAR window RESET
-    /STATUSBAR topic DISABLE
-    /STATUSBAR topic ENABLE
+    /STATUSBAR INFO window
+    /STATUSBAR REMOVEITEM time window
+    /STATUSBAR ADDITEM time window
+    /STATUSBAR RESET window
+    /STATUSBAR MODIFY -disable topic
+    /STATUSBAR MODIFY -nodisable topic
+
+%9Remarks:%9
+
+    Statusbar syntax was changed in Irssi 1.2. The old syntax is still
+    accepted for backward compatibility, but no longer documented.
 
 %9See also:%9 WINDOW