AdminServ Enabled Scribe Commands
Adding the Scribe module will also enable additional Web Administration panels and in the Configuration utility an additional Scribe button enabling configuration utilities. (Figure.5). In the Configuration Utility an Expert mode option can be enabled or disabled upon your liking and familiarity with Scribe Configuration (Figure.6).
Figure.5
Figure.6
CHAN <channel> [log|message|[op]notice|furl|flash] [on/off] [<PARAM>][param] <value>
With your new key additional Chan commands are added. The new enabled commands will give you additional flexibility when it comes to using Script commands.
Chan <channel > log parameter <param_name> <parameter value>
The purpose of this command is to turn the option of logging on or off. When using this command you must have a server bot set for the channel. The server bot will act as the logging client. When adding a parameter it will send the logs to the file you have chosen to keep channel logs
Example: /as CHAN #ConferenceRoom LOG on
Example: /as CHAN #ConferenceRoom LOG on cr1.log
Chan <channel> message <text message>
This command will send a message by your server bot to the channel you have defined.
Example: /as Chan #ConferenceRoom message This is a test
Chan <#channel> [op]notice] <message>
This command will send a notice to the channel or to the channel ops in the channel.
Example: /as chan #ConferenceRoom notice This is a test
Example: /as chan #ConferenceRoom opnotice This is a test
Chan <#channel> furl <URL>[<target>]
This command will force all the java users in a specified channel to go to a specific URL or to load a specific URL in a specific frame.
Example: /as chan #ConferenceRoom furl http://my.page
Example: /as chan #web furl http://my.page/info#notes.htm
Chan <#channel> flash <message>
This command will send a channel newsflash to the users in the channel.
Example: /as chan #ConferenceRoom flash We now have a new release on our web site.
EVENT <name> [add|del|list|enable|disable|set|rename] <param>
The Event command set will allow you to set event’s to start or stop from Scripts you have set. Event works simultaneously with the Script Util and Log commands. Here are some examples of how to set up an Event. From the Configuration Utility click in the Scribe Event window (Figure.5).
Event <name> <add|del>
This command will add or delete an event. In the Web Administration panel the Event section will appear as show in Figure.7. In the Configuration Utility it will appear as shown in Figure.8.
Example: /as Event open add
Event <name> set time [begin|end]
The time parameter can be set on a 24 hour time clock, by day of the week, or by specifying a time with the a or p letter besides it to specify AM or PM. This command must always be set otherwise you will not be able to enable your event. To specify and an event in the Configuration utility the panel in Figure.8, will appear when selecting a time.
Example: /as Event open set time begin Monday 9:00a
Event <name> set interval [hourly|daily|weekly|monthly|none]
The interval setting will determine how many times your script will be in progress or not. You can have multiple events running at any given time.
Example: /as Event open set interval daily
Event <name> set script [start|end] <name>
An event can have a start script and a stop script. The start script is fired automatically when the event starts and the stop script is fired automatically when the event stops. An event with no stop time stops as soon as it starts. A log event needs to have a start or stop time. In this case, it starts when it is enabled and stops when it is disabled. A log event with just a start time starts at its start time and runs until it is disabled. A log event with just a stop time starts when it is enabled and stops at the set time.
Example: /as Event open set script start open
Event <name> <enable|disable>
This will allow you to enable or disable an event.
Example: /as Event open enable
Event <name> list
This command will give you the complete list of your settings for the event in question. You will be able to view the configurations you have set for the so-called event, the begin and end times, the interval etc.
Example: /as Event open list
For your convenience you can view an example of an event listing to better understand the purpose of this AdminServ command.
event open add
event open set interval daily
event open set script begin open
event open set script end nights
event open set time begin Feb 17, 1999 at 10:00
event open set time end Feb 17, 1999 at 17:00
event open enable
Figure.7
Figure.8
SCRIPT <name> [add|del|list|commands|enable|disable|set|rename]
The Script option allows you to create scripts based on the AdminServ commands. The examples below should help you to better understand the purpose of the Script option. If you double click in the Script section in the Configuration utility (Figure.5) The Script panel will be displayed (Figure.9). If you select Script from the tabs in the Web Administration panel the (Figure.10) will be displayed. It is where you add, delete and modify your scripts.
Script <name> <add|del>
This command will add or delete a new script.
Example: /as Script nights add
Script <name> commands [insert|del|erase|append|list] [<line_number>] <params>
In this part of Script you can append any AdminServ command. The commands part works a lot like the greeting messages in the Chan command, it uses the same logic. If you’re doing different greeting messages, make sure that you always delete the previous messages before appending a new one.
Example: /as Script nights commands append chan #ConferenceRoom greeting erase
Example: /as Script nights commands insert 2 chan #WebChat greeting Welcome to Webchat
Example: /as Script nights list
Script <name> <enable|disable>
This command will enable or disable a script
Example: /as Script open enable
Script <name> set access [ircop|sa|admin|@<channel>]
The access option in the Script command is to determine who can have access to a script command to be able to start it or end.
Example: /as Script nights set access admin
Script <name> set command <command>
This set command option will set a command that an operator or channel op would simply enter to start up a script. The person in question would just type in /open on their command prompts as described in the example below.
Example: /as Script set command open
Script <name> list
This command will list the entire settings of your script.
Example: /as script open list
Script <name> rename <new_name>
This command will rename a script.
Example: /as script open rename day
In the following example you will find a sample of a script that let’s users know that the technical support channel is currently open.
script open add
script open enable
script open set access admin
script open set command open
script open commands append chan #ConferenceRoom greeting erase
script open commands append chan #ConferenceRoom greeting append Our support channel is currently open. Please state your question in the channel and one of our support representatives will answer you.
script open commands append chan #ConferenceRoom greeting append You can download your ConferenceRoom upgrade at http://www.webmaster.com/update.htm . We will Not support ConferenceRoom versions prior to the one currently distributed.
script open commands append chan #ConferenceRoom greeting append If you would like to download the ConferenceRoom Manual please go to http://www.webmaster.com/doc.zip
script open commands append chan #ConferenceRoom greeting append If you do not receive an answer from our Support Staff please email mailto:support@webmaster.com
script open commands append chan #ConferenceRoom greeting append ConferenceRoom prices and Editions are available at http://www.webmaster.com
script open commands append bot SupportBot add
script open commands append chan #ConferenceRoom set bot SupportBot
Figure.9
Figure.10
UTIL [server|services|web|notice|flash]
The Util command sets are used to manage your server, services, web server and to send notices and news flash messages. When used simultaneously with a Script that calls on these commands, your server will execute the commands based upon the settings of the Util options.
Util server [rehash|restart|die]
This Util server command will rehash your server, restart the server or kill the server completely.
Example: /as util server rehash
Example: /as util server restart
Example: /as util server die
Util services [start|stop]
The services util command will allow you to start or stop ‘services’ Services by default have NickServ and ChanServ. Depending on your edition of ConferenceRoom and if you have additional services these could include OperServ and MemoServ.
Example: /as util services start
Util web [start|stop]
The web util command is used to start or stop your web server. The web server is your web administration panel and also your Java user access. If the web server is not running, Java users will not be able to connect on the server. Keep in mind that if you run another web server other than the one provided with ConferenceRoom, Java users will be able to log on the server.
Example: /as util web start
Util notice [locop|globop|server|network] <text here>
The UTIL Notice is used to send notices to all the /locops, /globops or to send a notice to the local users on the server or a global message to all the users on the network.
Example: /as util locop This is a local message to the ircops
Example: /as util global This is a message to the ircops on the network
Example: /as util server This message is for all users on this server.
Example: /as util network This message is for everyone on the network.
Util flash [local|network] <news flash>
The flash option is the same as sending a news flash message using /nflash to send to the entire network or /lflash to send to all the users on this particular server.
Example: /as util flash local ***Local NewsFlash Message***
Example: /as util flash network ***this is a global newsflash***
Note: Remember that the clients must be set +n to see a /newsflash. This can be set by changing the sign on modes.