C

Current revision as of 02:53, 15 October 2012

C is our channel services bot here on DareNET. It provides numerous features that help automate channel management, prevent channel takeovers and generally make life easier for both users and staff. This document describes the different commands and features that C provides.

Usage

You can communicate with C via private message, or through server-side aliases, as shown below:

/msg C <text>
/msg C@services.darenet.org <text>
/ChanServ <text>
/CS <text>

C also supports "in-channel" (also known as "fantasy") commands, which is discussed below.

For the purpose of this document, we will be using the first two methods listed, as some IRC clients do not readily support server-side aliases without additional setup and/or client commands. However, you can choose to use any of the above methods.

In-channel Commands

As previously mentioned, C supports what we call in-channel commands. You can use the in-channel method for just about any of the commands C recognizes. All in-channel commands directed towards C begin with a period. If a command is given in a channel, and the channel parameter is not given, C will use the name of the channel that the command was used in.

In-channel commands may only be used in registered channels; however, C does not have to reside in the channel for them to work.

Example:

To illustrate what we're talking about, let's say we have a channel named #chat and we would like to grant the user JoeClient op status. Using the in-channel method, we could achieve this by simply typing the following in #chat:

.OP JoeClient

User Management Commands

ACCESS Check a user's access level in a channel.	CLVL Change a user's access level.	MDELCOOWNER Delete multiple Co-owners.	SUSPEND Suspend a user's access.
ADDCOOWNER Grant user Co-owner access.	CLIST List all Co-owners.	MDELGRUNT Delete multiple Grunts.	TRIM Delete users based on last activity
ADDGRUNT Grant user Grunt access.	DELETEME Delete yourself from a channel's user list.	MDELHOP Delete multiple HalfOps.	UNSUSPEND Restore a suspended user's access.
ADDHOP Grant user HalfOp access.	DELBAN Delete entry from bans list.	MDELMANAGER Delete multiple Managers.	USERS View channel's user list.
ADDBAN Add entry to bans list.	DELUSER Delete user from channel's user list.	MDELOP Delete multiple Ops.	USET Set your user options for a channel.
ADDMANAGER Grant user Manager access.	GLIST List all Grunts.	MLIST View Managers list.	WIPEINFO Remove a user's info line.
ADDOP Grant a user Op access in a channel.	GIVEOWNERSHIP Give away ownership of channel.	MYACCESS List channels you have access in.	WLIST List all Owners.
ADDTIMEDBAN Add entry to bans list that expires.	HLIST List all HalfOps.	OLIST List all Ops.
ADDUSER A more advanced way of granting access to users.	BANS View channel's bans list.	SEEN View last time a user was in the channel.

Channel Management Commands

BAN Set a ban on a user/host.	EVENTS List recent activity by channel users.	OP Grant use Op status (+o).	UNBANALL Clear channel ban list.
DEHOP Remove HalfOp status from user(s).	HOP Grant user HalfOp status (+h).	OPEN Remove modes/bans preventing you from joining channel.	UNBANME Remove bans matching yourself.
DELNOTE Delete a channel note.	INVITE Invite yourself (or others) into the channel.	RESYNC Synchronize the channel's member list.	UNREGISTER Unregister a channel.
DEOP Remove Op status from user(s).	KICK Kick user(s) from channel.	REGISTER Registers a channel to your account.	UP Grant yourself (Half)Op status.
DEVOICE Remove Voice status from user(s).	KICKBAN Kick + Ban user(s) from channel.	SET Change various channel settings.	UPALL Grant yourself (Half)Op/Voice status in all channels.
DOWN Remove (Half)Op/Voice status from yourself.	MODE Manipulate channel's mode settings.	TOPIC Set (or restore) the channel's topic.	VOICE Grant user voice status (+v)
DOWNALL Remove (Half)Op/Voice status in all channels.	NOTE Set a channel note.	UNBAN Remove entries from channel ban list.

Quote Database Management Commands

ADDQUOTE
Add a quote.

DELQUOTE
Delete a quote.

QUOTE
View a quote, or search quote database.

QVOTE
Rate a quote.

Informative / Miscellaneous Commands

COMMAND View some misc. info about a command.	INFO View channel's registration record.	LEVELS List numerical equivalents for named access levels.	STAFF List all network staff (opers+helpers) currently online.
HELPERS List support helpers currently online.	IRCOPS List IRC operators currently online.	PEEK View information on a channel's modes, topic and member list.	VERSION View version information about C.

Toys

8BALL Ask the magic 8ball a question.	FML Get a random quote from www.fmylife.com.	INSPIRE Get a random inspirational quote.	PASTEBIN Paste text to pastebin.com.
CALC Calculate a mathematical expression.	GOOGLE Search Google.	ISGD Expands or shortens url for is.gd.	TWITTER View tweets via IRC.
DICE Roll the dice.	GUESS Guess the number (between 1 and 100).	ISITDOWN Check whether a site is reachable (up) or not (down).	WEATHER Get weather conditions for a location.

@@ Line 1: / Line 1: @@
-== What is ChanServ? ==
+C is our channel services bot here on DareNET. It provides numerous features that help automate channel management, prevent channel takeovers and generally make life easier for both users and staff. This document describes the different commands and features that C provides.
-ChanServ is our channel services bot here on DareNET. It provides numerous features that help automate channel management, prevent channel takeovers and generally make life easier for both users and staff. This document will discuss the various commands and features that ChanServ provides.
+== Usage ==
-You can communicate with ChanServ by using /msg ChanServ@services.darenet.org, /ChanServ or /CS. For the purpose of this document, we will be using the /ChanServ command; however, it can be substituted with the other methods we just listed. NOTE: Some IRC clients (e.g. irssi) do not support the /ChanServ and /CS command aliases, and you will need to use /msg ChanServ@services.darenet.org instead.
+You can communicate with C via private message, or through server-side aliases, as shown below:
-=== In-channel commands ===
+* <code>/msg C <nowiki><text></nowiki></code>
+* <code>/msg C@services.darenet.org <nowiki><text></nowiki></code>
+* <code>/ChanServ <nowiki><text></nowiki></code>
+* <code>/CS <nowiki><text></nowiki></code>
-Additionally, ChanServ supports in-channel (also known as fantasy) commands for the vast majority of the commands in its command list. If a command is given in a channel, and the channel parameter is not given, ChanServ will use the channel that the command was issued in. Additionally, in-channel commands may be used in any registered channel whether ChanServ resides in the channel or not.
+C also supports "in-channel" (also known as "fantasy") commands, which is discussed below.
-To illustrate what we were talking about, let's say we have a channel named ''#chat'' and we wanted to op the user ''JoeClient''. We could use one of the following commands to do so:
+For the purpose of this document, we will be using the first two methods listed, as some IRC clients do not readily support server-side aliases without additional setup and/or client commands. However, you can choose to use any of the above methods.
-<code>/ChanServ OP #chat JoeClient</code>
+==In-channel Commands==
--or, within #chat itself-
+As previously mentioned, C supports what we call ''in-channel'' commands. You can use the ''in-channel'' method for just about any of the commands C recognizes. All ''in-channel'' commands directed towards C begin with a period. If a command is given in a channel, and the channel parameter is not given, C will use the name of the channel that the command was used in.
-<code>.OP JoeClient</code>
+''In-channel'' commands may only be used in registered channels; however, C does not have to reside in the channel for them to work.
-NOTE: All ChanServ in-channel/fantasy commands are prefixed with '''.''' on DareNET.
+'''Example:'''
-== Registering a Channel ==
+To illustrate what we're talking about, let's say we have a channel named ''#chat'' and we would like to grant the user ''JoeClient'' op status. Using the ''in-channel'' method, we could achieve this by simply typing the following in ''#chat'':
-To obtain ChanServ, you will first need to register your channel. This document assumes you already have a registered channel. For information on registering and obtaining ChanServ, please visit our [http://www.darenet.org/channel_registration Channel Registration Guidelines].
+<code>.OP JoeClient</code>
-== Unregistering a Channel ==
-If you no longer desire to run your channel, consider passing it on to someone else; however, you may also unregister it -- leaving it available for anyone else to register.
-'''Syntax:''' <code>/ChanServ UNREGISTER #channel [code]</code>
+==User Management Commands==
+{| class="srvcscmd" width="100%" style="font-size: 90%;"
+|-
+| style="width: 310px;"|<span class="cmd">[[C/access|ACCESS]]</span><br />Check a user's access level in a channel.
+| style="width: 310px;"|<span class="cmd">[[C/clvl|CLVL]]</span><br />Change a user's access level.
+| style="width: 310px;"|<span class="cmd">[[C/mdelowner|MDELCOOWNER]]</span><br />Delete multiple Co-owners.
+| style="width: 310px;"|<span class="cmd">[[C/suspend|SUSPEND]]</span><br />Suspend a user's access.
+|-
+| <span class="cmd">[[C/addcoowner|ADDCOOWNER]]</span><br />Grant user Co-owner access.
+| <span class="cmd">[[C/clist|CLIST]]</span><br />List all Co-owners.
+| <span class="cmd">[[C/mdelgrunt|MDELGRUNT]]</span><br />Delete multiple Grunts.
+| <span class="cmd">[[C/trim|TRIM]]</span><br />Delete users based on last activity
+|-
+| <span class="cmd">[[C/addgrunt|ADDGRUNT]]</span><br />Grant user Grunt access.
+| <span class="cmd">[[C/deleteme|DELETEME]]</span><br />Delete yourself from a channel's user list.
+| <span class="cmd">[[C/mdelhop|MDELHOP]]</span><br />Delete multiple HalfOps.
+| <span class="cmd">[[C/unsuspend|UNSUSPEND]]</span><br />Restore a suspended user's access.
+|-
+| <span class="cmd">[[C/addhop|ADDHOP]]</span><br />Grant user HalfOp access.
+| <span class="cmd">[[C/delban|DELBAN]]</span><br />Delete entry from bans list.
+| <span class="cmd">[[C/mdelmanager|MDELMANAGER]]</span><br />Delete multiple Managers.
+| <span class="cmd">[[C/users|USERS]]</span><br />View channel's user list.
+|-
+| <span class="cmd">[[C/addban|ADDBAN]]</span><br />Add entry to bans list.
+| <span class="cmd">[[C/deluser|DELUSER]]</span><br />Delete user from channel's user list.
+| <span class="cmd">[[C/mdelop|MDELOP]]</span><br />Delete multiple Ops.
+| <span class="cmd">[[C/uset|USET]]</span><br />Set your user options for a channel.
+|-
+| <span class="cmd">[[C/addmanager|ADDMANAGER]]</span><br />Grant user Manager access.
+| <span class="cmd">[[C/glist|GLIST]]</span><br />List all Grunts.
+| <span class="cmd">[[C/mlist|MLIST]]</span><br />View Managers list.
+| <span class="cmd">[[C/wipeinfo|WIPEINFO]]</span><br />Remove a user's info line.
+|-
+| <span class="cmd">[[C/addop|ADDOP]]</span><br />Grant a user Op access in a channel.
+| <span class="cmd">[[C/giveownership|GIVEOWNERSHIP]]</span><br />Give away ownership of channel.
+| <span class="cmd">[[C/myaccess|MYACCESS]]</span><br />List channels you have access in.
+| <span class="cmd">[[C/wlist|WLIST]]</span><br />List all Owners.
+|-
+| <span class="cmd">[[C/addtimedban|ADDTIMEDBAN]]</span><br />Add entry to bans list that expires.
+| <span class="cmd">[[C/hlist|HLIST]]</span><br />List all HalfOps.
+| <span class="cmd">[[C/olist|OLIST]]</span><br />List all Ops.
+|
+|-
+| <span class="cmd">[[C/adduser|ADDUSER]]</span><br />A more advanced way of granting access to users.
+| <span class="cmd">[[C/bans|BANS]]</span><br />View channel's bans list.
+| <span class="cmd">[[C/seen|SEEN]]</span><br />View last time a user was in the channel.
+|
+|}
-This command will allow you to unregister a channel you are an owner of. You must first issue the command alone without the 'code', you will then receive an unregister code which you type in with the command (a second time).
+==Channel Management Commands==
+{| class="srvcscmd" width="100%" style="font-size: 90%;"
+|-
+| style="width: 310px;"|<span class="cmd">[[C/ban|BAN]]</span><br />Set a ban on a user/host.
+| style="width: 310px;"|<span class="cmd">[[C/events|EVENTS]]</span><br />List recent activity by channel users.
+| style="width: 310px;"|<span class="cmd">[[C/op|OP]]</span><br />Grant use Op status (+o).
+| style="width: 310px;"|<span class="cmd">[[C/unbanall|UNBANALL]]</span><br />Clear channel ban list.
+|-
+| <span class="cmd">[[C/dehop|DEHOP]]</span><br />Remove HalfOp status from user(s).
+| <span class="cmd">[[C/hop|HOP]]</span><br />Grant user HalfOp status (+h).
+| <span class="cmd">[[C/open|OPEN]]</span><br />Remove modes/bans preventing you from joining channel.
+| <span class="cmd">[[C/unbanme|UNBANME]]</span><br />Remove bans matching yourself.
+|-
+| <span class="cmd">[[C/delnote|DELNOTE]]</span><br />Delete a channel note.
+| <span class="cmd">[[C/invite|INVITE]]</span><br />Invite yourself (or others) into the channel.
+| <span class="cmd">[[C/resync|RESYNC]]</span><br />Synchronize the channel's member list.
+| <span class="cmd">[[C/unregister|UNREGISTER]]</span><br />Unregister a channel.
+|-
+| <span class="cmd">[[C/deop|DEOP]]</span><br />Remove Op status from user(s).
+| <span class="cmd">[[C/kick|KICK]]</span><br />Kick user(s) from channel.
+| <span class="cmd">[[C/register|REGISTER]]</span><br />Registers a channel to your account.
+| <span class="cmd">[[C/up|UP]]</span><br />Grant yourself (Half)Op status.
+|-
+| <span class="cmd">[[C/devoice|DEVOICE]]</span><br />Remove Voice status from user(s).
+| <span class="cmd">[[C/kickban|KICKBAN]]</span><br />Kick + Ban user(s) from channel.
+| <span class="cmd">[[C/set|SET]]</span><br />Change various channel settings.
+| <span class="cmd">[[C/upall|UPALL]]</span><br /> Grant yourself (Half)Op/Voice status in all channels.
+|-
+| <span class="cmd">[[C/down|DOWN]]</span><br />Remove (Half)Op/Voice status from yourself.
+| <span class="cmd">[[C/mode|MODE]]</span><br />Manipulate channel's mode settings.
+| <span class="cmd">[[C/topic|TOPIC]]</span><br />Set (or restore) the channel's topic.
+| <span class="cmd">[[C/voice|VOICE]]</span><br />Grant user voice status (+v)
+|-
+| <span class="cmd">[[C/downall|DOWNALL]]</span><br />Remove (Half)Op/Voice status in all channels.
+| <span class="cmd">[[C/note|NOTE]]</span><br />Set a channel note.
+| <span class="cmd">[[C/unban|UNBAN]]</span><br />Remove entries from channel ban list.
+|
+|-
+|}
-'''Example:''' <code>/ChanServ UNREGISTER #zoo</code>
+==Quote Database Management Commands==
+{| class="srvcscmd" width="100%" style="font-size: 90%;"
+|-
+| style="width: 310px;"|<span class="cmd">[[ChanServ/addquote|ADDQUOTE]]</span><br />Add a quote.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/delquote|DELQUOTE]]</span><br />Delete a quote.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/quote|QUOTE]]</span><br />View a quote, or search quote database.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/qvote|QVOTE]]</span><br />Rate a quote.
+|-
+|}
-This is the initial command you'd use, after which ChanServ will send you something like this:
+==Informative / Miscellaneous Commands==
+{| class="srvcscmd" width="100%" style="font-size: 90%;"
+|-
+| style="width: 310px;"|<span class="cmd">[[ChanServ/command|COMMAND]]</span><br />View some misc. info about a command.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/info|INFO]]</span><br />View channel's registration record.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/levels|LEVELS]]</span><br />List numerical equivalents for named access levels.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/staff|STAFF]]</span><br />List all network staff (opers+helpers) currently online.
+|-
+| <span class="cmd">[[ChanServ/helpers|HELPERS]]</span><br />List support helpers currently online.
+| <span class="cmd">[[ChanServ/ircops|IRCOPS]]</span><br />List IRC operators currently online.
+| <span class="cmd">[[ChanServ/peek|PEEK]]</span><br />View information on a channel's modes, topic and member list.
+| <span class="cmd">[[ChanServ/version|VERSION]]</span><br />View version information about C.
+|-
+|}
-<pre>-ChanServ- To confirm this unregistration, you must use 'unregister #zoo 94c1bcc2'.</pre>
+==Toys==
+{| class="srvcscmd" width="100%" style="font-size: 90%;"
+|-
+| style="width: 310px;"|<span class="cmd">[[ChanServ/8ball|8BALL]]</span><br />Ask the magic 8ball a question.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/fml|FML]]</span><br />Get a random quote from [http://www.fmylife.com www.fmylife.com].
+| style="width: 310px;"|<span class="cmd">[[ChanServ/inspire|INSPIRE]]</span><br />Get a random inspirational quote.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/pastebin|PASTEBIN]]</span><br />Paste text to [http://pastebin.com pastebin.com].
+|-
+| style="width: 310px;"|<span class="cmd">[[ChanServ/calc|CALC]]</span><br />Calculate a mathematical expression.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/google|GOOGLE]]</span><br />Search [http://www.google.com Google].
+| style="width: 310px;"|<span class="cmd">[[ChanServ/isgd|ISGD]]</span><br />Expands or shortens url for [http://is.gd is.gd].
+| style="width: 310px;"|<span class="cmd">[[ChanServ/twitter|TWITTER]]</span><br />View tweets via IRC.
+|-
+| style="width: 310px;"|<span class="cmd">[[ChanServ/dice|DICE]]</span><br />Roll the dice.
+| style="width: 310px;"|<span class="cmd">[[ChanServ/guess|GUESS]]</span><br />Guess the number (between 1 and 100).
+| style="width: 310px;"|<span class="cmd">[[ChanServ/isitdown|ISITDOWN]]</span><br />Check whether a site is reachable (up) or not (down).
+| style="width: 310px;"|<span class="cmd">[[ChanServ/weather|WEATHER]]</span><br />Get weather conditions for a location.
+|-
+|}
-After that, I would type the command <code>/ChanServ UNREGISTER #zoo 94c1bcc2</code> to finalize if I was sure.
+[[Category:All]] [[Category:IRC Services]]