Various updates/enhancements/fixes to the help files.

git-svn-id: http://svn.irssi.org/repos/irssi/trunk@4545 dbcabf3a-b0e7-0310-adc4-f8d773084564

32 files changed, 78 insertions, 50 deletions

diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in
index 09501edf..b64da1c2 100644
--- a/docs/help/in/connect.in
+++ b/docs/help/in/connect.in
@@ -17,5 +17,5 @@
 This command makes irssi to connect to specified server.
 Current connections are kept and a new one is created.
 
-See also: SERVER, DISCONNECT, RMRECONNS
+See also: SERVER, DISCONNECT, RMRECONNS, SCONNECT
 
diff --git a/docs/help/in/ctcp.in b/docs/help/in/ctcp.in
index 77c78b7c..ce553649 100644
--- a/docs/help/in/ctcp.in
+++ b/docs/help/in/ctcp.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:ctcp@
 
-Sends a CTCP-message. For example CTCP ACTION, or CTCP VERSION.
+Sends a CTCP message. For example CTCP ACTION, or CTCP VERSION.
 
 See also: ME, ACTION
 
diff --git a/docs/help/in/die.in b/docs/help/in/die.in
index 4ef6da0d..c7daf2f6 100644
--- a/docs/help/in/die.in
+++ b/docs/help/in/die.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:die@
 
-IRC-operator command. Makes IRC-server to die.
+IRC operator command. Terminates the IRC server.
 
 See also: OPER
 
diff --git a/docs/help/in/info.in b/docs/help/in/info.in
index e9aad17d..864fe69e 100644
--- a/docs/help/in/info.in
+++ b/docs/help/in/info.in
@@ -1,6 +1,6 @@
 
 @SYNTAX:info@
 
-Shows information about the IRC creators, debuggers, slaves and 
-a lot of other people who no longer have much to do with irc.
+Shows information about the IRC server software and the current
+server instance.
 
diff --git a/docs/help/in/invitelist.in b/docs/help/in/invitelist.in
index ed6bc060..d544754b 100644
--- a/docs/help/in/invitelist.in
+++ b/docs/help/in/invitelist.in
@@ -2,7 +2,7 @@
 @SYNTAX:invitelist@
 
 Shows the +I modes of the current channel. +I mode
-allows free joins of clients with certain userhost mask
+allows free joins of clients with certain userhost masks
 even if the channel is invite only.
 
 See also: INVITE, MODE
diff --git a/docs/help/in/ison.in b/docs/help/in/ison.in
index b97ff5de..0287a60e 100644
--- a/docs/help/in/ison.in
+++ b/docs/help/in/ison.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:ison@
 
-Tells whether specified nicks are online.
+Tells whether specified nicks (space-separated) are online.
 
 See also: WHOIS, WHOWAS, NOTIFY
 
diff --git a/docs/help/in/kick.in b/docs/help/in/kick.in
index 304c4d31..fcbcc315 100644
--- a/docs/help/in/kick.in
+++ b/docs/help/in/kick.in
@@ -5,7 +5,7 @@ This command "kicks" the specified user off of the specified
 channel. It is typically used to remove troublemakers, flooders, 
 or people otherwise making a nuisanse of themselves on the channel. 
 The reason for the kick is recommended, but not required by the IRC 
-servers
+servers.
 
 If the <channel> is omitted, removes the nick from the current
 channel.
diff --git a/docs/help/in/knock.in b/docs/help/in/knock.in
index 947e3a8a..c7b23c56 100644
--- a/docs/help/in/knock.in
+++ b/docs/help/in/knock.in
@@ -8,9 +8,9 @@ KNOCK is a feature that lets you request access to a channel they cannot join wi
 The following conditions must be met for KNOCK to work:
 
  - You are not banned from the channel
- - Channel is not secret (+s) or private (+p)
+ - Channel is not private (+p)
  - You are not already on the channel
  - Channel is invite only (+i), has a key (+k) or limit is full
 
-When successful KNOCK issued, it sends a notice to channel operators. Use of KNOCK is rate limited by server.
+When successful KNOCK is issued, it sends a notice to channel operators. Use of KNOCK is rate limited by the server.
 
diff --git a/docs/help/in/links.in b/docs/help/in/links.in
index 726fcb6b..95ee07c5 100644
--- a/docs/help/in/links.in
+++ b/docs/help/in/links.in
@@ -5,5 +5,5 @@ Shows the links between the IRC servers of the
 current IRC network. If a wildcard parameter is
 specified, shows only the matching entries.
 
-See also:
+See also: MAP
 
diff --git a/docs/help/in/map.in b/docs/help/in/map.in
index 824dce37..7ddf696e 100644
--- a/docs/help/in/map.in
+++ b/docs/help/in/map.in
@@ -1,5 +1,7 @@
 
 @SYNTAX:map@
 
-Not available in IRC.
+Works only in some IRC networks and is often restricted to IRC operators.
+
+Shows a graphical map of the IRC network, often with user counts.
 
diff --git a/docs/help/in/motd.in b/docs/help/in/motd.in
index ba354408..8d66d04b 100644
--- a/docs/help/in/motd.in
+++ b/docs/help/in/motd.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:motd@
 
-Shows the motd of the current server. This contains
+Shows the motd of the current or specified server. This contains
 usually some useful info on the server, administrator and
 the rules.
 
diff --git a/docs/help/in/op.in b/docs/help/in/op.in
index ce46cb63..e34531b5 100644
--- a/docs/help/in/op.in
+++ b/docs/help/in/op.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:op@
 
-Gives the channel operator privileges for the specified
+Gives channel operator privileges to the specified
 nick(s). Wildcards in the nick are allowed.
 
 See also: DEOP, MODE, VOICE, DEVOICE, KICK
diff --git a/docs/help/in/ping.in b/docs/help/in/ping.in
index 3518b0c9..4a71147b 100644
--- a/docs/help/in/ping.in
+++ b/docs/help/in/ping.in
@@ -2,7 +2,7 @@
 @SYNTAX:ping@
 
 Sends CTCP PING to another IRC client. This is used
-to find out the speed of IRC network. When the PONG
+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.
 
diff --git a/docs/help/in/rehash.in b/docs/help/in/rehash.in
index 2fb55791..ab09c631 100644
--- a/docs/help/in/rehash.in
+++ b/docs/help/in/rehash.in
@@ -3,9 +3,12 @@
 
 IRC Operator command.
 
-This command is used to force the current server to reload it's
+This command is used to force the current server to reload its
 ircd.conf configuration file. This is useful for effecting
 configuration changes without starting a new server.
 
+Some servers have various types of rehashes, specified by an additional
+parameter.
+
 See also: OPER, RESTART
 
diff --git a/docs/help/in/reload.in b/docs/help/in/reload.in
index e7b2a5b6..f9e6f6e2 100644
--- a/docs/help/in/reload.in
+++ b/docs/help/in/reload.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:reload@
 
-Reloads the irssi's configuration file.
+Reloads irssi's configuration file.
 
 See also: SAVE
 
diff --git a/docs/help/in/restart.in b/docs/help/in/restart.in
index 14cd940f..c4090636 100644
--- a/docs/help/in/restart.in
+++ b/docs/help/in/restart.in
@@ -3,10 +3,10 @@
 
 IRC Operator command.
 
-This command is used to completely restart the server. A side effect of
-this is that the configuration file will be read again. However, it is
-generally more useful for clearing out internal buffers and other
-wasted memory.
+This command is used to completely restart the server, breaking all
+connections. A side effect of this is that the configuration file
+will be read again. However, it is generally more useful for upgrading
+the server software.
 
 See also: OPER, DIE
 
diff --git a/docs/help/in/rping.in b/docs/help/in/rping.in
index e0623173..7f3d72b8 100644
--- a/docs/help/in/rping.in
+++ b/docs/help/in/rping.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:rping@
 
-IRC Operator command.
+IRC Operator command, not available on all networks.
 
 This command works like the PING command (CTCP PING), except 
 it is used on a server instead of a client. As with PING, it 
diff --git a/docs/help/in/sconnect.in b/docs/help/in/sconnect.in
index 0f19d349..ed07f4f9 100644
--- a/docs/help/in/sconnect.in
+++ b/docs/help/in/sconnect.in
@@ -1,8 +1,8 @@
 
 @SYNTAX:sconnect@
 
-IRC Operator command. Makes an IRC server to connect
-to another server.
+IRC Operator command. Makes an IRC server connect
+to another server. This is CONNECT on the protocol level.
 
 See also: OPER, SQUIT, RESTART
 
diff --git a/docs/help/in/servlist.in b/docs/help/in/servlist.in
index cee9612d..e9b61a6d 100644
--- a/docs/help/in/servlist.in
+++ b/docs/help/in/servlist.in
@@ -1,6 +1,8 @@
 
 @SYNTAX:servlist@
 
+Works only on IRCnet.
+
 SERVLIST gives the list of services currently present on the
 IRC network.  It can take two arguments.
     <mask> limits the output to the services which names matches
diff --git a/docs/help/in/silence.in b/docs/help/in/silence.in
index 4e37d7b7..cf9c59e0 100644
--- a/docs/help/in/silence.in
+++ b/docs/help/in/silence.in
@@ -1,14 +1,16 @@
 
 @SYNTAX:silence@
 
-Works only in the Undernet and Open Projects (ircu).
+Works only in some IRC networks.
 
 SILENCE is similar in many respects to IGNORE, except that it is 
 server-based. What this means is the server will never even send 
-you messages from anyone you have SILENCEd, whereas it will with 
+you messages from anyone you have silenced, whereas it will with
 IGNORE, where your client is responsible for filtering the messages 
 out. This has the advantage of not bogging your client down with 
-excessive data as it tries to filter out messages. 
+excessive data as it tries to filter out messages. The silence list
+is lost when you disconnect. SILENCE only affects private messages
+and invites.
 
 The default behavior is to SILENCE a nick!user@host pattern, and 
 if such a pattern is not passed as the argument, it must be prepended 
diff --git a/docs/help/in/squery.in b/docs/help/in/squery.in
index 43d25178..9c29b956 100644
--- a/docs/help/in/squery.in
+++ b/docs/help/in/squery.in
@@ -4,6 +4,8 @@
    <service>   - Service name
    <commands>  - Commands to pass to the service.
 
+Works only on IRCnet.
+
 /SQUERY sends a query to the specified service.
 
 See also: SERVLIST, NOTE, LIST
diff --git a/docs/help/in/squit.in b/docs/help/in/squit.in
index 64b8616c..ab888781 100644
--- a/docs/help/in/squit.in
+++ b/docs/help/in/squit.in
@@ -1,7 +1,8 @@
 
 @SYNTAX:squit@
 
-IRC Operator command. Makes server to quit IRC network.
+IRC Operator command. Splits the given server and all servers
+behind it from your side of the IRC network.
 
-See also: OPER, DIE, RESTART
+See also: SCONNECT, OPER, DIE, RESTART
 
diff --git a/docs/help/in/stats.in b/docs/help/in/stats.in
index 3afc6ebd..5de453f5 100644
--- a/docs/help/in/stats.in
+++ b/docs/help/in/stats.in
@@ -1,7 +1,8 @@
 
 @SYNTAX:stats@
 
-Shows some irc server usage statistics.
+Shows some irc server usage statistics. Available types vary slightly
+per server; some common ones are:
   c - Shows C and N lines for a given server.  These are 
       the names of the servers that are allowed to connect.
   h - Shows H and L lines for a given server (Hubs and Leaves).
@@ -14,7 +15,9 @@ Shows some irc server usage statistics.
   m - Shows a count for the number of times the various 
       commands have been used since the server was booted.
   o - Shows the list of authorized operators on the server.
-  u - Shows the uptime for a server
+  p - Shows online operators and their idle times.
+  u - Shows the uptime for a server.
   y - Shows Y lines, which lists the various connection 
       classes for a given server.
+  ? - Shows information about servers connected to a server.
 
diff --git a/docs/help/in/trace.in b/docs/help/in/trace.in
index 27df384c..03aaeb55 100644
--- a/docs/help/in/trace.in
+++ b/docs/help/in/trace.in
@@ -1,8 +1,12 @@
 
 @SYNTAX:trace@
 
-Without a specified server it shows the current connections on
+Without a specified server TRACE shows the current connections on
 the local server.  If you specify a remote server it will show
 all servers between your current server and that remote server
-as well as the connections on that remote server.
+as well as the connections on that remote server. With a nick it
+shows the servers in between and information about that nick.
+
+On some servers, TRACE shows information such as IP addresses
+and idle times.
 
diff --git a/docs/help/in/unsilence.in b/docs/help/in/unsilence.in
index 110ff557..c46f77a7 100644
--- a/docs/help/in/unsilence.in
+++ b/docs/help/in/unsilence.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:unsilence@
 
-Works only in the Undernet and Open Projects (ircu).
+Works only in some IRC networks.
 
 Removes a pattern from your silence list.
 
diff --git a/docs/help/in/userhost.in b/docs/help/in/userhost.in
index a1039f9d..74550448 100644
--- a/docs/help/in/userhost.in
+++ b/docs/help/in/userhost.in
@@ -1,7 +1,7 @@
 
 @SYNTAX:userhost@
 
-Shows the userhost info of the specified nick.
+Shows the user@host, IRC operator (*) and away (-) status of the specified nick.
 
 See also: WHOIS
 
diff --git a/docs/help/in/wait.in b/docs/help/in/wait.in
index 4f5dc2f8..8b41ec73 100644
--- a/docs/help/in/wait.in
+++ b/docs/help/in/wait.in
@@ -5,6 +5,6 @@ Wait for <milliseconds> before sending the next command to server.
 
 This could be useful for example when identifying to NickServ; after
 sending the identify message you'd wait 3 seconds before joining to
-channels so NickServ has time to identify you to ChanServ which then
-auto-ops you when joining.
+channels so any host changes are processed and you can join
+registered-only channels.
 
diff --git a/docs/help/in/wall.in b/docs/help/in/wall.in
index 212c3a8c..afa73722 100644
--- a/docs/help/in/wall.in
+++ b/docs/help/in/wall.in
@@ -1,11 +1,12 @@
 
 @SYNTAX:wall@
 
-This command sends a message to all operators in a channel. This is internal
-irssi command which sends a message separately to each opearator, so this
-may not be very good idea to use in channel with lots of operators.
+This command sends a message to all operators in a channel. If the server
+supports WALLCHOPS or STATUSMSG=@, it sends a notice to @#channel.
+Otherwise it sends a notice separately to each operator, which may not
+be a very good idea to use in a channel with lots of operators.
 
-Some IRC servers support also /MSG @#channel or /WALLCHOPS which you should
+Many IRC servers support also /MSG @#channel or /WALLCHOPS which you should
 use if possible.
 
 See also: WALLCHOPS
diff --git a/docs/help/in/wallops.in b/docs/help/in/wallops.in
index 1690db2c..2c9c51a1 100644
--- a/docs/help/in/wallops.in
+++ b/docs/help/in/wallops.in
@@ -1,9 +1,9 @@
 
 @SYNTAX:wallops@
 
+IRC operator command.
+
 This command sends the given message to everyone on 
-the network who has user mode +w turned on. If you 
-are not an operator, you will probably receive
-an error message when using this command
+the network who has user mode +w turned on.
 
 See also: OPER, WALLOPS
diff --git a/docs/help/in/who.in b/docs/help/in/who.in
index 014231ee..4a52865d 100644
--- a/docs/help/in/who.in
+++ b/docs/help/in/who.in
@@ -3,15 +3,23 @@
 
 Without parameters, shows all users and their user infos
 on the current channel. If you specify a channel, shows
-the all users of the given channel.
+all users on the given channel.
 
 If you specify an string with wildcards, you will be
 shown all users whose nick, userhost or realname matches
 the wildcard expression.
 
-If a channel is secret or private and you're not on it,
-you will be shown only those channel members, who do not 
-have the invisible (+i) mode set.
+If a channel is secret and you're not on it, you will not
+get any output. Otherwise if you're not on it, you will be
+shown only those channel members who do not have the
+invisible (+i) mode set.
+
+The flags field has the following meaning:
+  H - The user is not away (here).
+  G - The user is set away (gone).
+  * - The user is an IRC operator.
+  @ - The user is a channel op in the channel listed.
+  + - The user is voiced in the channel listed.
 
 Examples:
    /WHO          - Shows users on current channel
diff --git a/docs/help/in/whois.in b/docs/help/in/whois.in
index 55f3e330..56ca30e4 100644
--- a/docs/help/in/whois.in
+++ b/docs/help/in/whois.in
@@ -9,7 +9,7 @@ the user. This is aliased to /WII by default.
 
 If given nick is not in the IRC, irssi automatically
 sends a WHOWAS query. Read carefully the reply to see
-if it is a WHOIS or WHOWAS reply. :)
+if it is a WHOIS or WHOWAS reply.
 
 See also: WHO, CHANNEL
 
diff --git a/src/irc/core/irc-commands.c b/src/irc/core/irc-commands.c
index e829eaa3..45fb0090 100644
--- a/src/irc/core/irc-commands.c
+++ b/src/irc/core/irc-commands.c
@@ -1029,7 +1029,7 @@ void irc_commands_init(void)
 	command_bind_irc("map", NULL, (SIGNAL_FUNC) command_self);
 	/* SYNTAX: MOTD [<server>|<nick>] */
 	command_bind_irc("motd", NULL, (SIGNAL_FUNC) command_self);
-	/* SYNTAX: REHASH */
+	/* SYNTAX: REHASH [<option>] */
 	command_bind_irc("rehash", NULL, (SIGNAL_FUNC) command_self);
 	/* SYNTAX: STATS <type> [<server>] */
 	command_bind_irc("stats", NULL, (SIGNAL_FUNC) command_self);