All pastes #886829 Raw Edit

Unnamed

public text v1 · immutable
#886829 ·published 2008-01-31 23:18 UTC
rendered paste body
/* UnrealIRCd3.2 Help Configuration
 * Based on the original help text written by hAtbLaDe
 * Revised by CC (07/2002)
 *
 * A worthwhile update for the /HELPOP system.
 * Included with Unreal3.2 Dist. on 8/24/02 (Beta12)
 */

help {
        " Server Commands Help.";
        " Specify your Question after the /HELPOP command.";
        " You will find all of the server commands and options";
        " available for use.";
        " If you need extra assistance please visit the server's";
        " help channel or ask an available IRCop.";
        " -";
        " /HELPOP USERCMDS - To get the list of User Commands";
        " /HELPOP OPERCMDS - To get the list of Oper Commands";
        " /HELPOP SVSCMDS  - Commands sent via U:Lined Server (Services)";
        " /HELPOP UMODES   - To get the list of User Modes";
        " /HELPOP SNOMASKS - To get a list of Snomasks";
        " /HELPOP CHMODES  - To get the list of Channel Modes";
        " /HELPOP OFLAGS   - To see the list of O:line Flags";
        " -";
        " ==-------------------------oOo--------------------------==";
};

/* note: indexes were generated by cat somecmds|sort|column -c 70
 *       along with tab->space conversion (tabwidth 8).
 *       Perhaps we should automate this step :). -- Syzop
 */

help Usercmds {
        " Currently the following User commands are available.";
        " Use /HELPOP <command name> to get more information about";
        " a specific command.";
        " -";
        " ==-------------------------oOo-------------------------==";
        " ADMIN           LICENSE         PART            USERHOST";
        " AWAY            LINKS           PING            USERIP";
        " CREDITS         LIST            PONG            VERSION";
        " CYCLE           LUSERS          PRIVMSG         VHOST";
        " DALINFO         MAP             QUIT            WATCH";
        " DCCALLOW        MODE            RULES           WHO";
        " INVITE          MODULE          SETNAME         WHOIS";
        " ISON            MOTD            SILENCE         WHOWAS";
        " JOIN            NAMES           STATS";
        " KICK            NICK            TIME";
        " KNOCK           NOTICE          TOPIC";
        " ==-------------------------oOo-------------------------==";
};

help Opercmds {
        " This section gives the IRC Operator only commands.";
        " Use /HELPOP <command name> to get more information about";
        " a specific command.";
        " -";
        " ==-------------------------oOo-------------------------==";
        " ADCHAT          GLOBOPS         OPERMOTD        SPAMFILTER";
        " CHATOPS         GZLINE          REHASH          SQUIT";
        " CHGHOST         HTM             RESTART         TEMPSHUN";
        " CHGIDENT        KILL            RPING           TRACE";
        " CHGNAME         KLINE           SAJOIN          TSCTL";
        " CLOSE           LAG             SAMODE          UNDCCDENY";
        " CONNECT         LOCOPS          SAPART          WALLOPS";
        " DCCDENY         MKPASSWD        SDESC           ZLINE";
        " DIE             MODULE          SETHOST";
        " DNS             NACHAT          SETIDENT";
        " GLINE           OPER            SHUN";
        " ==-------------------------oOo-------------------------==";
};

help Svscmds {
        " This section gives the commands that can be";
        " sent via a U:Lined Server such as Services.";
        " The command is typically sent as:";
        " /MSG OPERSERV RAW :services <command>";
        " Use /HELPOP <command name> to get more information about";
        " a specific command.";
        " -";
        " ==-------------------------oOo-------------------------==";

        " SQLINE          SVSKILL         SVSNLINE        SVSSNO";
        " SVS2MODE        SVSLUSERS       SVSNOOP         SVSWATCH";
        " SVS2SNO         SVSMODE         SVSO            SWHOIS";
        " SVSFLINE        SVSMOTD         SVSPART         UNSQLINE";
        " SVSJOIN         SVSNICK         SVSSILENCE";
        " ==-------------------------oOo-------------------------==";
};

help Umodes {
        " Here is a list of all the usermodes which are available for use.";
        " -";
        " ==---------------------------oOo---------------------------==";
        " o = Global IRC Operator";
        " O = Local IRC Operator";
        " a = Is a Services Administrator";
        " A = Is a Server Administrator";
        " N = Is a Network Administrator";
        " C = Is a Co Administrator";
        " -";
        " d = Makes it so you can not receive channel PRIVMSGs (Deaf)";
        " g = Can read & send to GlobOps, and LocOps";
        " h = Available for Help (Help Operator)";
        " i = Invisible (Not shown in /WHO searches)";
        " p = Hide all channels in /whois and /who";
        " q = Only U:lines can kick you (Services Admins/Net Admins only)";
        " r = Identifies the nick as being Registered (settable by services only)";
        " s = Can listen to Server notices";
        " t = Says that you are using a /VHOST";
        " v = Receive infected DCC send rejection notices";
        " w = Can listen to Wallop messages";
        " x = Gives the user Hidden Hostname (security)";
        " z = Marks the client as being on a Secure Connection (SSL)";
        " B = Marks you as being a Bot";
        " G = Filters out all Bad words in your messages with <censored>";
        " H = Hide IRCop status in /WHO and /WHOIS. (IRC Operators only)";
        " R = Allows you to only receive PRIVMSGs/NOTICEs from registered (+r) users";
        " S = For Services only. (Protects them)";
        " T = Prevents you from receiving CTCPs";
        " V = Marks the client as a WebTV user";
        " W = Lets you see when people do a /WHOIS on you (IRC Operators only)";
        " ==---------------------------oOo---------------------------==";
};

help Snomasks {
        " Snomask stands for 'Service NOtice MASK', it (mainly) controls which";
        " server notices you will receive.";
        " Usage: /MODE nick +s <snomask>";
        "    Ex: /MODE blah +s +cF-j";
        " The parameter specifies which snomasks you want (or don't want)."
        " You can also remove all snomasks by simply doing /MODE nick -s.";
        "-";
        " Below is a list of possible snomasks:";
        " ==-------------------------oOo-----------------------==";
        " c = View connects/disconnects on local server";
        " e = View 'Eyes' server messages (OperOverride, /CHG* and /SET* usage, ..)";
        " f = View flood alerts";
        " F = View connects/disconnects on remote servers (except U-lines)";
        " G = View TKL notices (Gline, GZline, Shun, etc)";
        " j = View Junk notices (not recommended for normal use)";
        " k = View KILL notices";
        " n = View nick changes on local server";
        " N = View nick changes on remote servers";
        " o = View oper-up notices";
        " q = View rejected nick changes due to Q:lines";
        " s = View general notices";
        " S = View spamfilter matches";
        " v = View usage of /VHOST command";
        " ==-------------------------oOo------------------------==";
};

help Chmodes {
        " This section lists all of the possible channel modes that may be used with /MODE";
        " -";
        " ==------------------------------oOo----------------------------==";
        " v <nickname> = Gives Voice to the user (May talk if chan is +m)";
        " h <nickname> = Gives HalfOp status to the user (Limited op access)";
        " o <nickname> = Gives Operator status to the user";
        " a <nickname> = Gives Channel Admin to the user";
        " q <nickname> = Gives Owner status to the user";
        " -";
        " b <nick!ident@host> = Bans the nick!ident@host from the channel";
        "       Extended bantypes (for more info see /HELPOP EXTBANS) [h]";
        " c = Block messages containing mIRC color codes [o]";
        " e <nick!ident@host> = Overrides a ban for matching users [h]";
        " I <nick!ident@host> = Overrides +i for matching users [h]";
        " f <floodparams> = Flood protection (for more info see /HELPOP CHMODEF) [o]";
        " i = A user must be invited to join the channel [h]";
        " j <joins:sec> = Throttle joins per-user to 'joins' per 'sec' seconds [o]";
        " k <key> = Users must specify <key> to join [h]";
        " l <number of max users> = Channel may hold at most <number> of users [o]";
        " m = Moderated channel (only +vhoaq users may speak) [h]";
        " n = Users outside the channel can not send PRIVMSGs to the channel [h]";
        " p = Private channel [o]";
        " r = The channel is registered (settable by services only)";
        " s = Secret channel [o]";
        " t = Only +hoaq may change the topic [h]";
        " z = Only Clients on a Secure Connection (SSL) can join [o]";
        " A = Server/Net Admin only channel (settable by Admins)";
        " C = No CTCPs allowed in the channel [o]";
        " G = Filters out all Bad words in messages with <censored> [o]";
        " M = Must be using a registered nick (+r), or have voice access to talk [o]";
        " K = /KNOCK is not allowed [o]";
        " L <chan2> = Channel link (If +l is full, the next user will auto-join <chan2>) [q]";
        " N = No Nickname changes are permitted in the channel [o]";
        " O = IRC Operator only channel (settable by IRCops)";
        " Q = No kicks allowed [o]";
        " R = Only registered (+r) users may join the channel [o]";
        " S = Strips mIRC color codes [o]";
        " T = No NOTICEs allowed in the channel [o]";
        " V = /INVITE is not allowed [o]";
        " u = Auditorium mode (/names and /who #channel only show channel ops) [q]";
        " -";
        " [h] requires at least halfop, [o] requires at least chanop, [q] requires owner";
        " ==------------------------------oOo----------------------------==";
};

help ExtBans {
        " Extended bantypes: ";
        " -";
        " ==-Type--------Name---------------------------Explanation-----------------------==";

        " ==-Type--------Name---------------------------Explanation-----------------------==";
        "         |               | People matching these bans can join but are unable to   ";
        "   ~q    |     Quiet     | speak, unless they have +v or higher.                   ";
        "         |               | Example:                                                ";
        "         |               | +bb ~q:*!*@blah.blah.com ~q:nick*!*@*                   ";
        "-----------------------------------------------------------------------------------";
        "         |               | People matching these bans cannot change nicks, unless  ";
        "    ~n   |  nickchange   | they have +v or higher.                                 ";
        "         |               | Example:                                                ";
        "         |               | +bb ~n:*!*@*.aol.com ~n:nick*!*@*                       ";
        "-----------------------------------------------------------------------------------";
        "         |               | If the user is in this channel then (s)he is unable to  ";
        "         |   [prefix]    | join. A prefix can also be specified (+/%/@/&/~) which  ";
        "    ~�   |    channel    | means that it will only match if the user has that    ";
        "         |               | rights or higher on the specified channel.              ";
        "         |               | Example:  +b ~c:#lamers,    +e ~c:@#trusted             ";
        "-----------------------------------------------------------------------------------";
        "         |               | If the realname of a user matches this then (s)he is    ";
        "         |               | unable to join.                                         ";
        "    ~r   |   realname    | Example: +b ~r:*Stupid_bot_script*                      ";
        "         |               | NOTE: an underscore ('_') matches both a space (' ') and";
        "         |               | an underscore ('_'), so this ban would                  ";
        "         |               | match 'Stupid bot script v1.4'.                         ";
        " ==------------------------------------------------------------------------------==";
};

help Chmodef {
        " The +f channel mode provides comprehensive flood protection for a channel.";
        " This mode allows you to prevent join, nick change, CTCP, text, and knock";
        " floods. The syntax for this mode's parameter is as follows:";
        " -";
        " +f [<amount><type>{#<action>}{,...}]:<seconds>";
        " -";
        " The amount specifies the number of times the specified flood must occur";
        " before action is taken. Below are the available types:";
        " -";
        " ==-----Type-----Name--------Default Action---Other Actions-----==";
        "        c        CTCP        +C               m, M";
        "        j        Join        +i               R";
        "        k        Knock       +K";
        "        m        Messages    +m               M";

        "        n        Nickchange  +N";
        "        t        Text        kick             b";
        " -";
        " The difference between type m and t is that m is tallied for the entire";
        " channel whereas t is tallied per user.";
        " -";
        " If you choose to specify an action for a mode, you may also specify a";
        " time (in minutes) after which the specific action will be reversed.";
};


help Oflags {
        " Here you will find the flags that can be placed inside of the O:Lines";
        " -";
        " ==-------------------------------oOo-----------------------------==";
        " o (locop)            Local Operator";
        " O (globop)           Global Operator";
        " C (coadmin)          Gets +C on oper up. Is Co Administrator";
        " A (admin)            Gets +A on oper up. Is Server Administrator";
        " a (services-admin)   Gets +a on oper up. Is Services Administrator";
        " N (netadmin)         Gets +N on oper up. Is Network Administrator";
        " -";
        " r (can_rehash)       Access to /REHASH server";
        " R (can_restart)      Access to /RESTART server";
        " D (can_die)          Access to /DIE server";
        " h (helpop)           Oper receives umode +h (helpop)";
        " g (can_globops)      Oper can send /GLOBOPS";
        " w (can_wallops)      Oper can send /WALLOPS";
        " n (can_localnotice)  Oper can send Local Server Notices";
        " G (can_globalnotice) Oper can send Global Server Notices";
        " c (can_localroute)   Access to do local /SQUITs and /CONNECTs";
        " L (can_globalroute)  Access to do global /SQUITs and /CONNECTs";
        " k (can_localkill)    Access to do local /KILLs";
        " K (can_globalkill)   Access to do global /KILLs";
        " b (can_kline)        Oper can /KLINE users from server";
        " B (can_unkline)      Oper can remove Klines";
        " z (can_zline)        Can add Z:Lines";
        " Z (can_gzline)       Can add global Z:Lines";
        " t (can_gkline)       Can use /GLINE, /SHUN and /SPAMFILTER";
        " v (can_override)     Can use OperOverride";
        " q (can_setq)         Can use +q";
        " H (get_host)         Gets +x on oper up";
        " W (get_umodew)       Gets +W on oper up";
        " X (can_addline)      Can use /ADDLINE";
        " d (can_dccdeny)      Can use /DCCDENY";
        " ==-------------------------------oOo-----------------------------==";
};


help Nick {
        " Changes your \"Online Identity\" on a server.";
        " All those in the channel you are in will be";
        " alerted of your nickname change.";
        " -";
        " Syntax:  NICK <new nickname>";
        " Example: NICK hAtbLaDe";
};

help Whois {
        " Shows information about the user in question,";
        " such as their \"Name\", channels they are";
        " currently in, their hostmask, etc.";
        " -";
        " Syntax:  WHOIS <user>";
        " Example: WHOIS hAtbLaDe";
        " -";
        " Status flags:";
        " The list of channels shown in the WHOIS reply can include one or more";
        " status flags to indicate information about the channel. These flags are";
        " described below:";
        " ~ - User is a Channel Owner (+q)";
        " & - User is a Channel Admin (+a)";
        " @ - User is a Channel Operator (+o)";
        " % - User is a Halfop (+h)";
        " + - User is Voiced (+v)";
        " ! - User has channels hidden in whois (+p) and you are an IRC Operator";
        " ? - The channel is secret (+s) and you are an IRC Operator";
};

help Who {

        " Retrieves information about users";
        " -";
        " Syntax:";
        " /WHO [+|-][acghimnsuMRI] [args]";
        " Flags are specified like channel modes, the flags cgmnsu all have arguments";
        " Flags are set to a positive check by +, a negative check by -";
        " The flags available:";
        " Flag a: user is away";
        " Flag c <channel>: user is on <channel>, no wildcards accepted";
        " Flag g <gcos/realname>: user has string <gcos> in his/her GCOS,";
        " wildcards accepted, oper only";
        " Flag h <host>: user has string <host> in his/her hostname, wildcards are accepted";
        " Flag i <ip>: user has string <ip> in his/her IP address";
        " Flag m <usermodes>: user has <usermodes> set, only o/C/A/a/N for nonopers";
        " Flag n <nick>: user has string <nick> in his/her nickname, wildcards accepted";
        " Flag s <server>: user is on server <server>, wildcards not accepted";
        " Flag u <user>: user has string <user> in his/her username, wildcards accepted";
        " Behavior flags:";
        " Flag M: check for user in channels I am a member of";
        " Flag R: show users' real hostnames";
        " Flag I: show users' IP addresses";
        " -";
        " For backwards compatibility, /who 0 o still shows +o users";
        " Example: WHO +m o";
        " -";
        " Status flags:";
        " The who command shows several flags in the returned result to indicate";
        " different information about the user. These flags are explained below:";
        " G - User is /away (gone)";
        " H - User is not /away (here)";
        " r - User is using a registered nickname";
        " B - User is a bot (+B)";
        " * - User is an IRC Operator";
        " ~ - User is a Channel Owner (+q)";
        " & - User is a Channel Admin (+a)";
        " @ - User is a Channel Operator (+o)";
        " % - User is a Halfop (+h)";
        " + - User is Voiced (+v)";
        " ! - User is +H and you are an IRC Operator";
        " ? - User is only visible because you are an IRC Operator";
};

help Whowas {
        " Retrieves previous WHOIS information for users";
        " no longer connected to the server.";
        " -";
        " Syntax:  WHOWAS <nickname>";
        "  WHOWAS <nickname> <max number of replies>";
        " Example: WHOWAS hAtbLaDe";
};

help Cycle {
        " Cycles the given channel(s). This command is equivilent";
        " to sending a PART then a JOIN command.";
        " -";
        " Syntax:  CYCLE <chan1>,<chan2>,<chan3>";
        " Example: CYCLE #help";
        " Example: CYCLE #main,#chat";
};

help Dns {
        " Returns information about the IRC server's DNS cache.";
        " Note, since most clients have a builtin DNS command,";
        " you will most likely need to use /raw DNS to use this.";
        " There are also 2 other variants:";
        " 'DNS l' will show you the DNS cache entries";
        " 'DNS i' will give you details about the nameserver config";
        " -";
        "Syntax: DNS [option]";
};

help Names {
        " Provides a list of users on the specified channel.";
        " -";
        "Syntax:  NAMES <channel>";
        "Example: NAMES #Support";
};

help Ison {
        " Used to determine if certain user(s) are";

        " currently online based upon their nickname.";
        " -";
        " Syntax:  ISON <user> <user2> <user3> <user4>";
        " Example: ISON hAtbLaDe Stskeeps OperServ AOLBot";
};

help Join {
        " Used to enter one or more channels on an IRC server.";
        " All occupants of the channel will be notified of your arrival.";
        " JOIN with 0 as a parameter makes you Part all channels.";
        " If you specify one or more keys, they will be used to join a +k channel";
        " -";
        " Syntax:  JOIN <chan>,<chan2>,<chan3> <key1>,<key2>,<key3>";
        "  JOIN 0 (Parts all channels)";
        " Example: JOIN #Support";
        "          JOIN #Lobby,#IRCd";
        "          JOIN #IRCd,#Support,#main letmein,somepass,anotherpass";
};

help Part {
        " Used to part (or leave) a channel you currently occupy.";
        " All those in the channel will be notified of your departure.";
        " If you specify a reason it will be displayed to the users on the channel";
        " -";
        " Syntax:  PART <chan>,<chan2>,<chan3>,<chan4> <reason>";
        " Example: PART #Support";
        "          PART #Lobby,#IRCd See ya later!";
};

help Motd {
        " Displays the Message Of The Day of the IRC Server you are logged onto.";
        " -";
        " Syntax: MOTD";
        "         MOTD <server>";
};

help Rules {
        " Shows you the Rules of the Network.";
        " -";
        " Syntax: RULES";

        "         RULES <server>";
};

help Lusers {
        " Provides Local and Global user information";
        " (Such as Current and Maximum user count).";
        " -";
        " Syntax: LUSERS [server]";
};

help Map {
        " Provides a graphical \"Network Map\" of the IRC network.";
        " Mainly used for routing purposes.";
        " -";
        " Syntax: MAP";
};

help Quit {
        " Disconnects you from the IRC server. Those in the";
        " channels you occupy will be notified of your departure.";
        " If you do not specify a reason, your nickname becomes the reason.";
        " -";
        " Syntax:  QUIT <reason>";
        " Example: QUIT Leaving!";
};

help Ping {
        " The PING command is used to test the presence of an active client or";
        " server at the other end of the connection.  Servers send a PING";
        " message at regular intervals if no other activity detected coming";
        " from a connection.  If a connection fails to respond to a PING";
        " message within a set amount of time, that connection is closed. A";
        " PING message MAY be sent even if the connection is active.";
        " Note that this is different from a CTCP PING command..";
        " -";
        " Syntax:  PING <server> <server2>";
        " Example: PING irc.fyremoon.net";
        "          PING hAtbLaDe";
        "          PING hAtbLaDe irc2.dynam.ac";
};