X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2FCommands.txt;h=6bbd206874745a9af0251860567976c81c88c398;hb=adc8d4f6c89a11e08f5214e4ceb1323376a42ec5;hp=30947c150b7d00c7c5855c722269b15c9a914ac6;hpb=fef10f590b38371439c35b5e0a7f2e1a9a373a8a;p=ngircd-alex.git diff --git a/doc/Commands.txt b/doc/Commands.txt index 30947c15..6bbd2068 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -227,6 +227,9 @@ General Commands . If is omitted, the away status is removed. + References: + - RFC 2812, 4.1 "Away" + - HELP HELP [] . @@ -243,15 +246,46 @@ General Commands ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other implementations are using numerics 704, 705, and 706. - - MODE - MODE (user) - MODE [] + MODE [{+|-}[] [{+|-}[] [...]]] + MODE [{+|-}[] [ [ [...]]] [{+|-}[] [ [ [...]]] [...]]] + . + Set and get user and channel modes. + . + When no mode parameters are given, the currently set user or channel + modes are returned. Otherwise the modes are adjusted accordingly + and the changes will be reported back to the client. + . + All user and chnnel "modes" are indicated by single case-sensitive + characters. + . + Please note that a user can only get and set his own modes, and not + all user "levels" are allowed to change all channel modes ... + . + The mode parameters can become quite complex, especially when dealing + with channel modes that require additional arguments: . - The MODE command is dual-purpose. It can be used to set both (user) and - modes. + {+|-} -- set or unset one or more modes. + + - -- set some modes and unset others. + + -- set (at least) two modes with arguments. . - See doc/Modes.txt for more information. + Some examples: + . + MODE nick +i -- set user to "invisible". + MODE #chan +tn -- set "topic lock" and "no external messages". + MODE #chan -t +l 50 -- remove "topic lock", set "user limit" to 50. + MODE #chan +ov nick1 nick2 -- set "channel op" and "voice" mode + to nick1 and nick2 in channel #chan. + . + A complete list of all modes supported by ngIRCd can be found online + here: . + + References: + - RFC 2811, 4. "Channel Modes" + - RFC 2812, 3.1.5 "User mode message" + - RFC 2812, 3.2.3 "Channel mode message" + - + - doc/Modes.txt - NOTICE NOTICE [,[,...]] @@ -445,10 +479,19 @@ Status and Informational Commands - RFC 2812, 3.4.6 "Time message" - TRACE - TRACE [] + TRACE [] . - Trace a path across the IRC network of the current server, or if given - of a specific , in a similar method to traceroute. + Find the route to a specific server and send information about its + peers. Each server that processes this command reports back to the + sender about it: the replies from pass-through servers form a chain + which shows the route to the destination. + . + can be a server name, the nickname of a client connected to + a specific server, or a mask matching a server name in the network. + The server of the current connection is used when is omitted. + + References: + - RFC 2812, 3.4.8 "Trace message" - USERHOST USERHOST [ [...]] @@ -541,13 +584,19 @@ Channel Commands - RFC 2812, 3.2.7 "Invite message" - JOIN - JOIN [] + JOIN {[,[,...]] [[,[,...]]] | 0} . - Makes the client join the (comma-separated list), specifying - the passwords, if needed, in the comma-separated list. - A is only needed, if the mode "+k" is set. + Makes the client join the (comma-separated list), specifying + the channel keys ("passwords"). A is only needed if the + has the mode "+k" set. . If the channel(s) do not exist, then they will be created. + . + Using "JOIN 0" parts all channels at once. + + References: + - RFC 2812, 3.2.1 "Join message" (client protocol) + - RFC 2813, 4.2.1 "Join message" (server protocol) - KICK KICK [,[,...]] [,[,...]] [] @@ -564,62 +613,99 @@ Channel Commands - RFC 2812, 3.2.8 "Kick command" - LIST - LIST [ []] + LIST [[,[,...]] []] + . + List all visible (comma-seperated list). . - List all visible (comma-seperated list) on the current - server. If is given, the command will be forwarded to for evaluation. + References: + - RFC 2812, 3.2.6 "List message" + - PART - PART [] + PART [,[,...]] [] . - Leave (comma-separated list), optional with a - . + Leave (comma-separated list), optionally with sending a + to all the other channel members. + + References: + - RFC 2812, 3.2.2 "Part message" - TOPIC - TOPIC + TOPIC [] . - Set a for . + Cchange or view the topic of a channel. . - Only operators are able to set a . + The topic for channel is returned if there is no + given. If the parameter is present, the topic for that + channel will be changed, if this action is allowed for the user + requesting it. If the parameter is an empty string, the + topic for that channel will be removed. + + References: + - RFC 2812, 3.2.4 "Topic message" Administrative Commands ~~~~~~~~~~~~~~~~~~~~~~~ - CONNECT - CONNECT [ [ [ ]]] + CONNECT [ [ [ ]]] . - Instructs the current server, or if specified, - to connect to . + Instructs the current server, or if specified, + to connect to the server named , which must be configured + in the server configuration file. . - To connect you need to have remote oper status. - If is omitted, it uses the server port of the configuration. - If and is given, it uses those passwords instead - of the ones in the configuration. + To use this command, the user must be an IRC Operator. To establish + a connection on a , you must have remote IRC operator + privileges. + . + If , and are given, these values override + the ones specified in the server configuration file. + + References: + - RFC 2812, 3.4.7 "Connect message" - DIE DIE . Instructs the server to shut down. + . + To use this command, the user must be an IRC Operator. + + References: + - RFC 2812, 4.3 "Die message" - DISCONNECT - DISCONNECT [] + DISCONNECT + . + Disconnect and disable a locally linked server. . - Disconnects the current server, or if specified. - To disconnect a you need to have remote oper status. + To use this command, the user must be an IRC Operator. + + References: + - This command is not specified in the IRC RFCs, it is an extension + of ngIRCd. - GLINE - GLINE : + GLINE [ :] + . + This command provides timed G-Lines (network-wide bans). . - This command provides timed G-Lines (Network-wide bans). If a client matches a G-Line, it cannot connect to any server on - the IRC network. If you put 0 as , it makes the G-Line - permanent. + the IRC network for seconds. When is 0, it make + the G-Line permanent. + . + If no and no is given, the G-Line is removed. . - To remove a G-Line, type "GLINE ". - To list the G-Lines, type "STATS g". + To use this command, the user must be an IRC Operator. + . + "STATS g" can be used to list all currently active G-Lines. + + References: + - This command is not specified in the IRC RFCs, it is an extension + of ngIRCd. - KILL KILL @@ -629,40 +715,78 @@ Administrative Commands . This command is used internally between servers, too, for example to disconnect duplicate 's after a "net split". + . + To use this command, the user must be an IRC Operator. References: - RFC 2812, 3.7.1 "Kill message" - KLINE - KLINE : + KLINE [ :] . - This command provides timed K-Lines (Server-local bans). - If a client matches a K-Line, it cannot connect to the issued server. - If you put 0 as , it makes the K-Line permanent. + This command provides timed K-Lines (server-local bans). . - To remove a K-Line, type "KLINE ". - To list the K-Lines, type "STATS k". + If a client matches a K-Line, it cannot connect to this server for + seconds. When is 0, it makes the K-Line permanent. + . + If no and no is given, the K-Line is removed. + . + To use this command, the user must be an IRC Operator. + . + "STATS k" can be used to list all currently active K-Lines. + + References: + - This command is not specified in the IRC RFCs, it is an extension + of ngIRCd. - OPER - OPER + OPER + . + Authenticates a user named as an IRC operator on the current + server/network. . - Authenticates as an IRC operator on the current server/network. + This operator must be configured in the server configuration. + . + Please note that is NOT related to a nickname at all! + + References: + - RFC 2812, 3.1.4 "Oper message" - REHASH REHASH . Causes the server to re-read and re-process its configuration file(s). + . + While rehashing, no new connections are accepted, but all already + established connections stay connected. + . + To use this command, the user must be an IRC Operator. + + References: + - RFC 2812, 4.2 "Rehash message" - RESTART RESTART . Restart the server. + . + While restarting, all connections are reset and no new connections + are accepted. + . + To use this command, the user must be an IRC Operator. + + References: + - RFC 2812, 4.4 "Restart message" - WALLOPS WALLOPS . Sends to all users with user mode "+w". + . + To use this command, the user must be an IRC Operator. + References: + - RFC 2812, 4.7 "Operwall message" IRC Service Commands ~~~~~~~~~~~~~~~~~~~~