summaryrefslogtreecommitdiff
path: root/docs/conf
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2018-07-12 01:23:06 +0100
committerPeter Powell <petpow@saberuk.com>2018-07-12 01:31:24 +0100
commita37c11101acd5c8a4d32a5e3d8372baffc786836 (patch)
tree09b282197f6a14b52f69a3f400101dcd6359ca38 /docs/conf
parent11e67c494a9a1e7796c7b6ec0a60c88019181020 (diff)
Clean up the WHO helpop documentation.
Diffstat (limited to 'docs/conf')
-rw-r--r--docs/conf/helpop-full.conf.example64
1 files changed, 31 insertions, 33 deletions
diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example
index 72ec2a7d4..959f2249d 100644
--- a/docs/conf/helpop-full.conf.example
+++ b/docs/conf/helpop-full.conf.example
@@ -229,49 +229,47 @@ given in the command and either the channel is not +t, or
you are at least a halfoperator, the channel topic will be
changed to the new one you provide.">
-<helpop key="who" value="/WHO <search pattern> [ohurmaiMplf]
+<helpop key="who" value="/WHO <pattern> [afhilMmoprt]
Looks up the information of users matching the range you provide.
+
You may only /WHO nicknames in channels or on servers where you
share a common channel with them, or ones which are not +i (unless
-you are an IRC operator). The search-pattern may be a special
+you are a server operator). The search pattern may be a special
sequence of characters determined by the flags given below, or
-it may be one of a nickname, a channel, a hostmask, an ip address
+it may be one of a nickname, a channel, a hostmask, an IP address
mask or a server mask.
Valid WHO Flags
---------------
-The following flags after the mask have the following effects:
-
- o Show online IRC operators matching the mask
-
- a Show all users who have an away message matching the given mask
- i Show all users who have an ident (username) matching the given mask
- p Show all users who are connected on the given port number (IRC
- operators only)
- r Show all users whose realnames match the mask. When this
- flag is set it overrides the meaning of the search-pattern,
- which must contain a glob pattern intended to match GECOS
- (realname) fields.
- m Search for all users with a given set of user modes. When
- this flag is set it overrides the meaning of the
- search-pattern, which must contain the mode sequence to
- search for, for example to find all users with +i and
- without +s, issue the command WHO +i-s m (IRC operators only)
- t Show users connected within this number of seconds
- M Show all users who have metadata attached to them with
- the given key name (IRC operators only)
-
- f Show only remote (far) users
- l Show only local users
-
- h Show real hostnames rather than masked hostnames (IRC
- operators only)
- u Unlimit the results past the maximum /who results value
- (IRC operators only)
-
-You may combine multiple flags in one WHO command except where stated in the table above.">
+The following flags use <pattern> to match against the specified user data:
+
+ a Show users who have an away message matching <pattern>.
+ i Show users who have an ident (username) matching <pattern>.
+ M Show users who have metadata attached to them with a key name matching
+ <pattern> (server operators only).
+ m Show users who have the modes listed in <pattern>. The pattern
+ should be in the same format as a mode change e.g. +ow-i (server
+ operators only).
+ p Show users who are connected to a port in the <pattern> range (server
+ operators only).
+ r Show users who have a real name matching <pattern>.
+ t Show users who have connected in the last <pattern> seconds.
+
+The following flags filter users by their status:
+
+ f Only show users on remote (far) servers.
+ l Only show users on the local server.
+ o Only show server operators.
+
+The following flags modify the command output:
+
+ h Show real hostnames rather than display hostnames (server operators
+ only).
+
+You may combine one flag from the first group and multiple from the others in
+one WHO command.">
<helpop key="motd" value="/MOTD [<server>]