doc/sgml/oper-guide/ucommands.sgml

   1   <chapter id="ucommands">
   2     <title>User Commands</title>
   3     <sect1>
   4       <title>User commands</title>
   5       <para>
   6         Standard IRC commands are not listed here.
   7         Several of the commands in the operator commands chapter
   8         can also be used by normal users.
   9       </para>
  10       <sect2>
  11         <title>ACCEPT</title>
  12         <cmdsynopsis><command>ACCEPT</command>
  13           <arg choice=plain><replaceable>nick</replaceable>,</arg>
  14           <arg choice=plain>-<replaceable>nick</replaceable>,</arg>
  15           <arg choice=plain><replaceable>...</replaceable></arg>
  16         </cmdsynopsis>
  17         <para>
  18           Adds or removes users from your accept list for umode +g and +R.
  19           Users are automatically removed when they quit, split or change
  20           nick.
  21         </para>
  22         <cmdsynopsis><command>ACCEPT</command>
  23           <arg choice=plain>*</arg>
  24         </cmdsynopsis>
  25         <para>
  26           Lists all users on your accept list.
  27         </para>
  28         <para>
  29           Support of this command is indicated by the CALLERID token in
  30           RPL_ISUPPORT (005); the optional parameter indicates the letter
  31           of the <quote>only allow accept users to send private messages</quote>
  32           umode, otherwise +g. In charybdis this is always +g.
  33         </para>
  34       </sect2>
  35       <sect2>
  36         <title>CNOTICE</title>
  37         <cmdsynopsis><command>CNOTICE</command>
  38           <arg choice=plain><replaceable>nick</replaceable></arg>
  39           <arg choice=plain><replaceable>channel</replaceable></arg>
  40           <arg choice=plain>:<replaceable>text</replaceable></arg>
  41         </cmdsynopsis>
  42         <para>
  43           Providing you are opped (+o) or voiced (+v) in
  44           <replaceable>channel</replaceable>, and <replaceable>nick</replaceable>
  45           is a member of <replaceable>channel</replaceable>, CNOTICE generates a NOTICE towards
  46           <replaceable>nick</replaceable>.
  47         </para>
  48         <para>
  49           CNOTICE bypasses any anti-spam measures in place.
  50           If you get <quote>Targets changing too fast, message dropped</quote>,
  51           you should probably use this command, for example sending a
  52           notice to every user joining a certain channel.
  53         </para>
  54         <para>
  55           Support of this command is indicated by the CNOTICE token in
  56           RPL_ISUPPORT (005).
  57         </para>
  58       </sect2>
  59       <sect2>
  60         <title>CPRIVMSG</title>
  61         <cmdsynopsis><command>CPRIVMSG</command>
  62           <arg choice=plain><replaceable>nick</replaceable></arg>
  63           <arg choice=plain><replaceable>channel</replaceable></arg>
  64           <arg choice=plain>:<replaceable>text</replaceable></arg>
  65         </cmdsynopsis>
  66         <para>
  67           Providing you are opped (+o) or voiced (+v) in
  68           <replaceable>channel</replaceable>, and <replaceable>nick</replaceable>
  69           is a member of <replaceable>channel</replaceable>, CPRIVMSG generates a PRIVMSG towards
  70           <replaceable>nick</replaceable>.
  71         </para>
  72         <para>
  73           CPRIVMSG bypasses any anti-spam measures in place.
  74           If you get <quote>Targets changing too fast, message dropped</quote>,
  75           you should probably use this command.
  76         </para>
  77         <para>
  78           Support of this command is indicated by the CPRIVMSG token in
  79           RPL_ISUPPORT (005).
  80         </para>
  81       </sect2>
  82       <sect2>
  83         <title>HELP</title>
  84         <cmdsynopsis><command>HELP</command>
  85           <arg><replaceable>topic</replaceable></arg>
  86         </cmdsynopsis>
  87         <para>
  88           Displays help information. <replaceable>topic</replaceable> can
  89           be INDEX, CREDITS, UMODE, CMODE, SNOMASK or a command name.
  90         </para>
  91         <para>
  92           There are separate help files for users and opers. Opers can use
  93           UHELP to query the user help files.
  94         </para>
  95       </sect2>
  96       <sect2>
  97         <title>KNOCK</title>
  98         <cmdsynopsis><command>KNOCK</command>
  99           <arg choice=plain><replaceable>channel</replaceable></arg>
 100         </cmdsynopsis>
 101         <para>
 102           Requests an invite to the given channel. The channel must be
 103           locked somehow (+ikl), must not be +p and you may not be banned
 104           or quieted. Also, this command is rate limited.
 105         </para>
 106         <para>
 107           If successful, all channel operators will receive a 710 numeric.
 108           The recipient field of this numeric is the channel.
 109         </para>
 110         <para>
 111           Support of this command is indicated by the KNOCK token in
 112           RPL_ISUPPORT (005).
 113         </para>
 114       </sect2>
 115       <sect2>
 116         <title>MONITOR</title>
 117         <para>
 118           Server side notify list. This list contains nicks. When a user
 119           connects, quits with a listed nick or changes to or from a listed
 120           nick, you will receive a 730 numeric if the nick went online and
 121           a 731 numeric if the nick went offline.
 122         </para>
 123         <para>
 124           Support of this command is indicated by the MONITOR token in
 125           RPL_ISUPPORT (005); the parameter indicates the maximum number
 126           of nicknames you may have in your monitor list.
 127         </para>
 128         <para>
 129           You may only use this command once per second.
 130         </para>
 131         <para>
 132           More details can be found in <filename>doc/monitor.txt</filename>
 133           in the source distribution.
 134         </para>
 135         <cmdsynopsis><command>MONITOR +</command>
 136           <arg choice=plain><replaceable>nick</replaceable>,</arg>
 137           <arg choice=plain><replaceable>...</replaceable></arg>
 138         </cmdsynopsis>
 139         <para>
 140           Adds nicks to your monitor list. You will receive 730 and 731
 141           numerics for the nicks.
 142         </para>
 143         <cmdsynopsis><command>MONITOR -</command>
 144           <arg choice=plain><replaceable>nick</replaceable>,</arg>
 145           <arg choice=plain><replaceable>...</replaceable></arg>
 146         </cmdsynopsis>
 147         <para>
 148           Removes nicks from your monitor list. No output is generated for
 149           this command.
 150         </para>
 151         <cmdsynopsis><command>MONITOR C</command>
 152         </cmdsynopsis>
 153         <para>
 154           Clears your monitor list. No output is generated for
 155           this command.
 156         </para>
 157         <cmdsynopsis><command>MONITOR L</command>
 158         </cmdsynopsis>
 159         <para>
 160           Lists all nicks on your monitor list, using 732 numerics and
 161           ending with a 733 numeric.
 162         </para>
 163         <cmdsynopsis><command>MONITOR S</command>
 164         </cmdsynopsis>
 165         <para>
 166           Shows status for all nicks on your monitor list, using 730 and 731
 167           numerics.
 168         </para>
 169       </sect2>
 170     </sect1>
 171   </chapter>
 172 <!-- Keep this comment at the end of the file
 173 Local variables:
 174 mode: sgml
 175 sgml-omittag:t
 176 sgml-shorttag:t
 177 sgml-namecase-general:t
 178 sgml-general-insert-case:lower
 179 sgml-minimize-attributes:nil
 180 sgml-always-quote-attributes:t
 181 sgml-indent-step:2
 182 sgml-indent-data:t
 183 sgml-parent-document: ("charybdis-oper-guide.sgml" "book")
 184 sgml-exposed-tags:nil
 185 sgml-local-ecat-files:nil
 186 fill-column:105
 187 End:
 188 -->