X-Git-Url: https://jfr.im/git/irc/rqf/shadowircd.git/blobdiff_plain/212380e3f42f585dc1ea927402252eb943f91f7b..b626b0171bf4db506d167f79063ba60fedfeb9cb:/doc/sgml/oper-guide/commands.sgml diff --git a/doc/sgml/oper-guide/commands.sgml b/doc/sgml/oper-guide/commands.sgml index 25726e2..4b615d1 100644 --- a/doc/sgml/oper-guide/commands.sgml +++ b/doc/sgml/oper-guide/commands.sgml @@ -4,7 +4,9 @@ Network management commands - Except STATS letters, all commands and names are case insensitive. + All commands and names are case insensitive. + Parameters consisting of one or more separate letters, + such as in MODE, STATS and WHO, are case sensitive. @@ -20,6 +22,10 @@ source is given, tell that server to initiate the connection attempt, otherwise it will be made from the server you are attached to. + + To use the default port with source, + specify 0 for port. + SQUIT @@ -42,8 +48,6 @@ DNS MOTD OMOTD - GLINES - PGLINES TKLINES TDLINES TXLINES @@ -83,18 +87,6 @@ Reload the operator MOTD file - - GLINES - - Clears G:lines. - - - - PGLINES - - Clears pending G:lines. - - TKLINES @@ -166,66 +158,144 @@ SET - LOG + ADMINSTRING + AUTOCONN + AUTOCONNALL + FLOODCOUNT + IDENTTIMEOUT MAX - SPLITDELAY - SMALLNET + OPERSTRING SPAMNUM SPAMTIME + SPLITMODE + SPLITNUM + SPLITUSERS value - The SET command sets a runtime-configurable value + The SET command sets a runtime-configurable value. + + Most of the ircd.conf equivalents have + a default_ prefix and are only read on startup. SET is the only + way to change these at run time. + + + Most of the values can be queried by omitting + value. + - LOG - - Logging level for ircd.log and syslog - + ADMINSTRING + + Sets string shown in WHOIS for admins. + (umodes +o and +a set, umode +S not set). + - - - MAX - - Set the maximum connections allowed (may not exceed the compiled-in value HARD_FDLIMIT) - + AUTOCONN + + Sets auto-connect on or off for a particular server. + Takes two parameters, server name and new state. + + To see these values, use /stats c. + Changes to this are lost on a rehash. + - DRONETIME - - Number of seconds in which DRONECOUNT messages must occur to trip the drone alarm - + AUTOCONNALL + + Globally sets auto-connect on or off. If disabled, no automatic + connections are done; if enabled, automatic connections are done + following the rules for them. + - DRONECOUNT - - Number of messages which constitutes a drone flood. 0 disables drone flood checking. - + FLOODCOUNT + + The number of lines allowed to be sent to a connection before + throttling it due to flooding. + Note that this variable is used for both + channels and clients. + + For channels, op or voice overrides this; for users, IRC + operator status or op or voice on a common channel overrides + this. + - SPLITDELAY - - Number of minutes after a connect burst begins until joining an empty channel will give you ops - + IDENTTIMEOUT + + Timeout for requesting ident from a client. + - SMALLNET - - Sets the number of servers which are needed to constitute attached to the network, as opposed to split - + MAX + + Sets the maximum number of connections + to value. + + This number cannot exceed maxconnections - MAX_BUFFER. + maxconnections is the rlimit for number of open files. + MAX_BUFFER is defined in config.h, normally 60. + + MAXCLIENTS is an alias for this. + + + + OPERSTRING + + Sets string shown in WHOIS for opers + (umode +o set, umodes +a and +S not set). + SPAMNUM - - Sets the number of JOINs/PARTs which constitutes a possible spambot - + + Sets how many join/parts to channels + constitutes a possible spambot. + SPAMTIME - - Staying on a channel for less than this length of time adds to the SPAMNUM count - + + Below this time on a channel + counts as a join/part as above. + + + + SPLITMODE + + Sets splitmode to value: + + + ON + splitmode is permanently on + + + OFF + splitmode is permanently off (default if no_create_on_split and no_join_on_split are disabled) + + + AUTO + ircd chooses splitmode based on SPLITUSERS and SPLITNUM (default if no_create_on_split or no_join_on_split are enabled) + + + + + + SPLITUSERS + + Sets the minimum amount of users needed to + deactivate automatic splitmode. + + + + SPLITNUM + + Sets the minimum amount of servers needed to + deactivate automatic splitmode. + Only servers that have finished bursting count for this. + @@ -412,17 +482,23 @@ DLINE length a.b.c.d + ON servername :reason Adds a D:line to dline.conf, which will deny any connections from the given IP address. + The IP address can be given as a full address (192.168.0.1) or + as a CIDR mask (192.168.0.0/24). If the optional parameter length is given, the D:line will be temporary (i.e. it will not be stored on disk) and last that long in minutes. + + All clients matching the D:line will be disconnected from the server immediately. + If a reason is specified, it will be sent to the client when they are disconnected, and, if dline_reason is enabled, @@ -433,10 +509,13 @@ connections. - D:lines cannot be set remotely on other servers. + If the ON part is specified, the D:line is set on servers matching + the given mask (provided a matching shared{} block exists there, + which is not the case by default). + Otherwise, the D:Line will be set on the local server only. - Only exempt{} blocks exempt from D:lines on initial connection. + Only exempt{} blocks exempt from D:lines. Being a server or having kline_exempt in auth{} does not exempt (different from K/G/X:lines). @@ -446,52 +525,13 @@ UNDLINE a.b.c.d + ON servername Will attempt to remove a D:line from dline.conf, and will flush a temporary D:line. - - GLINE - - GLINE - - user@host - user@a.b.c.d - - :reason - - - Attempts to add a network-wide ban for the given mask. - It takes three different opers on three different servers - requesting the same G:line to have it triggered for a configured - time. - - - Once triggered, a G:line is similar to a temporary K:line on - each server. No further propagation or on-disk storage is done. - - - This command can be enabled or disabled in the configuration file. - If it is disabled, no oper on the server can issue a G:line and no - G:lined user is banned, but G:lines are still propagated to other - servers which may have G:lines enabled. - - - - UNGLINE - - UNGLINE - - user@host - user@a.b.c.d - - - - Removes the given G:line on this server. - - TESTGECOS @@ -513,7 +553,7 @@ - Looks up the given hostmask or IP address and reports back on any auth{} blocks, D:, G:, or K: lines found. + Looks up the given hostmask or IP address and reports back on any auth{} blocks, D: or K: lines found. If nick is given, also searches for nick resvs. @@ -530,6 +570,10 @@ in use. As of charybdis 2.1.1, no_tilde and username truncation will be taken into account like in the normal client access check. + + As of charybdis 2.2.0, a channel name can be specified and the + RESV will be returned, if there is one. + TESTMASK @@ -671,6 +715,27 @@ no target is specified. + + PRIVS + + PRIVS + nick + + + Displays effective operator privileges for + the specified nick, or for yourself if no nick is + given. This includes all privileges from the operator + block, the name of the operator block and those + privileges from the auth block that have an effect + after the initial connection. + + + The exact output depends on the server the nick is on, + see the matching version of this document. + If the remote server does not support this extension, you will not + receive a reply. + + MASKTRACE @@ -889,18 +954,6 @@ Show file descriptors - - g - - Show pending glines - - - - G - - Show active glines - - h @@ -916,13 +969,13 @@ k - Show temporary K:lines, or matched temporary K:lines + Show temporary K:lines, or matched K:lines K - Show permanent K:lines, or matched permanent K:lines + Show permanent K:lines, or matched K:lines @@ -931,8 +984,9 @@ Show hostname and link information about the given nick. With a server name, show information about opers and servers - on that server; opers also get information about all local users - if they query their own server. + on that server; opers get information about all local + connections if they query their own server. + No hostname is shown for server connections. @@ -951,7 +1005,7 @@ n - Show blacklist blocks (DNS blacklists) with hit counts. + Show blacklist blocks (DNS blacklists) with hit counts since last rehash and (parenthesized) reference counts. The reference count shows how many clients are waiting on a lookup of this blacklist or have been found and are waiting on registration to complete. @@ -969,19 +1023,19 @@ P - Show listen blocks + Show listen blocks (ports) q - Show temporarily resv'ed nicks and channels + Show temporarily resv'ed nicks and channels with hit counts Q - Show permanently resv'ed nicks and channels + Show permanently resv'ed nicks and channels with hit counts since last rehash bans @@ -993,7 +1047,7 @@ t - Show generic server statistics + Show generic server statistics about local connections @@ -1017,13 +1071,13 @@ x - Show temporary X:lines + Show temporary X:lines with hit counts X - Show permanent X:lines + Show permanent X:lines with hit counts since last rehash bans @@ -1047,7 +1101,7 @@ ? - Show connected servers and sendq information about them + Show connected servers and link information about them