philippelh/bitchx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial import of the ircii-pana-1.1-final source tree.

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0
This commit is contained in:
Kevin Easton
2008-02-25 09:25:32 +00:00
commit 28febcfea9
1429 changed files with 250653 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
bitchx-docs/2_Queries/2_Queries Normal file
View File

@@ -0,0 +1,11 @@
Section 2: Server Queries 
This section addresses the other half of EPIC's must-know commands, server
queries. These are commands that, in one way or another, ask an irc server
for some information. This might entail a listing of current channels, a
list of people on your current channel, or some detailed information about
a particular user.
These commands aren't quite as important as those in Section 1, but you
should make yourself familiar with them.

22
bitchx-docs/2_Queries/admin Normal file
View File

@@ -0,0 +1,22 @@
Synopsis:
admin [<server|nickname>]
Description:
This command is used to display various administrative information
about a particular server. Typically such information will include
the name of the organization running the server, its geographic
location, and a method of contacting someone in charge of it.
If the server name is omitted, the client's current server is used.
If a nickname is given, that client's server is queried.
Examples:
To get the administrative information of JoeBob's server:
/admin joebob
To get the administrative information of server irc.foobar.com:
/admin irc.foobar.com
See Also:
motd(2)

20
bitchx-docs/2_Queries/flush Normal file
View File

@@ -0,0 +1,20 @@
Synopsis:
flush
Description:
This discards any data pending in the client's hold buffer when HOLD_MODE
is on (and HOLD_MODE is then turned off). This includes server messages,
and messages generated internally by the client (such as by NOTIFY). The
client then discards all server messages received, until one full second
passes without receiving anything from the server. It is most useful for
flushing server output from commands that generate a lengthy reply, such
as LINKS or LIST or WHO.
See Also:
set(4) hold_mode
Other Notes:
FLUSH is a blocking command (meaning the client can't do anything until
the command is done), so it may cause the client to ping timeout from
your server. It does not actually tell the server to stop sending data.

14
bitchx-docs/2_Queries/info Normal file
View File

@@ -0,0 +1,14 @@
Synopsis:
info [<server>]
Description:
This command doesn't serve much interactive purpose. Rather, it shows
some information about the creators of and contributors to irc, both
to the ircII client and the ircd server, as well as irc in general.
It first shows information about the client, then it queries the
server for similar information.
A server may be queried, though it doesn't make too much sense, since
most servers on any given network will be running the same (or close)
server software, so the response would be the same.

19
bitchx-docs/2_Queries/ison Normal file
View File

@@ -0,0 +1,19 @@
Synopsis:
ison [<nick> [<nick> ...]]
Description:
This takes a list of nicknames, then returns the subset of that list
that are currently in use on the network. If none are online, an
empty list is returned. This is the mechanism used by NOTIFY. If
no nickname is specified, the user's nickname is used (and is thus
returned).
See Also:
notify
Other Notes:
The 303 numeric is used to return ISON queries. This numeric is used
by NOTIFY to determine who has signed on or off. Caution should be
exercised when hooking this numeric, as it could very well hamper or
disable the client's internal NOTIFY system.

34
bitchx-docs/2_Queries/links Normal file
View File

@@ -0,0 +1,34 @@
Synopsis:
links [[<server>] <glob>]
Description:
LINKS is used to display the servers currently connected to the irc
network. More precisely, it returns a list of the name each server
calls itself. For example, a Finnish server might present itself as
*.fi instead of its full server name (for a variety of reasons which
aren't really important here).
If a server name is omitted, the client's current server is used.
If a glob pattern is omitted, all servers are listed.
Examples:
To list all servers in Australia:
/links *.au
To query all hostmasked Australian servers for a server with a machine
name of "foobar":
/links *.au foobar.*
See Also:
load(5) tls
Other Notes:
Servers using "dog3/super" patched code may disallow use of the LINKS
command from time to time. Such servers have a "high traffic mode",
in which certain commands are disabled to conserve server resources.
A 263 numeric will be returned if LINKS is unavailable.
Some servers are now disallowing LINKS entirely, or limiting its use
to irc operators (sometimes local operators only), as it is easily
abused by "link lookers" and the like.

69
bitchx-docs/2_Queries/list Normal file
View File

@@ -0,0 +1,69 @@
Synopsis:
list [<switch> [<arg>] [<switch> [<arg>] ...]] [<channel>]
Description:
This is used to list the channels that currently exist (i.e. that have
one or more client on them) on the network. The output will include
the channel name (usually; see below), the number of users on that
channel, and the channel's current topic.
If an exact channel name is given, only information about that channel
is returned. If a '*' is used as the channel name, the current
channel is used. Otherwise, the client will request the entire list
of channels.
The client can search for specific channels or channels with certain
characteristics. If a glob pattern is given for the channel name, all
channels matching that pattern are shown. The list can be limited to
channels with only a certain number of users, those with a topic set,
or those that are private or public. Multiple switches may be used at
once.
LIST output is affected by channel modes. If a channel has mode +p,
then its name will be masked in the list output. However, it can
still be displayed normally if the exact channel name is known. If
the channel has mode +s, then it will not appear in any LIST output,
whether the exact name is known or not. These limitations only apply
to users not on the channels in question (i.e. a user on a +s channel
can list that channel normally).
Options:
-min <n> shows channels with no less than n users
-max <n> shows channels with no more than n users
-public shows public channels only
-private shows private channels only
-topic shows channels with a topic set
-all overrides any previous -public or -private switch
-wide shows name and size using as little space as possible:
-name sort list by channel name
-users sort list by number of users per channel
Examples:
To show channels with 3 to 15 users:
/list -min 3 -max 15
To show public channels with "help" in the name:
/list -public #*help*
To get a concise listing of channels with over 30 users, sorted by name:
/list -min 30 -wide -name
To see how Undernet's LIST works (and see below):
/quote list help
See Also:
on(5) list, widelist
Other Notes:
Unless a specific channel name is given, the client will request the
entire channel list and filter it locally. This is noteworthy because
large networks can easily have upwards of 2,000 channels at any given
moment. Parsing such a large list will greatly slow the client.
This can be circumvented on the Undernet, and networks that use recent
Undernet server code. The protocol LIST command (which is not the same
as the client's internal LIST command) on such servers has been
expanded to allow for server-side filtering. EPIC does not natively
support this protocol enhancement, so the command "/quote list" must be
used. Use "/quote list help" for the exact syntax.

24
bitchx-docs/2_Queries/lusers Normal file
View File

@@ -0,0 +1,24 @@
Synopsis:
lusers [<server mask> [<remote server>]]
Description:
LUSERS (shorthand for list users) returns some summary information
about who is currently using the network. It shows how many users
are currently online (broken up between visible and invisible users),
the number of channels formed, and the number of servers currently
connected to the network. Some servers may return other information
as well, such as the maximum number of clients that have connected
to it at one time, or the maximum number of users on the network at
once (from its perspective).
If a server mask is specified, the data returned will only apply to
servers matching that mask. If a remote server is specified as well,
that server is queried for the LUSERS information instead of the
client's current server.
Other Notes:
Servers using "dog3/super" patched code may disallow use of the LUSERS
command from time to time. Such servers have a "high traffic mode",
in which certain commands are disabled to conserve server resources.
A 263 numeric will be returned if LUSERS is unavailable.

17
bitchx-docs/2_Queries/map Normal file
View File

@@ -0,0 +1,17 @@
Synopsis:
map
Description:
This displays a semi-graphical map of the current network topology,
from the client's current server's perspective. The map is displayed
in a tree-like format.
See Also:
load(5) imap
Restrictions:
This command is only available on the Undernet and networks that use
Undernet server code, version 2.9 or later. A script that produces
similar output, called imap, is included with the client for users
not on the Undernet.

22
bitchx-docs/2_Queries/motd Normal file
View File

@@ -0,0 +1,22 @@
Synopsis:
motd [<server|nickname>]
Description:
This is used to display a server's Message of the Day. All servers by
default will send this message to the client when it first connects to
the server (though it is often not displayed by the client). These
messages typically tell a little about the server connected to, its
various policies, who to contact with questions or problems, etc.
If a server is specified, that server's motd is retrieved. If a user's
nickname is given, that user's server is queried. Otherwise the
default is the client's current server.
Other Notes:
Users are encouraged to read the Message of the Day of any server they
use. In some cases, the server administrator may need to inform all
users of something, and the MOTD is the most convenient way. In any
event, users should be aware of a server's policies if they use that
server, as they will be held accountable for their actions whether
they are aware of such policies or not.

20
bitchx-docs/2_Queries/n Normal file
View File

@@ -0,0 +1,20 @@
Synopsis:
n [<-all> [<channel>]
Description:
N returns a list of users on the specified channel or current channel.
The user list will include a + or @ prepended to those nicks that are +v
or +o in that channel, respectively.
Options:
-all shows all channels
Examples:
To show all users on the current channel:
/n
To show users on a non-current channel:
/n #ircii
See Also:
on(5) names sc

51
bitchx-docs/2_Queries/names Normal file
View File

@@ -0,0 +1,51 @@
Synopsis:
names [<switch> [<arg>] [<switch> [<arg>] ...]] [<channel>]
Description:
NAMES returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively.
If an exact channel name is given, only information about that channel
is returned. If a '*' is used as the channel name, the current
channel is used. Otherwise, the client will request a NAMES listing
for all known channels.
The client can search for specific channels or channels with certain
characteristics. If a glob pattern is given for the channel name, all
channels matching that pattern are shown. The list can be limited to
channels with only a certain number of users, or those that are private
or public. Multiple switches may be used at once.
NAMES output is affected by channel modes. If a channel has mode +p,
then its name will be masked in the output. However, it can still be
displayed normally if the exact channel name is known. If the channel
has mode +s, then it will not appear in any NAMES output, whether the
exact name is known or not. These limitations only apply to users not
on the channels in question (i.e. a user on a +s channel can use NAMES
for that channel normally).
Options:
-min <n> shows channels with no less than n users
-max <n> shows channels with no more than n users
-public shows public channels only
-private shows private channels only
-all overrides any previous -public or -private switch
Examples:
To show users on all channels with 3 to 15 users:
/names -min 3 -max 15
To show users on public channels with "help" in the name:
/names -public #*help*
See Also:
on(5) names
Other Notes:
Unless a specific channel name is given, the client will send a NAMES
request for all channels and filter the output locally. This is worth
noting because large networks can easily have upwards of 2,000 channels
at any given moment. Parse such a large list will greatly slow the
client.

20
bitchx-docs/2_Queries/sc Normal file
View File

@@ -0,0 +1,20 @@
Synopsis:
sc [<-all> [<channel>]
Description:
SC returns a list of users on the specified channel or current channel.
The user list will include a + or @ prepended to those nicks that are +v
or +o in that channel, respectively.
Options:
-all shows all channels
Examples:
To show all users on the current channel:
/sc
To show users on a non-current channel:
/sc #ircii
See Also:
on(5) names n

32
bitchx-docs/2_Queries/scan Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scan [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCAN returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scan v
To show users on all a channels with voice and a pattern:
/scan v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scanf Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scanf [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANF returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scanf v
To show users on all a channels with voice and a pattern:
/scanf v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scani Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scani [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANI returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scani v
To show users on all a channels with voice and a pattern:
/scani v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scann Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scann [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANN returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scann v
To show users on all a channels with voice and a pattern:
/scann v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scano Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scano [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANO returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scano v
To show users on all a channels with voice and a pattern:
/scano v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scans Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scans [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANS returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on all a channels with voice:
/scans v
To show users on all a channels with voice and a pattern:
/scans v *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

32
bitchx-docs/2_Queries/scanv Normal file
View File

@@ -0,0 +1,32 @@
Synopsis:
scanv [<-sort> <-host> <-nick> <s|v|o|n|i|f|s>] [<match>] [<channel>]
Description:
SCANV returns a list of users on the specified channel. The user list
will include a + or @ prepended to those nicks that are +v or +o in
that channel, respectively. The current channel is used if no channel is
specified. This scan is taken from the internal lists kept for each
channel, which means there is no lag.
Options:
-sort nicklist is not sorted and shown in the order the client has
-host nicklist is sorted by hostname
-nick nicklist is sorted by nickname
v voiced users
o opped users
n non-opped users
i ircops
f users on your userlist
s users that are on your shitlist
match nicks are matched against a pattern
Examples:
To show users on your shitlist with voice:
/scanv s
To show users on your shitlist with voice and a pattern:
/scanv s *ick*
See Also:
on(5) names sc n scani scanv scano scann scanf scans

45
bitchx-docs/2_Queries/stats Normal file
View File

@@ -0,0 +1,45 @@
Synopsis:
stats <type> [<server>]
Description:
This queries the server for specific statistical information. This
can include a list on specific people allowed to connect to the
server, those not allowed to connect, clients allowed to become
operators on that server, etc.
If a server is not specified, the current is queried. Note that the
STATS type is not preceded with a hyphen.
Options:
c C/N lines; these lines define what servers are allowed to link to
the network via the queried server
h H/L lines; these define what servers may connect as hubs or leaves
k K lines; these define who may not connect to the server
i I lines; these define who is allowed to connect to the server
l this shows a concise breakdown of the amount of data passed between
the server and its clients
m this shows how many times each protocol command has been used
o O lines; these define who may become an irc operator
u this shows the server's current uptime
y Y lines; these define the various client/server connection classes
Restrictions:
Some servers disallow or restrict the use of the STATS command. This
is generally due to abuse of some kind. Most often, the server will
not allow remote queries. This is not the case for most servers,
though.
See Also:
load(5) tls
Other Notes:
There are two types of O lines, global and local. If the STATS report
shows an O, it is global, and a o is local. Local operators only have
operator status and powers on their own server.
There are two types of I lines as well, though only on networks using
ircd2.9 code (not to be confused with Undernet's ircu2.9). An I is a
normal I line. An i is a restricted line, meaning any matching client
will be given user mode +r. This means that the client cannot change
its nickname or have operator status in any channel.

19
bitchx-docs/2_Queries/time Normal file
View File

@@ -0,0 +1,19 @@
Synopsis:
time [<server|nickname>]
Description:
This displays the time of day, local to the server queried (thus, the
time returned may not be the same as the client's local time). If the
server name is omitted, the client's current server is used. If a
nickname is given, that client's server is queried.
Examples:
To get the local time of JoeBob's server:
/time joebob
To get the local time of server irc.foobar.com:
/time irc.foobar.com
Aliases:
DATE is identical in operation to TIME.

22
bitchx-docs/2_Queries/trace Normal file
View File

@@ -0,0 +1,22 @@
Synopsis:
trace [<server>]
Description:
This works something like the Unix traceroute utility. It displays
the route from the client's current server to a remote one. It
additionally will display any irc operators currently on the remote
server, as well as any other servers connected to it.
If no server is specified, the connections (operator, server) to the
current server are displayed. This is a convenient method of finding
a local irc operator.
TRACE can also be used to determine where a network bottleneck is if
traffic to some users appears particularly slow. If the output stops
before completion, it can be assumed that the problem probably lies
with the last server that replied to the trace, or the next one
downstream.
See Also:
load(5) tls

57
bitchx-docs/2_Queries/userhost Normal file
View File

@@ -0,0 +1,57 @@
Synopsis:
userhost [<nickname> [<nickname> ...] [-cmd <command>]]
Description:
This queries the server for the address (user@hostname) of the given
nicknames. Any number of nicknames can be specified. If no nickname
is given, the user's is used (this is one way for users to verify
what address the irc server thinks they have).
USERHOST also allows its output to be used as the input for other
commands, using the -cmd flag. When using -cmd, at least one nickname
is required. The command can be anything, and multiple commands may
be used by surrounding them in curly braces.
Also, if all specified nicknames are on common channels with the client,
/userhost will get the address from an internal list, and never query the
server. You are still 100% guaranteed to get the right user@host, but
the AWAY and OPER flags won't always be accurate. If your script depends
on /userhost for the AWAY and OPER flags, you can use -direct to always
query the server.
USERHOST passes the following arguments to -cmd:
$0 - nickname
$1 - a '+' if the user is an irc operator, a '-' otherwise
$2 - a '+' if the user is marked as away, a '-' otherwise
$3 - username
$4 - hostname
Options:
-cmd take the output from /userhost as input to other commands
-direct force /userhost to query the server
Examples:
To get the userhosts of JoeBob and Jimbo:
/userhost joebob jimbo
To use their userhost output as another command's input in a script:
userhost joebob jimbo -cmd {
echo $0 is $3@$4
if ( [$1] == [+] ) echo $0 is an irc operator
if ( [$2] == [+] ) echo $1 is away
}
Aliases:
HOST is identical in operation to USERHOST.
See Also:
userip(2); Expressions(7)
Other Notes:
The server will only permit 5 nicknames at a time for this command.
When more than 5 are given, the client will split the command up and
issue separate queries as needed. However, most servers enable their
flood protection after receiving 5 of the same kind of command within
a short time period. This means that the user should expect a delay
in response if more than 25 nicknames are specified.

16
bitchx-docs/2_Queries/userip Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
userip [<nickname> [<nickname> ...] [-cmd <command>]]
Description:
This queries the server for the user@ip of the given nicknames. This
command is functionally identical to the userhost(2) command, except
it returns the user's ip address and not a hostname. Also note that this
command is Undernet-specific and is NOT supported by most IRC networks.
Options:
-cmd take the output from /userip as input to other commands
-direct force /userip to query the server
See Also:
userhost(2)

14
bitchx-docs/2_Queries/users Normal file
View File

@@ -0,0 +1,14 @@
Synopsis:
users [<server>]
Description:
This gives a listing of the users logged into the machine that the
specified irc server is running on. The output is similar to the
Unix finger or w commands. The users shown are not necessarily on
irc. If a server is not specified, the current is used.
Other Notes:
Use of this command is deprecated. It is almost universally disabled,
as is serves no useful purpose related to irc, and is considered by
some to be an invasion of privacy.

12
bitchx-docs/2_Queries/version Normal file
View File

@@ -0,0 +1,12 @@
Synopsis:
version [<server|nickname>]
Description:
This displays the version of the specified server. If a nickname is
given, that user's server version is returned. If neither a server
nor a nickname are given, VERSION prints the client's version string,
followed by the version of the current server.
See Also:
ctcp(1) version

82
bitchx-docs/2_Queries/who Normal file
View File

@@ -0,0 +1,82 @@
Synopsis:
who [<switch> [<arg>] [<switch> [<arg>] ...]] [<glob pattern>]
Description:
The WHO command is used to retrieve detailed information about every
user on irc. For each user, it returns a single line containing
their nickname, address (user@hostname), realname (IRCNAME), what
their current channel is (and whether they have +o or +v there),
whether they are marked away, and whether they are an irc operator.
The data returned can be filtered by the client in a number of ways.
It can be set to return only users who are marked away, people with a
certain username, or users on a specific server. For large queries,
the data can also be conveniently dumped to a file for later viewing.
The parameters to -end are as follows:
$0 name of server queried
$1 body of the query
Options:
-operators returns irc operators
-lusers returns non-irc operators
-chops returns channel operators
-nick <nickname> returns info for the given nickname only
-name <username> returns info for the given username only
-host <hostname> returns info for the given hostname only
-server <servername> returns info for the given servername only
-diagnose shows contents of the who queue for the server
of the current window
-flush removes all entries of the who queue for the server
of the current window
-here returns users who are not away
-away returns users who are away
-line {...} executes {...} for each line of output
-end {...} executes {...} at the end of the query
-file <filename> compare file contents to each line of output
-u-i show invisible users (opers only, required
on the undernet)
Examples:
To list all irc operators on servers from foo.com:
/who -o -s *.foo.com
To list the channel operators on channel #blah, which you are on:
/who -c #blah
To list all users from Russia, saving it to a file:
/who -h *.ru -f ru.users
To list all non-opers and say something at the end:
/who -lusers -end { echo sheesh. that's alot of lusers! }
See Also:
on(5) who; whois(2)
Restrictions:
There are some limitations to the data returned by WHO. For instance,
it will not show users who have user mode +i set, unless that user's
nickname is explicitly and unambiguously specified. Similarly, it
will mask channels with mode +p set, and will not show +s channels at
all. These limits do now apply, however, if the user in question is
on a like channel with the querying client, or if the client is on a
channel for which data is queried.
Other Notes:
The various command line switches detailed above may be abbreviated,
as shown in the examples, so line as the abbreviations are unambiguous.
For instance, -n may not be used, since it matches -nick and -name.
Use of the -file switch is not recommended, unless you know that the WHO
output will be minimal. This is because the client reads the entire file
specified for each line of output, which is obviously quite inefficient,
to say nothing of being rather abusing to your filesystem.
The arguments from -line are identical to the arguments to on(5) who.
In fact, -line works exactly like on(5) who. except it ALWAYS overrides
on(5) who and disappears when the query is done. The -end is similar in
that it overrides hooks to the 315 numeric.
The -flush switch should *never* be used while a WHO request is still
pending. The results are unpredictable. This is not a bug.

48
bitchx-docs/2_Queries/whois Normal file
View File

@@ -0,0 +1,48 @@
Synopsis:
whois [<server|nickname>] [<nickname>[,<nickname>[,...]]]
Description:
The WHOIS command is used to retrieve moderately detailed information
about the nickname(s) specified. This will always include the user's
nickname, address (user@hostname), real name (IRCNAME), and the server
that user is on. It may also show what channels the user is on (if
any, and if they aren't +p/+s) and whether the user is +o/+v in any of
those channels, whether the user is away, and if the user is an irc
operator.
WHOIS may be used on multiple nicknames at once, provided they are
delimited with commas. If a server name is specified, that server will
be queried instead of the client's current server. If no arguments are
given, the WHOIS will be performed on the client itself.
The command can also display the queried user's idle time (amount of
time since the client last did anything on the server). This is only
displayed if the user is on the same server as the client, or if the
user's server is queried. When querying for idle time, a single
nickname may be given in place of a server, in which case that user's
server will be queried.
Examples:
To get information on users JoeBob, ToeJam, and JuneBug:
/whois joebob,toejam,junebug
To get information on the same people from server irc.foo.com:
/whois irc.foo.com joebob,toejam,junebug
To get the idle time for user JoeBob:
/whois joebob joebob
See Also:
who(2); whowas(2)
Restrictions:
In WHOIS output, only channels that are not +p or +s are shown, unless
the client happens to be on one of those channels.
Other Notes:
In addition to idle time, some servers also return the time the user
signed on to irc.
If you query a remote server for WHOIS information, there is no reliable
way to "wait" for the data to come back (i.e. WAIT will be useless).

21
bitchx-docs/2_Queries/whowas Normal file
View File

@@ -0,0 +1,21 @@
Synopsis:
whowas [<nickname> [<count>]]
Description:
This command is similar to WHOIS, except it returns information about
nicknames that were recently in use. Like WHOIS, it shows the nickname,
address, real name, and server. It may also return multiple entries if
the nickname has been used recently by several people. These multiples
may be limited by specifying a count to show. A default for this
number may also be set with NUM_OF_WHOWAS.
WHOWAS will work regardless of whether the queried nick is in use. If
no arguments are given, the client's current nickname is used.
Examples:
To show the last 5 users of the nickname JoeBob:
/whowas joebob 5
See Also:
set(4) num_of_whowas; whois(2)

33
bitchx-docs/2_Queries/wi Normal file
View File

@@ -0,0 +1,33 @@
Synopsis:
wi [<nickname>[ <nickname>[ ...]]]
Description:
The WI command is used to retrieve detailed information about the
nickname(s) specified. This will always include the user's
nickname, address (user@hostname), real name (IRCNAME), and the server
that user is on. It may also show what channels the user is on (if
any, and if they aren't +p/+s) and whether the user is +o/+v in any of
those channels, whether the user is away, and if the user is an irc
operator. WI also displays the idle time of that nick.
If no arguments are given, the WI will be performed on the client
itself.
Examples:
To get information on users JoeBob, ToeJam, and JuneBug:
/wi joebob toejam junebug
See Also:
who(2); whowas(2) whois(2)
Restrictions:
In WI output, only channels that are not +p or +s are shown, unless
the client happens to be on one of those channels.
Other Notes:
In addition to idle time, some servers also return the time the user
signed on to irc.
If you query a remote server for WHOIS information, there is no reliable
way to "wait" for the data to come back (i.e. WAIT will be useless).

33
bitchx-docs/2_Queries/wii Normal file
View File

@@ -0,0 +1,33 @@
Synopsis:
wii [<nickname>[ <nickname>[ ...]]]
Description:
The WII command is used to retrieve detailed information about the
nickname(s) specified. This will always include the user's
nickname, address (user@hostname), real name (IRCNAME), and the server
that user is on. It may also show what channels the user is on (if
any, and if they aren't +p/+s) and whether the user is +o/+v in any of
those channels, whether the user is away, and if the user is an irc
operator. WII also displays the idle time of that nick.
If no arguments are given, the WII will be performed on the client
itself.
Examples:
To get information on users JoeBob, ToeJam, and JuneBug:
/wii joebob toejam junebug
See Also:
who(2); whowas(2) whois(2)
Restrictions:
In WII output, only channels that are not +p or +s are shown, unless
the client happens to be on one of those channels.
Other Notes:
In addition to idle time, some servers also return the time the user
signed on to irc.
If you query a remote server for WHOIS information, there is no reliable
way to "wait" for the data to come back (i.e. WAIT will be useless).

16
bitchx-docs/2_Queries/wilc Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
wilc
Description:
The WILC command is used to retrieve detailed information about the
nickname that last sent you a ctcp.
Examples:
To get information on user who last sent you a ctcp:
/wilc
See Also:
who(2); whowas(2) whois(2)
Restrictions:
If nobody has ctcped you, an error is produced.

16
bitchx-docs/2_Queries/wilcr Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
wilcr
Description:
The WILCR command is used to retrieve detailed information about the
nickname you last sent a ctcp to.
Examples:
To get information on user who last you sent a ctcp:
/wilc
See Also:
who(2); whowas(2) whois(2)
Restrictions:
If you haven't ctcped someone, an error is produced.

16
bitchx-docs/2_Queries/wilm Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
wilm
Description:
The WILM command is used to retrieve detailed information about the
nickname that last sent you a message.
Examples:
To get information on user who last sent you a message:
/wilm
See Also:
who(2); whowas(2) whois(2)
Restrictions:
If nobody has messaged you, an error is produced.

16
bitchx-docs/2_Queries/wiln Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
wiln
Description:
The WILN command is used to retrieve detailed information about the
nickname that last noticed you.
Examples:
To get information on user who last noticed you:
/wiln
See Also:
who(2); whowas(2) whois(2)
Restrictions:
If nobody has noticed you, an error is produced.

21
bitchx-docs/2_Queries/ww Normal file
View File

@@ -0,0 +1,21 @@
Synopsis:
ww [<nickname> [<count>]]
Description:
This command is similar to WHOIS, except it returns information about
nicknames that were recently in use. Like WHOIS, it shows the nickname,
address, real name, and server. It may also return multiple entries if
the nickname has been used recently by several people. These multiples
may be limited by specifying a count to show. A default for this
number may also be set with NUM_OF_WHOWAS.
WHOWAS will work regardless of whether the queried nick is in use. If
no arguments are given, the client's current nickname is used.
Examples:
To show the last 5 users of the nickname JoeBob:
/whowas joebob 5
See Also:
set(4) num_of_whowas; whois(2)