summaryrefslogtreecommitdiff
path: root/docs/help/in/clear.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 17:41:15 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 17:41:15 +0200
commit3f79c8553c8087a79b9c37216ac72eb3e03584d5 (patch)
tree304cac682c3f370812aa209fc7b113a29939328d /docs/help/in/clear.in
parentfd3676e40783e7a24ace7cb652dea72411737fdd (diff)
downloadirssi-3f79c8553c8087a79b9c37216ac72eb3e03584d5.zip
Syntax documentation rewrite for C-commands
Rewrote the syntax documentation for all the commands starting with the letter C.
Diffstat (limited to 'docs/help/in/clear.in')
-rw-r--r--docs/help/in/clear.in18
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/help/in/clear.in b/docs/help/in/clear.in
index b3db54ef..fb4172c8 100644
--- a/docs/help/in/clear.in
+++ b/docs/help/in/clear.in
@@ -1,9 +1,19 @@
+Syntax:
+
@SYNTAX:clear@
-This command clears the current window of all text. It is useful
-for wiping a screen that has rendered improperly (such as due
-to a bad termcap entry) or that contains sensitive information
-(such as one's OPER password).
+Parameters:
+
+ -all: Clear all the windows
+
+ The window number to clear; if no argument is given, the active window
+ is used.
+
+Description:
+
+ Clears the window of all text; you may use this to clear a windows that
+ contains sensitive information or has rendered improperly.
+See also: REDRAW