Text Commands

  1. Login as room admin

  2. Login as "hidden" room admin

  3. Login as room admin on top and in exclusive color

  4. Check room status

  5. Change Topic

  6. Expel/Ban Users

  7. Open or Close chat room

  8. Log/Get transcript of chat session

  9. Refresh/Update room configuration file

  10. Setting room password

  11. Room Moderation

  12. Paging room operator/administrator

  13. Push sounds into the chat room

  14. List of commands

 

 

 


 

1. Login to your chat room with your admin username and password for the admin for that room.

 

Once you log in you will see the message

 

"You have room administration powers"

 

 HINT: you will get this message after you are completely logged in and after all other login messages. You can use room admin commands only when logged in as a room admin

 


 

 

2. Login as "Hidden" Room Admin

 

Use the username and password issued to you when you ordered your room. If you would like to log in as a "Hidden" or "Lurking" admin user, add 2 underscore characters to the beginning or your admin name.

 

Example: __myadminname

 

Once you log in you will see the message

 

"You have room administration powers"

 

Your admin user name will not appear in the users list and will not be added to the room user count.

 

 HINT: you will get this message after you are completely logged in and after all other login messages. You can use room admin commands only when logged in as a room admin

 


 

3. Login as room admin on top and in exclusive color

 

You will need to add a double period before the admin username, but your password will remain the same.

 

Example: ..admin

 

Once you log in you will see the message

 

"You have room administration powers"

 

While you are logged into your room your admin user name will be displayed at the top of the user list in a unique color.

 

 HINT:  you will get this message after you are completely logged in and after all other login messages. You can use room admin commands only when logged in as a room admin.

 


 

4. Check room status

 

Use the following command typed into the text box at the bottom of the chat window.

 

%status

 

When you run the "%status" command it will give you a list of current room settings:

 

 


 

5. Change topic for your room

 

Use the following command typed into the usual type in text box at the bottom of the chat window.

 

/topic <your new topic text>

 

Example: to change topic to "Discussion on Foo's widgets" you would use the command

 

/topic Discussion on Foo's widgets

 


 

6. To expel those annoying users, use the /expel command

 

6.1 To get a help message on the syntax type:

 

/expel

 

6.2 To expel a user from the chat room for that session type:

 

/expel <username>

 

Example: to expel the user BadFooUser

 

/expel BadFooUser

 

This just expels them at that time but they can log back in with the same or another username so it is only effective in some cases.

 

6.3 To expel a user permanently from the IP address/ computer they are using, type:

 

/expel <username> banip

 

Example: to ban BadFooUser's computer so he/she can never log in using that computer IP address

 

/expel BadFooUser banip

 

This will not let them log back in with any username from the same computer/IP address. They could of course log back in from another computer/IP address (e.g dynamic IP address)

 

6.4 To expel all users from a particular ISP

 

/expel <username> banc

 

Example: to ban all IP addresses from BadFooUser's ISP

 

/expel BadFooUser banc

 

This would ban all users logging in from any IP address in the entire class C of IP addresses belonging to the user's ISP. This is more extreme and could be used to prevent all users from a particular ISP from logging in.

 

6.5 To expel users even when they are not logged in.

 

Example: if you receive complaints about offending users from someone and the user is not logged in (when you enter the room or they log off when you enter the room) you can use.

 

/expel _ip <IPaddress>

 

Example: to ban an IP address 192.168.1.10

 

/expel _ip 192.168.1.10

 

 HINT: To un-ban someone, please use the Web-based admin interface to edit room profile information and remove the banned IP addresses.

 

HINT: Do not ban your own IP address or you will no longer be able to log back into the room as Room Admin!

When an IP address is banned users logging in from that IP address get the following message

 

"You are connecting from an IP address that has been banned from usage of this room...."

 

 


 

7. Open and Close Chat Room

 

For those of you who would like to control when your chat room is used, e.g if you want it used only for scheduled chats or when you as the Admin is logged in, you can Open or Close your chat room for visitors. When the room is Closed, visitors cannot enter your chat room. You as the Admin can enter the room at any time.

 

7.1 Close your chat room by

 

/room close <message>

 

where <message> is the message you want your visitors to see when they visit your room when it is closed.

 

Example: /room close Next chat will be at 8.00pm E.S.T

 

Then a visitor trying to connect to your room during the time it is closed will see the message

 

Next chat will be at 8.00pm E.S.T

 

7.2 Open your room by

 

/room open

 

 

 


 

 

8. Log/ get transcript of your chat session.

 

The room admin command allows you to turn logging on (start recording of chat session) and logging off (stop recording chat session). This creates a log file within the server directory which can be retrieved as a HTML file via your browser.

 

8.1 To start the logging

 

/room log on <filename>

 

8.2 To stop the logging

 

/room log off

 

To prevent unchecked logging, logging is turned off automatically when the room admin logs off or gets disconnected from the chat room. To continue logging, log back in as the room admin and reenter the /room log <filename> command. Using the same filename appends to the file.

 

8.3 To display a list of available room transcripts

 

/room log list

 

8.4 To start auto transcripts

 

/room log auto

 

8.5 To stop auto transcripts

 

/room log stopauto

 

To enable the auto logging feature, you can use the Web-based room admin pages.

 

 


 

9. Refresh / Update room configuration file

 

The room reread command should be executed manually as a room admin command whenever you manually update the room profile file.

 

/room reread

 

 

 


 

 

10. Room password

 

The room password command allows you to set a password for the entire room, so users can pick any username but need to enter this password to enter the room. Room admins do not need to enter their room password (they would of course enter their own room admin account password to enter the room)

 

10.1 To set a room password or to change it

 

/room password <password>

 

Example:

 

/room password secretword

 

(This changes the room password to 'secretword')

 

10.2 To remove a room password

 

/room nopassword

 

 

 


 

 

11. Room Moderation

 

By default all rooms are un-moderated rooms and so anyone can speak at any time and be heard/seen by others.

You can also put the room in a moderated mode where only some designated speakers can speak and others can only listen.

 

This is done by using the command:

 

/room moderate <No speak message>

 

<No speak message> is the message that users who cannot speak see when they try to speak - it is an optional parameter.

 

Example:

 

/room moderate

 

The room is moderated, you do not have speaking privileges,to submit a question click on the submit question link below.

 

So if Bill tries to speak when he is not a designated speaker he will see the message

"The room is moderated, you do not have speaking privileges,to submit a question click on the submit question link below."

 

When the room is in moderated mode, the room administrator and any super users on the chat server can always speak. In addition , you can add other speakers to the room by the following command:

 

/room addspeakers <list of usernames separated by spaces>

 

Example:

 

/room addspeakers Joe Linda Kaina Bob

 

You can choose to delete from the list of speakers by using the command:

 

/room delspeakers <list of usernames separated by spaces>

 

Example:

 

/room delspeakers Linda Bob

 

(Now Linda and Bob cannot speak.)

 

If you want to place the room back in the unmoderated mode you can use the command:

 

/room nomoderate

 

 

 


 

 

12. Paging room operator/administrator

 

In cases where the Private messages have been turned off (e.g in a customer support / classroom situation) the user can still initiate a private conversation to the Room administrator or someone designated by the room administrator to be the 'Page Target'. The user can initiate this request by using the command:

 

%page

 

This will cause a request to be sent and if the 'Page Target' is logged in, a private chat window is opened for the conversation.

 

If the Page Target is not logged in, the user gets a message saying so.

 

By default the Page Target is determined automatically by searching the list of room admins to see if any one is logged in and can respond to the page.

 

/room pagetarget [-save] [<username> | auto]

 

-save :

 

(Optional parameter) Page target information can be saved to file if the -save option is used. Else it will be set for only the session

 

[<username> | auto]

 

Enter either the username that is designated as the Page Target or set it to 'auto' so that it automatically looks for any room admin that is logged in and sets it to be the Page Target.

 

Example:

 

/room pagetarget -save auto

 

Always uses any room admin logged in as the Page Target - i.e to respond to the %page command from a user.

 

Example:

 

/room pagetarget Joe

 

Sets Joe to respond to pages, i.e be the Page Target for the current chat session only, when everyone logs off the room, Joe will not be set as Page Target and the Page Target will revert to the room admin.

 

 

 


 

 

13. Push sounds into the chat room

 

To push a sound to the entire toom use the following command:

 

%sound <audiofile.au>

 

Example: to push the sound "ding" into the chat room, you would use the following command

 

%sound ding.au

 

 

 


 

 

14. List of commands

 

While you are logged in your room you can see a list of commands. To see a list of available commands, please type one of the following:

 

%help

/room