summaryrefslogtreecommitdiff
path: root/docs/help/in/scrollback.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-30 14:29:06 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-30 14:29:06 +0200
commit822db3090f8c144833459cb7d3ed9e0422749f5e (patch)
tree5706ff105ad0cc04e8773b45a62478304d3fb6f5 /docs/help/in/scrollback.in
parent4beebe3238dda96efd4c3a0a6f6002ad5afc96e7 (diff)
downloadirssi-822db3090f8c144833459cb7d3ed9e0422749f5e.zip
Syntax rewrite for S-commands
Rewrote the syntax documentation for all commands starting with S.
Diffstat (limited to 'docs/help/in/scrollback.in')
-rw-r--r--docs/help/in/scrollback.in49
1 files changed, 33 insertions, 16 deletions
diff --git a/docs/help/in/scrollback.in b/docs/help/in/scrollback.in
index 4124cf6f..9f303491 100644
--- a/docs/help/in/scrollback.in
+++ b/docs/help/in/scrollback.in
@@ -1,20 +1,37 @@
+%9Syntax:%9
+
@SYNTAX:scrollback@
-/SCROLLBACK, or the default alias /SB:
-
-/SB LEVELCLEAR
- - Remove lines with level matching one of those
- specified in the comma-separated list <level>.
-/SB CLEAR
- - Clear screen, free all memory used by texts in window.
-/SB HOME
- - Jump to start of the buffer.
-/SB END
- - Jump to end of the buffer.
-/SB GOTO [[-|+]line#|time]
- - Jump to specified line or timestamp.
- time format is [dd[.mm] | -<days ago>] hh:mi[:ss].
-
-See also: SET SCROLL
+%9Parameters:%9
+
+ CLEAR: Clears the screen and the buffer of all text.
+ LEVELCLEAR: Clears the screen and the buffer of text matching the given
+ levels.
+ GOTO: Go to the given position.
+ HOME: Go to the start of the buffer.
+ END: Go to the end of the buffer.
+
+ -all: Applies to all windows instead of only the active one.
+ -level: The levels, separated by a comman, to match.
+
+ The line number, timestamp to jump to or the window reference number to
+ clear.
+
+%9Description:%9
+
+ Manipulate the text in the window to go to a to the given line number, or
+ clear the buffers.
+
+ The timestamp format is format is "[dd[.mm] | -<days ago>] hh:mi[:ss]".
+
+%9Examples:%9
+
+ /SCROLLBACK CLEAR
+ /SCROLLBACK LEVELCLEAR -level NOTICES
+ /SCROLLBACK GOTO 100
+ /SCROLLBACK HOME
+ /SCROLLBACK END
+
+%9See also:%9 CLEAR, WINDOW