jfr.im git - solanum.git/blame_incremental - doc/oper-guide/ucommands.rst

... / ...

Commit	Line	Data
	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	CPRIVMSG nick channel :text
	54
	55	Providing you are opped (+o) or voiced (+v) in channel, and nick is a
	56	member of channel, ``CPRIVMSG`` generates a ``PRIVMSG`` towards nick.
	57
	58	``CPRIVMSG`` bypasses any anti-spam measures in place. If you get “Targets
	59	changing too fast, message dropped”, you should probably use this
	60	command.
	61
	62	As of charybdis 3.1, ``PRIVMSG`` automatically behaves as ``CPRIVMSG`` if you
	63	are in a channel fulfilling the conditions.
	64
	65	Support of this command is indicated by the ``CPRIVMSG`` token in
	66	``RPL_ISUPPORT`` (005).
	67
	68	FINDFORWARDS
	69	------------
	70
	71	::
	72	FINDFORWARDS channel
	73
	74	.. note:: This command is only available if the ``m_findforwards.so``
	75	extension is loaded.
	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
	86	::
	87	HELP [topic]
	88
	89	Displays help information. topic can be ``INDEX``, ``CREDITS``, ``UMODE``, ``CMODE``,
	90	``SNOMASK`` or a command name.
	91
	92	There are separate help files for users and opers. Opers can use ``UHELP``
	93	to query the user help files.
	94
	95	IDENTIFY
	96	--------
	97
	98	::
	99	IDENTIFY parameters...
	100
	101	.. note:: This command is only available if the ``m_identify.so``
	102	extension is loaded.
	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
	106	NickServ. The word ``IDENTIFY``, a space and all parameters are concatenated
	107	and sent as a ``PRIVMSG`` to the service. If the service is not online or
	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
	116	::
	117	KNOCK channel
	118
	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
	126	Support of this command is indicated by the ``KNOCK`` token in ``RPL_ISUPPORT``
	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
	137	Support of this command is indicated by the ``MONITOR`` token in
	138	``RPL_ISUPPORT`` (005); the parameter indicates the maximum number of
	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
	146	::
	147	MONITOR + nick, ...
	148
	149	Adds nicks to your monitor list. You will receive 730 and 731 numerics
	150	for the nicks.
	151
	152	::
	153	MONITOR - nick, ...
	154
	155	Removes nicks from your monitor list. No output is generated for this
	156	command.
	157
	158	::
	159	MONITOR C
	160
	161	Clears your monitor list. No output is generated for this command.
	162
	163	::
	164	MONITOR L
	165
	166	Lists all nicks on your monitor list, using 732 numerics and ending with
	167	a 733 numeric.
	168
	169	::
	170	MONITOR S
	171
	172	Shows status for all nicks on your monitor list, using 730 and 731
	173	numerics.