summaryrefslogtreecommitdiff
path: root/docs/help/in/cycle.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/cycle.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/cycle.in')
-rw-r--r--docs/help/in/cycle.in18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/help/in/cycle.in b/docs/help/in/cycle.in
index 3d1ed0c2..3cb28ee4 100644
--- a/docs/help/in/cycle.in
+++ b/docs/help/in/cycle.in
@@ -1,8 +1,22 @@
+Syntax:
+
@SYNTAX:cycle@
-Cycles (leaves and joins) the current channel or the specified
-channel.
+Parameters:
+
+ A channel and the message. If no argument is given, the active channel
+ will be used.
+
+Description:
+
+ Leaves and rejoins a channel.
+
+Examples:
+
+ /CYCLE
+ /CYCLE #irssi
+ /CYCLE #irssi BRB :)
See also: JOIN, PART