diff options
| author | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-10 20:43:52 +0200 |
|---|---|---|
| committer | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-10 20:43:52 +0200 |
| commit | d460ba48d1d4010f89bb3394ad089bf23c8c2a3a (patch) | |
| tree | 3d5e13b29c489d705d97aaa7a8371fd8fc5f35a1 /docs/help/in/ping.in | |
| parent | 938598e271a2ec94b38d5739e8a61b761c8aa8cc (diff) | |
| download | irssi-d460ba48d1d4010f89bb3394ad089bf23c8c2a3a.zip | |
Syntax documentation rewrite of O and P commands
Rewrote the syntax documentation of the commands starting with the
letters O and P.
Diffstat (limited to 'docs/help/in/ping.in')
| -rw-r--r-- | docs/help/in/ping.in | 22 |
1 files changed, 17 insertions, 5 deletions
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 |