CHAN

Usage: CHAN <room> <command> [<parameter>]

The chan command is used in conjunction with the bot command to place server bots into rooms. The chan commands can also be set to greet everyone who enters the room. The online editing functions are identical to those in the client motd command set. The chan functions allow you to work with static rooms.

ADD - Add a room to be managed by a server bot.

BOT - Stop a room from being managed by any server bots.

DEL - Stop a room from being managed by any server bots.

FLASH - Send a Channel NewsFlash.


GREETING - Set a welcoming message for a room.

LIST - List the current settings for a room.

LOG - Turn on room logging.

MESSAGE - Have the bot send a channel message.

NOTICE - Have the bot send a channel notice.

OPNOTICE - Have the bot send a notice to all operators.

SET - Set additional room information.

Examples:
 
/as help chan <command>

You can use these commands to manage rooms without services or to make your rooms look nicer. The bot can be used to inform people of the room's rules or of information that they might join to learn. You can also use the chan commands in conjunction with a bot to force all web chat users who enter the room to go to a particular web site. See CHAN SET JOINFURL for more information.

Usage: CHAN <room> ADD

This command adds a room to the list of official rooms to be managed. You will still need to specify a bot to manage the room.

Example:

/as chan #conferencerooms add
This is the first step to take when you want to have a room managed by a server bot.

Usage: CHAN <room> BOT ADD|DEL|EMPTY|LIST [<bot>]

These commands allow you to add or delete multiple bots from the same server to a room. This is different from SET BOT, which will allow you to set one bot to manage the room. 

ADD - Add a bot to the room

DEL - Remove a bot from a room

EMPTY - Remove all bots from the room

LIST - List which bots are assigned to the room

Example:

/as help chan bot <topic>

One bot per room is generally sufficient. But you might have reasons to add multiple bots. For example, you might have one particular bot that sits in an entire set of similar rooms, such as all the public rooms that provide help. Then if someone needed a list of those rooms they could /whois the bot.

Usage: CHAN <room> BOT ADD <bot>

This will assign a bot to the room. You should create the bot using the AdminServ BOT commands.

Example:

/as chan #Chat bot add MrBot

You can add a bot that does not exist. Then whenever you make a bot by that name it will join the rooms you have already assigned it to.

Usage: CHAN <room> BOT DEL <bot>

This command removes the bot from the room. It does not delete the bot or affect other rooms the bot may be in.

Example:

/as chan #Chat bot del MrBot

This command can be useful if you are reorganizing your bots or simply do not wish to have as many in one room.

Usage: CHAN <room> BOT EMPTY

This will remove from the room all of the bots that were added with the CHAN BOT commands.

Example:

/as chan #Chat bot empty

If you added a bot using the CHAN SET BOT command then that bot will still remain assigned to the room.

Usage: CHAN <room> BOT LIST

This will list all of the bots assigned to the room. The bot assigned to the room using CHAN BOT SET will be listed as the primary bot for the room. All of the other bots will be listed afterwards.

Example:

/as chan #Chat bot list

Usage: CHAN <room> DEL

This removes a room from the list of officially managed rooms.

Example:

/as chan #conferencerooms del

If you have services this will not effect a room's registration in any way.

Usage: CHAN <room> FLASH 

This will send a newsflash message to everyone who is +n and in the room.

Example:

/as chan #ConferenceRooms flash 

This can be particularly useful if you are holding an event or a presentation in a room. You may wish to send relevant news related to that, but you would not want to inform the entire network.

Usage: CHAN <room> GREETING <command> [<value>]

This command allows you to make a welcoming message for users as they enter the room. The way you configure a greeting message is the same way you make your MOTD or create scripts. The del function will delete a specific line; use the list function to find out which line you wish to delete. The message will be delivered by whichever server bot is managing the room.

APPEND - Add a line to a greeting.

DEL - Delete a greeting line.

ERASE - Erase your entire greeting message.

INSERT - Insert a line above the line mentioned.

LIST - List the greeting.

Examples:
 
/as help chan greeting <command>

It is generally a good idea not to let the greeting become too large, since it will be sent to someone every time they enter. If they enter often or if the server they are on splits and then rejoins, they will be sent it multiple times, and long messages become annoying. There is no way to enter the room and avoid the message. Use it for important information or for a short greeting.

Usage: CHAN <room> GREETING APPEND <text>

This adds a line to the automatic greeting sent to users upon joining the room.

Example:

/as chan #conferencerooms greeting append Welcome to #ConferenceRooms, the official CR room.

This is the way to set up a message. If you make no mistakes you will only need to append lines in the order you want them to appear.

Usage: CHAN <room> GREETING DEL <number>

This deletes the specified line from the greeting message.

Example:

/as chan #conferencerooms greeting del 1

This allows you to remove any line from a greeting that you wish to replace or delete. To wipe the entire message see CHAN GREETING ERASE.

Usage: CHAN <room> GREETING ERASE

This command will delete the entire greeting message.

Example:

/as chan #conferencerooms greeting erase

This allows you to start over creating a new message or stop having an automatic greeting message.

Usage: CHAN <room> GREETING INSERT <number>

This command will add a line to the room's greeting message above whichever line is specified.

Example:

/as chan #conferencerooms insert 1 This is the new first line of the greeting.

This allows you to add lines in any section of the greeting so that you do not need to erase the entire greeting just to add a line above a current one. Append allows you to add a line to the end of the message.

Usage: CHAN <room> GREETING LIST

This command displays the entire greeting message for a room along with the line numbers associated with each line.

Example:

/as chan #conferencerooms greeting list

This should be used to check line numbers before inserting lines into the greeting. It is important to make sure you have your line numbers correct or you will end up with your text out of order.

Usage: CHAN <room> LIST

This command will display all the settings you have specified for the room.

Example:

/as chan #conferencerooms list

This is a quick and easy way to check everything related to how a room is set up.

Usage: CHAN <room> LOG <[on|off]|[param]>

These commands allow your primary room bot to log the conversation in the room to a file that you specify. You must have a bot in the room to do the logging.

OFF - Turn off logging

ON - Turn on logging

PARAM - Set the file to log to

Examples:

/as help chan log <topic>

Usage: CHAN <room> LOG OFF

Turns off logging for the room.

Example:

/as chan #chat log off

This is useful if you only want to log the room at certain times. You could even script turning on and off logging for a room and link it to events to be run at particular times. That would allow you to automatically log the room only during the hours you wish.

Usage: CHAN <room> LOG ON <filename> [directory|file]

This will turn logging on for a room. The room will log to the file you set with the PARAM command. You must have a bot in the room to do the logging.

Example:

/as chan #chat log on

This is an easy way to keep records of all the activity in a room. The bot will log everything it sees in the room, which means so long as there are no splits all conversation in the room will be logged.

Usage: CHAN <room> LOG PARAM|<param value>|<param>

Allows you to add a parameter and value that will be added into a channel log. This should match a preset variable in the file. You can list the params with the keyword param and you can erase a param when you just put in the variable name without the value and that value will be deleted.

Example:

/as chan #help log param LoggedBy John Doe

/as chan #help log param LoggedBy

/as chan #help log param

Nice for adding specific event information into a channel log from the web interface.

Usage: CHAN <room> MESSAGE <text>

This will cause the primary room bot to send a message to the room. It will look like the bot is speaking to the room just as any other user would.

Example:

/as chan #chat message Hello, I'm a bot.

While this can be a fun way to liven up a room, talking bots are cute, you might want to be careful not to use this too often. When people see bots speak intelligently they may get confused about what a bot is and expect it to be able to speak like a person in general.

Usage: CHAN <room> NOTICE <text>

This command will send a notice to everyone in the room. It will appear as if the primary room bot has sent a notice to the room.

Example:

/as chan #chat notice This room is for fun clean chat.

Since people don't expect to see room notices as often and rarely use them, this can be a less confusing way than CHAN MESSAGE to let the bot send the occasional text to a room. But as with messages if you send too many through the bot you may confuse the people in the room.

Usage: CHAN <room> OPNOTICE <text>

This command will send a notice to all of the room operators in the room. It will appear as if the primary room bot sent an opnotice.

Example:

/as chan #chat opnotice Watch that user carefully, he has caused problems before.

There isn't much reason to send opnotices through the bot, but it can be useful in certain situations. If you really want to send an anonymous opnotice, then you can. However, even if you are not opped in the room you can still send an opnotice by using /notice @<room> . But you can also script the bot to send an opnotice before running some other portion of a script. So if something is about to change in the room, the room operators are warned.

Usage: CHAN <room> SET <value>

This command will define settings for the specified room. Since the server bot works in conjunction with the chan commands, your server bot will keep your room's topic and modes if you configure the server bot to do so. 

ADMINPASS - Set a Zone password.

BOT - Define which bot to use.


MODE - Set the default room modes.


PASSWORD - Set the room's password.

TOPIC - Set the default topic.

Example:

/as help chan set <command>

The bot will set the topic or mode each time the server restarts. If the modes conflict with a modelock set for the room, the bot will override the modelock. You can also use the bot to set a specific key or limit, which you cannot do with a modelock. 
Normally you should not set a mode that conflicts with the modelock, but you might wish to do it with l or k. This would allow you to have a set key that should be kept set, yet if anyone tries to change the key, services will not let them to set a new key. 
This means that the room will always either have the key that you set or it will not have a key. But it will not be keyed to prevent people who should be able to join from joining. You will generally want to use a topiclock if you want a specific topic.

Usage: CHAN <room> SET ADMINPASS <password>

If the channel is part of a defined zone then this password will give the user access to the entire zone that the channel is at root of. As an example if you have a zone define for #music.* then you can define a bot for the root channel and set the admin password for the channel. Then when identifying to the channel you can then get administrative access to all the channels in that zone. If the defined channel is not part of a zone then the password will give you access to the same functions that the password does.

Example:

/as chan #conferencerooms set adminpass MyPassword

For more information about zones please see the following file: Zones and Virtual Hosting

Usage: CHAN <room> SET BOT <botname>

This command specifies which bot will manage the room. It must be set before any of the other settings will take effect since the bot manages the room and enforces the settings.

Example:

/as chan #conferencerooms set bot SupportBot

A single bot can manage several rooms. You might want to use multiple bots if you want to manage a very large number of rooms using server bots and to give different people access to several but not all of the rooms. Then you can group the rooms based on which people may have access to which and give out the bot's password to them. 
This would minimize the number of passwords people need to remember. Since anyone with the bot's password can be opped in all the rooms the bot manages, you'd want to be sure that the rooms it is in are all intended to give ops to the same people.

Usage: CHAN <room> SET MODE +<modes>

Set the initial modes for the room. The bot will then continue to enforce the last mode settings that the room was set to.

Example:

/as chan #conferencerooms set mode +nt

Room operators can change the room's modes and then the bot will enforce the new modes. This is primarily a way to have the room reform with the same modes if the server has to restart.

Usage: CHAN <room> SET PASSWORD <text>

This command sets the password for the room as opposed to the password for the bot itself. See BOT SET PASSWORD to set the bot's password.

Example:

/as chan #conferencerooms set password s3cUr3pa55

Anyone who knows this password will be able to get opped in the room, but only in that specific room.

Usage: CHAN <room> SET TOPIC <topic>

This will cause the bot to remember the last topic and reset it if the server restarts.

Example:

/as chan #conferencerooms set topic For help with CR

This command will set a topic that will be saved accross restarts.