doc/oper-guide/ucommands.rst

   1 User Commands
   2 =============
   3
   4 Standard IRC commands are not listed here. Several of the commands in
   5 the operator commands chapter can also be used by normal users.
   6
   7 ACCEPT
   8 ------
   9
  10 ::
  11
  12    ACCEPT nick, -nick, ...
  13
  14 Adds or removes users from your accept list for umode +g and +R. Users
  15 are automatically removed when they quit, split or change nick.
  16
  17 ::
  18
  19    ACCEPT *
  20
  21 Lists all users on your accept list.
  22
  23 Support of this command is indicated by the ``CALLERID`` token in
  24 ``RPL_ISUPPORT`` (005); the optional parameter indicates the letter of the
  25 “only allow accept users to send private messages” umode, otherwise +g.
  26 In charybdis this is always +g.
  27
  28 CNOTICE
  29 -------
  30
  31 ::
  32
  33    CNOTICE nick channel :text
  34
  35 Providing you are opped (+o) or voiced (+v) in channel, and nick is a
  36 member of channel, ``CNOTICE`` generates a ``NOTICE`` towards nick.
  37
  38 ``CNOTICE`` bypasses any anti-spam measures in place. If you get “Targets
  39 changing too fast, message dropped”, you should probably use this
  40 command, for example sending a notice to every user joining a certain
  41 channel.
  42
  43 As of charybdis 3.1, ``NOTICE`` automatically behaves as ``CNOTICE`` if you are
  44 in a channel fulfilling the conditions.
  45
  46 Support of this command is indicated by the ``CNOTICE`` token in
  47 ``RPL_ISUPPORT`` (005).
  48
  49 CPRIVMSG
  50 --------
  51
  52 ::
  53
  54    CPRIVMSG nick channel :text
  55
  56 Providing you are opped (+o) or voiced (+v) in channel, and nick is a
  57 member of channel, ``CPRIVMSG`` generates a ``PRIVMSG`` towards nick.
  58
  59 ``CPRIVMSG`` bypasses any anti-spam measures in place. If you get “Targets
  60 changing too fast, message dropped”, you should probably use this
  61 command.
  62
  63 As of charybdis 3.1, ``PRIVMSG`` automatically behaves as ``CPRIVMSG`` if you
  64 are in a channel fulfilling the conditions.
  65
  66 Support of this command is indicated by the ``CPRIVMSG`` token in
  67 ``RPL_ISUPPORT`` (005).
  68
  69 FINDFORWARDS
  70 ------------
  71
  72 ::
  73
  74    FINDFORWARDS channel
  75
  76 .. note:: This command is only available if the ``m_findforwards.so``
  77           extension is loaded.
  78
  79 Displays which channels forward to the given channel (via cmode +f). If
  80 there are very many channels the list will be truncated.
  81
  82 You must be a channel operator on the channel or an IRC operator to use
  83 this command.
  84
  85 HELP
  86 ----
  87
  88 ::
  89
  90    HELP [topic]
  91
  92 Displays help information. topic can be ``INDEX``, ``CREDITS``, ``UMODE``, ``CMODE``,
  93 ``SNOMASK`` or a command name.
  94
  95 There are separate help files for users and opers. Opers can use ``UHELP``
  96 to query the user help files.
  97
  98 IDENTIFY
  99 --------
 100
 101 ::
 102
 103    IDENTIFY parameters...
 104
 105 .. note:: This command is only available if the ``m_identify.so``
 106           extension is loaded.
 107
 108 Sends an identify command to either NickServ or ChanServ. If the first
 109 parameter starts with #, the command is sent to ChanServ, otherwise to
 110 NickServ. The word ``IDENTIFY``, a space and all parameters are concatenated
 111 and sent as a ``PRIVMSG`` to the service. If the service is not online or
 112 does not have umode +S set, no message will be sent.
 113
 114 The exact syntax for this command depends on the services package in
 115 use.
 116
 117 KNOCK
 118 -----
 119
 120 ::
 121
 122    KNOCK channel
 123
 124 Requests an invite to the given channel. The channel must be locked
 125 somehow (+ikl), must not be +p and you may not be banned or quieted.
 126 Also, this command is rate limited.
 127
 128 If successful, all channel operators will receive a 710 numeric. The
 129 recipient field of this numeric is the channel.
 130
 131 Support of this command is indicated by the ``KNOCK`` token in ``RPL_ISUPPORT``
 132 (005).
 133
 134 MONITOR
 135 -------
 136
 137 Server side notify list. This list contains nicks. When a user connects,
 138 quits with a listed nick or changes to or from a listed nick, you will
 139 receive a 730 numeric if the nick went online and a 731 numeric if the
 140 nick went offline.
 141
 142 Support of this command is indicated by the ``MONITOR`` token in
 143 ``RPL_ISUPPORT`` (005); the parameter indicates the maximum number of
 144 nicknames you may have in your monitor list.
 145
 146 You may only use this command once per second.
 147
 148 More details can be found in ``doc/monitor.txt`` in the source
 149 distribution.
 150
 151 ::
 152
 153    MONITOR + nick, ...
 154
 155 Adds nicks to your monitor list. You will receive 730 and 731 numerics
 156 for the nicks.
 157
 158 ::
 159
 160    MONITOR - nick, ...
 161
 162 Removes nicks from your monitor list. No output is generated for this
 163 command.
 164
 165 ::
 166
 167    MONITOR C
 168
 169 Clears your monitor list. No output is generated for this command.
 170
 171 ::
 172
 173    MONITOR L
 174
 175 Lists all nicks on your monitor list, using 732 numerics and ending with
 176 a 733 numeric.
 177
 178 ::
 179
 180    MONITOR S
 181
 182 Shows status for all nicks on your monitor list, using 730 and 731
 183 numerics.