summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-10 20:43:52 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-10 20:43:52 +0200
commitd460ba48d1d4010f89bb3394ad089bf23c8c2a3a (patch)
tree3d5e13b29c489d705d97aaa7a8371fd8fc5f35a1
parent938598e271a2ec94b38d5739e8a61b761c8aa8cc (diff)
downloadirssi-d460ba48d1d4010f89bb3394ad089bf23c8c2a3a.zip
Syntax documentation rewrite of O and P commands
Rewrote the syntax documentation of the commands starting with the letters O and P.
-rw-r--r--docs/help/in/op.in19
-rw-r--r--docs/help/in/oper.in21
-rw-r--r--docs/help/in/part.in18
-rw-r--r--docs/help/in/ping.in22
4 files changed, 64 insertions, 16 deletions
diff --git a/docs/help/in/op.in b/docs/help/in/op.in
index e34531b5..03abac32 100644
--- a/docs/help/in/op.in
+++ b/docs/help/in/op.in
@@ -1,8 +1,21 @@
+%9Syntax:%9
+
@SYNTAX:op@
-Gives channel operator privileges to the specified
-nick(s). Wildcards in the nick are allowed.
+%9Parameters:%9
+
+ The nicknames, separated by a comma, to grant channel operator status to.
+
+%9Description:%9
+
+ Grants the given nicknames the status of channel operator; you may use
+ wildcards in the nicknames.
+
+%9Examples:%9
+
+ /OP mike
+ /OP bob,sarah
-See also: DEOP, MODE, VOICE, DEVOICE, KICK
+%9See also:%9 DEOP, DEVOICE, KICK, MODE, VOICE
diff --git a/docs/help/in/oper.in b/docs/help/in/oper.in
index 90884bd9..b89a65cc 100644
--- a/docs/help/in/oper.in
+++ b/docs/help/in/oper.in
@@ -1,10 +1,21 @@
+%9Syntax:%9
+
@SYNTAX:oper@
-Gives you operator privileges if the correct nickname and
-password are given. If password is not given, you will be
-prompted for one. If no nickname is given, your current
-nickname will be used.
+%9Parameters:%9
+
+ The username and password to identify yourself as an IRC operator; if no
+ password is given, you will be prompted to enter one.
+
+%9Description:%9
+
+ Grants you the IRC operator status.
+
+%9Examples:%9
+
+ /OPER bob
+ /OPER mike WzerT8zq
-See also: KILL, DIE
+%9See also:%9 DIE, KILL
diff --git a/docs/help/in/part.in b/docs/help/in/part.in
index c18de681..e96abfbb 100644
--- a/docs/help/in/part.in
+++ b/docs/help/in/part.in
@@ -1,8 +1,20 @@
+%9Syntax:%9
+
@SYNTAX:part@
-Parts from the current or specified channel. Depending
-on your settings, closes the corresponding window, too.
+%9Parameters:%9
+
+ The channels, separated by a comma, to leave and the message to advertise.
+
+%9Description:%9
+
+ Leaves the given channels.
+
+%9Examples:%9
+
+ /PART #irssi
+ /PART #freenode,#irssi
-See also: JOIN
+%9See also:%9 JOIN, KICK
diff --git a/docs/help/in/ping.in b/docs/help/in/ping.in
index b4ebe57b..9190b23c 100644
--- a/docs/help/in/ping.in
+++ b/docs/help/in/ping.in
@@ -1,10 +1,22 @@
+%9Syntax:%9
+
@SYNTAX:ping@
-Sends CTCP PING to another IRC client or to an IRC channel.
-This is used to find out the speed of IRC network. When
-the PING reply comes in, irssi shows the interval time
-between sending the request and receiving the reply.
+%9Parameters:%9
+
+ The nickname or channel to ping, you can use the asterisk "*" character to
+ ping every user on a channel.
+
+%9Description:%9
+
+ Sends a CTCP PING request to a nickname or a channel; this is used to find
+ out the latency on the network.
+
+%9Examples:%9
+
+ /PING bob
+ /PING #irssi
-See also: CTCP
+%9See also:%9 CTCP, MSG