[solanum.git] / doc / oper-guide / ucommands.rst

User Commands
=============

Standard IRC commands are not listed here. Several of the commands in
the operator commands chapter can also be used by normal users.

``ACCEPT``
------

::

   ACCEPT nick, -nick, ...

Adds or removes users from your accept list for umode +g and +R. Users
are automatically removed when they quit, split or change nick.

::

   ACCEPT *

Lists all users on your accept list.

Support of this command is indicated by the ``CALLERID`` token in
``RPL_ISUPPORT`` (005); the optional parameter indicates the letter of the
“only allow accept users to send private messages” umode, otherwise +g.
In charybdis this is always +g.

CNOTICE
-------

::

   CNOTICE nick channel :text

Providing you are opped (+o) or voiced (+v) in channel, and nick is a
member of channel, ``CNOTICE`` generates a ``NOTICE`` towards nick.

``CNOTICE`` bypasses any anti-spam measures in place. If you get “Targets
changing too fast, message dropped”, you should probably use this
command, for example sending a notice to every user joining a certain
channel.

As of charybdis 3.1, ``NOTICE`` automatically behaves as ``CNOTICE`` if you are
in a channel fulfilling the conditions.

Support of this command is indicated by the ``CNOTICE`` token in
``RPL_ISUPPORT`` (005).

CPRIVMSG
--------

::
   CPRIVMSG nick channel :text

Providing you are opped (+o) or voiced (+v) in channel, and nick is a
member of channel, ``CPRIVMSG`` generates a ``PRIVMSG`` towards nick.

``CPRIVMSG`` bypasses any anti-spam measures in place. If you get “Targets
changing too fast, message dropped”, you should probably use this
command.

As of charybdis 3.1, ``PRIVMSG`` automatically behaves as ``CPRIVMSG`` if you
are in a channel fulfilling the conditions.

Support of this command is indicated by the ``CPRIVMSG`` token in
``RPL_ISUPPORT`` (005).

FINDFORWARDS
------------

::
   FINDFORWARDS channel

.. note:: This command is only available if the ``m_findforwards.so``
          extension is loaded.

Displays which channels forward to the given channel (via cmode +f). If
there are very many channels the list will be truncated.

You must be a channel operator on the channel or an IRC operator to use
this command.

HELP
----

::
   HELP [topic]

Displays help information. topic can be ``INDEX``, ``CREDITS``, ``UMODE``, ``CMODE``,
``SNOMASK`` or a command name.

There are separate help files for users and opers. Opers can use ``UHELP``
to query the user help files.

IDENTIFY
--------

::
   IDENTIFY parameters...

.. note:: This command is only available if the ``m_identify.so``
          extension is loaded.

Sends an identify command to either NickServ or ChanServ. If the first
parameter starts with #, the command is sent to ChanServ, otherwise to
NickServ. The word ``IDENTIFY``, a space and all parameters are concatenated
and sent as a ``PRIVMSG`` to the service. If the service is not online or
does not have umode +S set, no message will be sent.

The exact syntax for this command depends on the services package in
use.

KNOCK
-----

::
   KNOCK channel

Requests an invite to the given channel. The channel must be locked
somehow (+ikl), must not be +p and you may not be banned or quieted.
Also, this command is rate limited.

If successful, all channel operators will receive a 710 numeric. The
recipient field of this numeric is the channel.

Support of this command is indicated by the ``KNOCK`` token in ``RPL_ISUPPORT``
(005).

MONITOR
-------

Server side notify list. This list contains nicks. When a user connects,
quits with a listed nick or changes to or from a listed nick, you will
receive a 730 numeric if the nick went online and a 731 numeric if the
nick went offline.

Support of this command is indicated by the ``MONITOR`` token in
``RPL_ISUPPORT`` (005); the parameter indicates the maximum number of
nicknames you may have in your monitor list.

You may only use this command once per second.

More details can be found in ``doc/monitor.txt`` in the source
distribution.

::
   MONITOR + nick, ...

Adds nicks to your monitor list. You will receive 730 and 731 numerics
for the nicks.

::
   MONITOR - nick, ...

Removes nicks from your monitor list. No output is generated for this
command.

::
   MONITOR C

Clears your monitor list. No output is generated for this command.

::
   MONITOR L

Lists all nicks on your monitor list, using 732 numerics and ending with
a 733 numeric.

::
   MONITOR S

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