WebChat Commands & Properties - User Guide - Part 2
Channel Commands & Properties Index:
COMMANDS: ACCESS - ACL - AKICK - ATTACH - AUTH - BAN - CK - CLONEKICK - DEOP - DETACH - DEVOICE - INFO - INVITE - JOIN - KICK - OP - PART - TOPIC - TRANSFER - UNBAN - VOICE
PROPERTIES: AUDIT - AGECHECK - AUTOVOICE - DESC - FOUNDER - JOINMUTE - JOINPERSEC - KEY - LANGUAGE - LIMIT - MEMOLEVEL - MODELOCK - OPGUARD - POLICY - RATING - REJOINTRACK - RESTRICT - TOPIC - TOPICLOCK - URL - USERMSGSPERSEC - USERSPERIP
Channel Commands:
ACCESS
This command allows you to manage and view the channels access lists and history. Valid levels of channel access are UOP, VOP, AOP, SOP, and MGR.
Viewing recent access history:
This command will show you recent access history in the channel, such as who has had access, why they had access and when they had access. Similar to how the WHY command worked.
Command: /ACCESS #channel
Example: /ACCESS #ChatShack
Viewing access lists:
Valid levels of access are UOP, VOP, AOP, SOP, and MGR. This will show you who has access on the specified level.
Command: /ACCESS #channel <access-level> list
Example 1: /ACCESS #ChatShack AOP list
Example 2: /ACCESS #ChatShack MGR list
Adding users to access lists:
This command will allow you to add users to the specified access list. You must be SOP or above to add UOPs VOPs and AOPs. You must be MGR or above to add SOPs and MGRs.
Command: /ACCESS #channel <access-level> add <nickname>
Example 1: /ACCESS #ChatShack AOP add JoeBloggs
Example 2: /ACCESS #ChatShack MGR add JoeBloggs
Deleting users from access lists:
This command will allow you to delete users from the specified access list. You must be SOP or above to delete UOPs VOPs and AOPs. You must be MGR or above to delete SOPs and MGRs.
Command: /ACCESS #channel <access-level> del <nickname>
Example 1: /ACCESS #ChatShack AOP del JoeBloggs
Example 2: /ACCESS #ChatShack MGR del JoeBloggs
Wiping access lists:
This command will 'wipe' all entries on the specified access list.
Command: /ACCESS #channel <access-level> wipe
Example: /ACCESS #ChatShack AOP wipe
Counting access lists:
This command will display how many UOPs, VOPs, AOPs, SOPs, MGRs and AKICKs the channel has, and also states how many it is possible to have. For example; "Manager: 4/100" means the channel has 4 managers in place, but can hold up to 100 managers in total.
Command: /ACCESS #channel count
Example: /ACCESS #ChatShack count
Disable a users access:
This command allows you to 'disable' a users specified access level. Although the user will still appear on the access list, they will not be able to use their access again until it is enabled.
Command: /ACCESS #channel <access-level> disable <nickname>
Example 1: /ACCESS #ChatShack AOP disable JoeBloggs
Example 2: /ACCESS #ChatShack UOP disable JoeBloggs
Enable a users access:
This command allows you to 'enable' a users specified access level. Once their access is enabled they will be able to use their access again.
Command: /ACCESS #channel <access-level> enable <nickname>
Example 1: /ACCESS #ChatShack AOP enable JoeBloggs
Example 2: /ACCESS #ChatShack UOP enable JoeBloggs
ACL
This command is exactly the same as the ACCESS command (above), instead of using /ACCESS you can just use /ACL as the command prefix. You cannot view channel access history using ACL.
AKICK
With this command you can control the channels AKICK list. AKICKs are enforced by the server the moment a user matching an AKICK list entry joins the channel. The user will be kicked and the mask will be banned.
Viewing AKICK list:
This will show all of the channels AKICKS.
Command: /AKICK #channel list
Example: /AKICK #ChatShack list
Adding an AKICK:
Will allow you to add an AKICK against the specified mask with or without a descriptive reason.
Command: /AKICK #channel add <mask> <reason>
Example 1: /AKICK #ChatShack add *!*@*.asianet.co.th Mass advertising and flooding.
Example 2: /AKICK #ChatShack add JoeBloggs!*@* Not welcome due to cloning.
Deleting an AKICK:
Will allow you to delete a specified AKICK.
Command: /AKICK #channel del <mask>
Example 1: /AKICK #ChatShack del *!*@*.asianet.co.th
Example 2: /AKICK #ChatShack del JoeBloggs!*@*
Wiping the AKICK list:
Will allow you to wipe all entries in the AKICK list.
Command: /AKICK #channel wipe
Example: /AKICK #ChatShack wipe
ATTACH
This command replaces REGISTER. You can 'register' (attach) a channel to your nickname. You will notice you do not need to set a channel password, this is because the channel is 'attached' to your registered nickname. Once you identify to your registered nickname you have access to all your channel settings.
Command: /ATTACH #channel <channel-description>
Example: /ATTACH #ChatShack My fun chat channel for everyone!
AUTH
This command allows you to manage and view pending channel requests. Pending channel AUTHS are basically when you have tried to add someone to your channels access list and are waiting for them to confirm if they accept or decline your offer.
Viewing pending channel AUTHS:
Will show you a list of pending channel auths.
Command: /AUTH #channel list
Example: /AUTH #ChatShack list
Deleting pending channel AUTHS:
Will delete any pending channel auths.
Command: /AUTH #channel del <auth-number>
Example: /AUTH #ChatShack del 1
Wiping pending channel auths:
Will wipe all pending channel auth entries.
Command: /AUTH #channel wipe
Example: /AUTH #ChatShack wipe
BAN
This command allows you to place a channel ban on a specific nickname or mask.
Banning a nickname:
Command: /BAN <nickname>
Example: /BAN JoeBloggs
Banning a mask:
Command: /BAN #channel <mask>
Example 1: /BAN #ChatShack *!*@*.revip2.asianet.co.th
Example 2: /BAN #ChatShack JoeBloggs!*@*
CK
This 'Clone Kick' will kick all unregistered users from a channel. It will also set CMODEs +J and +R to only allow Java users and registered users back into the channel. These modes do not automatically unset, a channel operator must unset these modes if they wish to.
Command: /CK #channel
Example: /CK #ChatShack
CLONEKICK
This command is exactly the same as CK (above), instead of using /CK you would use /CLONEKICK as the command prefix.
DEOP
This will deop a user or yourself in a channel. You need to have AOP or higher access in the channel to use this command. If no nick is given, it works on yourself. It's particularly useful if you are not opped but need to deop someone else.
Command: /DEOP #channel <nickname>
Example: /DEOP #ChatShack JoeBloggs
DETACH
This command will allow you to drop your registered channel. To complete the detach a VID is sent to your e-mail address on record, you must enter the VID in order for the channel to detach (drop) successfully.
Command: /DETACH #channel
Example: /DETACH #ChatShack
DEVOICE
This will devoice a user or yourself in a channel. You need to have AOP or higher access in the channel to use this command on other nicks and VOP access to use it on yourself. If no nick is given, it works on yourself. It's particularly useful if you are not opped but need to devoice someone else or yourself quickly.
Command: /DEVOICE #channel <nickname>
Example: /DEVOICE #ChatShack JoeBloggs
INFO
Displays various pieces of information on a registered channel, such as channel description, founder, date of registration, current topic, and more.
Command: /INFO #channel
Example: /INFO #ChatShack
INVITE
This command is used to invite yourself or other people to join a channel. If the channel is set to invite only (cmode +i) the invite will override the mode allowing you or the invited user to join. You must hold access in the channel to invite yourself into it. You must also hold channel access to invite others into the channel.
Inviting yourself into a channel you hold access in:
Command: /INVITE #channel
Example: /INVITE #ChatShack
Inviting others into a channel:
Command: /INVITE <nickname> #channel
Example: /INVITE JoeBloggs #ChatShack
JOIN
This command allows you to join a channel.
Command: /JOIN #channel
Example: /JOIN #ChatShack
KICK
This command will kick a specified user, or more, from the channel. You can specify individual nicknames to kick, user hosts to kick and use wildcards to kick more than one users at a time, or the whole channel at once. You can also specify a reason for the kick, the reason is optional and does not have to be used if you don't wish to.
Kicking a user:
Will kick an individual user.
Command: /KICK #channel <nickname> <reason>
Example: /KICK #ChatShack JoeBloggs Foul language
Kicking a host:
Will kick all users under the specified host.
Command: /KICK #channel <host-mask> <reason>
Example: /KICK #ChatShack *!*@*.revip2.asianet.co.th Flooding!
Kicking more than one user using a wildcard mask:
Will kick all users that have part of the specified kick mask in their nickname. * is the wildcard character. If you were to kick Guest* this would mean all users that have the nickname Guest(and anything after it) such as Guestyehr Guest563849 Guestie, will all be kicked. If you were to kick *mark this would mean all users who have the nickname (anything)mark, such as Markymark CAmark Remark will all be kicked.
Command: /KICK #channel <wildcard-mask> <reason>
Example: /KICK #ChatShack Guest* We don't like Guests
Kicking the whole channel:
This replaces MKICK. When you enter this command everyone inside the channel will be kicked. Including yourself.
Command: /KICK #channel *
Example: /KICK #ChatShack *
OP
This will op yourself or a user in a channel. You need to have AOP or higher access in the channel to use this command. If no nick is specified, it will op yourself. It's particularly useful if you are not opped but need to quickly op someone else or yourself.
Command: /OP #channel <nickname>
Example: /OP #ChatShack JoeBloggs
PART
The part command allows you to leave a channel.
Command: /PART #channel
Example: /PART #ChatShack
TOPIC
The TOPIC command lets you change the topic of a channel. Anyone can change this unless the TOPICLOCK is set to a particular level.
Command: /TOPIC #channel <topic>
Example: /TOPIC #ChatShack Welcome to ChatShack, enjoy your stay!
TRANSFER
The TRANSFER command allows you to transfer channel ownership to another nick. You must be founder of the channel and the specified nick must be registered. The specified nick will receive a memo with instructions to complete the transfer. If the specified nickname does not accept channel transfers or does not wish to take channel ownership, the command will not be successful and you will remain the founder.
Command: /TRANSFER #channel <nickname>
Example: /TRANSFER #ChatShack JoeBloggs
UNBAN
The UNBAN command is a convenient and fast way to clear the entire ban list of a channel. It can also be used to unban yourself from channels you have access in, as you can remove the bans from outside and then join.
Unbanning yourself from channels you have access in:
Command: /UNBAN #channel
Example: /UNBAN #ChatShack
Clearing full ban list:
You must have a high level of access to perform this command.
Command: /UNBAN #channel *
Example: /UNBAN #ChatShack *
VOICE
This will voice a user or yourself in a channel. You need to have AOP or higher access in the channel to use this command on other users and VOP access to use it for yourself. If no nick is specified, it will voice yourself. It's particularly useful if you are not opped or voiced but need to voice someone else or yourself.
Command: /VOICE #channel <nickname>
Example: /VOICE #ChatShack JoeBloggs
Channel Properties:
AUDIT
The AUDIT property allows you to monitor all relevant changes to channel settings. If set to ON, every property change in the channel will cause the server to send a memo to all managers and the founder, which includes details about the op who changed the property and when. Default is OFF.
Setting AUDIT:
Command: /prop #channel AUDIT on
Example: /prop #ChatShack AUDIT on
Unsetting AUDIT:
Command: /prop #channel AUDIT off
Example: /prop #ChatShack AUDIT off
AGECHECK
If AGECHECK is set to ON, then all users need a non-zero age set in their AGE property in order to join. Default is OFF. Note, that this does not require or check a certain age, it only checks whether the property is set.
Setting AGECHECK:
Command: /prop #channel AGECHECK on
Example: /prop #ChatShack AGECHECK on
Unsetting AGECHECK:
Command: /prop #channel AGECHECK off
Example: /prop #Chatshack AGECHECK off
AUTOVOICE
If the AUTOVOICE property is set to ON, then every user joining the channel will be voiced by the server. Default is OFF.
Setting AUTOVOICE:
Command: /prop #channel AUTOVOICE on
Example: /prop #ChatShack AUTOVOICE on
Unsetting AUTOVOICE:
Command: /prop #channel AUTOVOICE off
Example: /prop #ChatShack AUTOVOICE off
DESC
The DESC property allows you to change the channels description which is shown in the channels /INFO.
Command: /prop #channel DESC <description>
Example: /prop #ChatShack DESC ChatShack is a cool chat room!
FOUNDER
The FOUNDER property is just like the /TRANSFER command, it allows you to change/transfer foundership of your channel to a specified nickname. You must be channel founder to do this and the specified nick must be registered. The specified nick will receive a memo with instructions to complete the transfer. If the specified nickname does not accept channel transfers or does not wish to take channel ownership, the command will not be successful and you will remain the founder.
Command: /prop #channel FOUNDER <nickname>
Example: /prop #ChatShack FOUNDER JoeBloggs
JOINMUTE
The JOINMUTE property lets you specify the number of seconds a user cannot speak in the channel upon joining it. The maximal value is 15 seconds.
Command: /prop #channel JOINMUTE <seconds>
Example: /prop #ChatShack JOINMUTE 5
JOINPERSEC
The JOINSPERSEC property lets you specify the number of joins you want to allow into your channel per second.
Command: /prop #channel JOINPERSEC <number-of-joins>
Example: /prop #ChatShack JOINPERSEC 5
KEY
The KEY property contains the key that is set for the channel, only users who know the key can then enter the channel using the key.
Setting KEY:
Command: /prop #channel KEY <key>
Example: /prop #ChatShack KEY frie43GGde3
Unsetting KEY:
Command: /uprop #channel KEY :
Example: /uprop #ChatShack KEY :
LANGUAGE
The LANGUAGE property allows you to set a preferred language for the channel. Similar to setting a preferred language on your nickname property. A list of language codes can be found at this website: http://www.w3.org/WAI/ER/IG/ert/iso639.htm (examples: en = English es = Spanish de = German fr=French).
Setting LANGUAGE:
Command: /prop #channel LANGUAGE <language-code>
Example: /prop #ChatShack LANGUAGE en
Unsetting LANGUAGE:
Command: /prop #channel LANGUAGE none
Example: /prop #ChatShack LANGUAGE none
LIMIT
The LIMIT property allows you to set a limit as to how many users can join the channel. For example, if you set your channel limit to 13, when you have 13 users in the channel no more users will be able to join. If they try to join they will be told the channel is full. You can always change your channel limit at any time. It is DEFAULT off.
Setting LIMIT:
Command: /prop #channel LIMIT <limit-number>
Example: /prop #ChatShack LIMIT 13
Unsetting LIMIT:
Command: /prop #channel LIMIT off
Example: /prop #ChatShack LIMIT off
MEMOLEVEL
The MEMOLEVEL property allows to specify what level of access is needed in a channel in order to send memos to all users on a certain access list of it. The available memo levels are UOP, VOP, AOP, SOP and MGR. The default is UOP.
Command: /prop #channel MEMOLEVEL <memo-level>
Example 1: /prop #ChatShack MEMOLEVEL AOP
Example 2: /prop #ChatShack MEMOLEVEL MGR
MODELOCK
The MODELOCK property lets you specify which channel modes you want to be 'locked' and always enforced by the server. If anyone tries to unset modes that are locked they will be automatically reset by the server.
Setting MODELOCK:
Command: /prop #channel MODELOCK <+modes>
Example: /prop #ChatShack MODELOCK +rtnRJ
Unsetting MODELOCK:
Command: /prop #channel MODELOCK <-modes>
Example: /prop #ChatShack MODELOCK -nRJ
OPGUARD
The OPGUARD property specifies whether a user has to be added to an access list in order to be made operator in the channel. If OPGUARD is OFF then any user can be opped without been on the access list. If OPGUARD is ON they have to be added to the access list in order to be opped.
Setting OPGUARD:
Command: /prop #channel OPGUARD on
Example: /prop #ChatShack OPGUARD on
Unsetting OPGUARD:
Command: /prop #channel OPGUARD off
Example: /prop #ChatShack OPGUARD off
POLICY
The POLICY property is either OPEN or CLOSED. An open POLICY means every user can add themselves to the channels UOP access list. This behaviour is intended for channels that offer a type of mailing list, it may send channel memos with updates and information, and all UOPs will receive those memos. An OPEN policy does not lower security in a channel, because AKICKs placed in OPEN channels can not be overridden by self-invitation from self-added UOPs. A closed POLICY does not allow any of this. Default is CLOSED.
Setting POLICY open:
Command: /prop #channel POLICY open
Example: /prop #ChatShack POLICY open
Setting POLICY closed:
Command: /prop #channel POLICY closed
Example: /prop #ChatShack POLICY closed
RATING
REJOINTRACK
The REJOINTRACK property lets you set the number of seconds a user must wait before he/she can rejoin the channel after parting it. The maximal value is 60 seconds.
Command: /prop #channel REJOINTRACK <number-of-second>
Example: /prop #ChatShack REJOINTRACK 8
RESTRICT
If RESTRICT is set to ON, then only users with channel access can join the channel, everybody else will get kicked and banned by the server on sight. Default is OFF.
Setting RESTRICT:
Command: /prop #channel RESTRICT on
Example: /prop #ChatShack RESTRICT on
Unsetting RESTRICT:
Command: /prop #channel RESTRICT off
Example: /prop #ChatShack RESTRICT off
TOPIC
The TOPIC property allows you to change the channels topic.
Command: /prop #channel TOPIC <new-topic>
Example: /prop #ChatShack TOPIC Welcome to the Shack!
TOPICLOCK
The TOPICLOCK property allows you to control who is allowed to change the channels topic. For instance, if set to AOP, then only users with AOP access or above can change the channels topic. The available access levels you can set are; UOP, VOP, AOP, SOP, MGR. The DEFAULT is OFF, meaning anyone can change the channel topic.
Setting TOPICLOCK:
Command: /prop #channel TOPICLOCK <access-level>
Example: /prop #ChatShack TOPICLOCK AOP
Unsetting TOPICLOCK:
Command: /prop #channel TOPICLOCK off
Example: /prop #ChatShack TOPICLOCK off
URL
The URL property allows you to add an URL that your channel is associated with.
Setting URL:
Command: /prop #channel URL <url>
Example: /prop #ChatShack URL www.oursite.org
Unsetting URL:
Command: /prop #channel URL none
Example: /prop #ChatShack URL none
USERMSGSPERSEC
The USERMSGSPERSEC property lets you set a maximum number of messages a user can send per second. DEFAULT is DISABLED.
Setting USERMSGSPERSEC:
Command: /prop #channel USERMSGSPERSEC <message-limit>
Example: /prop #ChatShack USERMSGSPERSEC 5
Unsetting USERMSGSPERSEC:
Command: /prop #channel USERMSGSPERSEC disabled
Example: /prop #ChatShack USERMSGSPERSEC disabled
USERSPERIP
The USERSPERIP property lets you set a maximum number of users that may share an IP in a channel. A value of 2 or 3 is usually a good setting. However, in the case of an event that attracts users from a certain cyber-cafe or net-cafe or a similar shared connection, you probably want to raise or disable this value. The DEFAULT setting is OFF.
Setting USERSPERIP:
Command: /prop #channel USERSPERIP <limit>
Example: /prop #ChatShack USERSPERIP 3
Unsetting USERSPERIP:
Command: /prop #channel USERSPERIP off
Example: /prop #ChatShack USERSPERIP off