[irc/rqf/shadowircd.git] / doc / sgml / oper-guide / ucommands.sgml

  <chapter id="ucommands">
    <title>User Commands</title>
    <sect1>
      <title>User commands</title>
      <para>
	Standard IRC commands are not listed here.
	Several of the commands in the operator commands chapter
	can also be used by normal users.
      </para>
      <sect2>
	<title>ACCEPT</title>
	<cmdsynopsis><command>ACCEPT</command>
	  <arg choice=plain><replaceable>nick</replaceable>,</arg>
	  <arg choice=plain>-<replaceable>nick</replaceable>,</arg>
	  <arg choice=plain><replaceable>...</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Adds or removes users from your accept list for umode +g and +R.
	  Users are automatically removed when they quit, split or change
	  nick.
	</para>
	<cmdsynopsis><command>ACCEPT</command>
	  <arg choice=plain>*</arg>
	</cmdsynopsis>
	<para>
	  Lists all users on your accept list.
	</para>
	<para>
	  Support of this command is indicated by the CALLERID token in
	  RPL_ISUPPORT (005); the optional parameter indicates the letter
	  of the <quote>only allow accept users to send private messages</quote>
	  umode, otherwise +g. In charybdis this is always +g.
	</para>
      </sect2>
      <sect2>
	<title>CNOTICE</title>
	<cmdsynopsis><command>CNOTICE</command>
	  <arg choice=plain><replaceable>nick</replaceable></arg>
	  <arg choice=plain><replaceable>channel</replaceable></arg>
	  <arg choice=plain>:<replaceable>text</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Providing you are opped (+o) or voiced (+v) in
	  <replaceable>channel</replaceable>, and <replaceable>nick</replaceable>
	  is a member of <replaceable>channel</replaceable>, CNOTICE generates a NOTICE towards
	  <replaceable>nick</replaceable>.
	</para>
	<para>
	  CNOTICE bypasses any anti-spam measures in place.
	  If you get <quote>Targets changing too fast, message dropped</quote>,
	  you should probably use this command, for example sending a
	  notice to every user joining a certain channel.
	</para>
	<para>
	  Support of this command is indicated by the CNOTICE token in
	  RPL_ISUPPORT (005).
	</para>
      </sect2>
      <sect2>
	<title>CPRIVMSG</title>
	<cmdsynopsis><command>CPRIVMSG</command>
	  <arg choice=plain><replaceable>nick</replaceable></arg>
	  <arg choice=plain><replaceable>channel</replaceable></arg>
	  <arg choice=plain>:<replaceable>text</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Providing you are opped (+o) or voiced (+v) in
	  <replaceable>channel</replaceable>, and <replaceable>nick</replaceable>
	  is a member of <replaceable>channel</replaceable>, CPRIVMSG generates a PRIVMSG towards
	  <replaceable>nick</replaceable>.
	</para>
	<para>
	  CPRIVMSG bypasses any anti-spam measures in place.
	  If you get <quote>Targets changing too fast, message dropped</quote>,
	  you should probably use this command.
	</para>
	<para>
	  Support of this command is indicated by the CPRIVMSG token in
	  RPL_ISUPPORT (005).
	</para>
      </sect2>
      <sect2>
	<title>FINDFORWARDS</title>
	<cmdsynopsis><command>FINDFORWARDS</command>
	  <arg choice=plain><replaceable>channel</replaceable></arg>
	</cmdsynopsis>
	<para>
	  <note>
	    <para>
	      This command is only available if the <filename>m_findforwards.so</filename> extension is loaded.
	    </para>
	  </note>
	  Displays which channels forward to the given channel (via cmode +f).
	  If there are very many channels the list will be truncated.
	</para>
	<para>
	  You must be a channel operator on the channel or an IRC operator
	  to use this command.
	</para>
      </sect2>
      <sect2>
	<title>HELP</title>
	<cmdsynopsis><command>HELP</command>
	  <arg><replaceable>topic</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Displays help information. <replaceable>topic</replaceable> can
	  be INDEX, CREDITS, UMODE, CMODE, SNOMASK or a command name.
	</para>
	<para>
	  There are separate help files for users and opers. Opers can use
	  UHELP to query the user help files.
	</para>
      </sect2>
      <sect2>
	<title>IDENTIFY</title>
	<cmdsynopsis><command>IDENTIFY</command>
	  <arg choice=plain><replaceable>parameters...</replaceable></arg>
	</cmdsynopsis>
	<para>
	  <note>
	    <para>
	      This command is only available if the <filename>m_identify.so</filename> extension is loaded.
	    </para>
	  </note>
	  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.
	</para>
	<para>
	  The exact syntax for this command depends on the services package
	  in use.
	</para>
      </sect2>
      <sect2>
	<title>KNOCK</title>
	<cmdsynopsis><command>KNOCK</command>
	  <arg choice=plain><replaceable>channel</replaceable></arg>
	</cmdsynopsis>
	<para>
	  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.
	</para>
	<para>
	  If successful, all channel operators will receive a 710 numeric.
	  The recipient field of this numeric is the channel.
	</para>
	<para>
	  Support of this command is indicated by the KNOCK token in
	  RPL_ISUPPORT (005).
	</para>
      </sect2>
      <sect2>
	<title>MONITOR</title>
	<para>
	  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.
	</para>
	<para>
	  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.
	</para>
	<para>
	  You may only use this command once per second.
	</para>
	<para>
	  More details can be found in <filename>doc/monitor.txt</filename>
	  in the source distribution.
	</para>
	<cmdsynopsis><command>MONITOR +</command>
	  <arg choice=plain><replaceable>nick</replaceable>,</arg>
	  <arg choice=plain><replaceable>...</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Adds nicks to your monitor list. You will receive 730 and 731
	  numerics for the nicks.
	</para>
	<cmdsynopsis><command>MONITOR -</command>
	  <arg choice=plain><replaceable>nick</replaceable>,</arg>
	  <arg choice=plain><replaceable>...</replaceable></arg>
	</cmdsynopsis>
	<para>
	  Removes nicks from your monitor list. No output is generated for
	  this command.
	</para>
	<cmdsynopsis><command>MONITOR C</command>
	</cmdsynopsis>
	<para>
	  Clears your monitor list. No output is generated for
	  this command.
	</para>
	<cmdsynopsis><command>MONITOR L</command>
	</cmdsynopsis>
	<para>
	  Lists all nicks on your monitor list, using 732 numerics and
	  ending with a 733 numeric.
	</para>
	<cmdsynopsis><command>MONITOR S</command>
	</cmdsynopsis>
	<para>
	  Shows status for all nicks on your monitor list, using 730 and 731
	  numerics.
	</para>
      </sect2>
    </sect1>
  </chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document: ("charybdis-oper-guide.sgml" "book")
sgml-exposed-tags:nil
sgml-local-ecat-files:nil
fill-column:105
End:
-->
Commit	Line	Data
212380e3	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>
712ca381 JT	82	<sect2>
	83	<title>FINDFORWARDS</title>
	84	<cmdsynopsis><command>FINDFORWARDS</command>
	85	<arg choice=plain><replaceable>channel</replaceable></arg>
	86	</cmdsynopsis>
	87	<para>
	88	<note>
	89	<para>
	90	This command is only available if the <filename>m_findforwards.so</filename> extension is loaded.
	91	</para>
	92	</note>
	93	Displays which channels forward to the given channel (via cmode +f).
	94	If there are very many channels the list will be truncated.
	95	</para>
	96	<para>
	97	You must be a channel operator on the channel or an IRC operator
	98	to use this command.
	99	</para>
	100	</sect2>
212380e3	101	<sect2>
	102	<title>HELP</title>
	103	<cmdsynopsis><command>HELP</command>
	104	<arg><replaceable>topic</replaceable></arg>
	105	</cmdsynopsis>
	106	<para>
	107	Displays help information. <replaceable>topic</replaceable> can
	108	be INDEX, CREDITS, UMODE, CMODE, SNOMASK or a command name.
	109	</para>
	110	<para>
	111	There are separate help files for users and opers. Opers can use
	112	UHELP to query the user help files.
	113	</para>
	114	</sect2>
712ca381 JT	115	<sect2>
	116	<title>IDENTIFY</title>
	117	<cmdsynopsis><command>IDENTIFY</command>
	118	<arg choice=plain><replaceable>parameters...</replaceable></arg>
	119	</cmdsynopsis>
	120	<para>
	121	<note>
	122	<para>
	123	This command is only available if the <filename>m_identify.so</filename> extension is loaded.
	124	</para>
	125	</note>
	126	Sends an identify command to either NickServ or ChanServ.
	127	If the first parameter starts with #, the command is sent to
	128	ChanServ, otherwise to NickServ.
	129	The word IDENTIFY, a space and all parameters are concatenated
	130	and sent as a PRIVMSG to the service.
	131	If the service is not online or does not have umode +S set,
	132	no message will be sent.
	133	</para>
	134	<para>
	135	The exact syntax for this command depends on the services package
	136	in use.
	137	</para>
	138	</sect2>
212380e3	139	<sect2>
	140	<title>KNOCK</title>
	141	<cmdsynopsis><command>KNOCK</command>
	142	<arg choice=plain><replaceable>channel</replaceable></arg>
	143	</cmdsynopsis>
	144	<para>
	145	Requests an invite to the given channel. The channel must be
	146	locked somehow (+ikl), must not be +p and you may not be banned
	147	or quieted. Also, this command is rate limited.
	148	</para>
	149	<para>
	150	If successful, all channel operators will receive a 710 numeric.
	151	The recipient field of this numeric is the channel.
	152	</para>
	153	<para>
	154	Support of this command is indicated by the KNOCK token in
	155	RPL_ISUPPORT (005).
	156	</para>
	157	</sect2>
	158	<sect2>
	159	<title>MONITOR</title>
	160	<para>
	161	Server side notify list. This list contains nicks. When a user
	162	connects, quits with a listed nick or changes to or from a listed
	163	nick, you will receive a 730 numeric if the nick went online and
	164	a 731 numeric if the nick went offline.
	165	</para>
	166	<para>
	167	Support of this command is indicated by the MONITOR token in
	168	RPL_ISUPPORT (005); the parameter indicates the maximum number
	169	of nicknames you may have in your monitor list.
	170	</para>
	171	<para>
	172	You may only use this command once per second.
	173	</para>
	174	<para>
	175	More details can be found in <filename>doc/monitor.txt</filename>
	176	in the source distribution.
	177	</para>
	178	<cmdsynopsis><command>MONITOR +</command>
	179	<arg choice=plain><replaceable>nick</replaceable>,</arg>
	180	<arg choice=plain><replaceable>...</replaceable></arg>
	181	</cmdsynopsis>
	182	<para>
	183	Adds nicks to your monitor list. You will receive 730 and 731
	184	numerics for the nicks.
	185	</para>
	186	<cmdsynopsis><command>MONITOR -</command>
	187	<arg choice=plain><replaceable>nick</replaceable>,</arg>
	188	<arg choice=plain><replaceable>...</replaceable></arg>
	189	</cmdsynopsis>
	190	<para>
	191	Removes nicks from your monitor list. No output is generated for
	192	this command.
	193	</para>
	194	<cmdsynopsis><command>MONITOR C</command>
	195	</cmdsynopsis>
	196	<para>
	197	Clears your monitor list. No output is generated for
	198	this command.
	199	</para>
	200	<cmdsynopsis><command>MONITOR L</command>
	201	</cmdsynopsis>
	202	<para>
203	Lists all nicks on your monitor list, using 732 numerics and
204	ending with a 733 numeric.
205	</para>
206	<cmdsynopsis><command>MONITOR S</command>
207	</cmdsynopsis>
208	<para>
209	Shows status for all nicks on your monitor list, using 730 and 731
210	numerics.
211	</para>
212	</sect2>
213	</sect1>
214	</chapter>
215	<!-- Keep this comment at the end of the file
216	Local variables:
217	mode: sgml
218	sgml-omittag:t
219	sgml-shorttag:t
220	sgml-namecase-general:t
221	sgml-general-insert-case:lower
222	sgml-minimize-attributes:nil
223	sgml-always-quote-attributes:t
224	sgml-indent-step:2
225	sgml-indent-data:t
226	sgml-parent-document: ("charybdis-oper-guide.sgml" "book")
227	sgml-exposed-tags:nil
228	sgml-local-ecat-files:nil
229	fill-column:105
230	End:
231	-->