Documentation Index
Alphabetic Index
XRPi Documentation - Commands
Chat Server Commands
Description
The following commands are available within the chat server only.
/? /ALERT /ANSI /BELL /BYE /CHANNEL /ECHO /EXIT /HEADERLN /HELP /JOIN /KEEPALIVE /KM /KNOWN /LEAVE /LINKS /MSG /NAME /NODES /PERSONAL /PORTS /QTH /QUIT /RM /STAMP /TOPIC /USER /VERBOSE /VERSION /WHO Commands are not case sensitive. They are shown in CAPITALS for clarity only.
Chat server commands in detail
/? - display commands / syntax help.
-
Syntax: /? [cmd]
When used without arguments, the /? command lists the available commands. The syntax for any of the commands thus listed may be shown by specifying the command as an argument to the /? command.
Examples: /? List available commands. /? /who Display syntax for the /WHO command. /ALERT - enable / disable channel join/leave alerts
-
Syntax: /A[lert] [ON | OFF] Examples: /A Reports current on / off state. /ALERT ON Turns alerts on.If ALERT is ON, the server sends you a notification every time someone joins or leaves the channel (room) you are in. This is the default setting.
/ANSI - enable / disable ansi colour
-
Syntax: /A[nsi] [on | off]
The /ANSI command is used to enable or disable the use of ANSI colour. In order to make use of this feature, callers must be using an ansi-compatible terminal. When enabled, each user's messages are shown in a different colour making it easier to follow threads of conversation.
Typing /ANSI by itself displays the current setting.
/BELL - display / set activity bell
-
Syntax: /BE[ll] [0-3]
The /BELL command controls which events are signalled by an audible warning. The warning consists of a bell character (ascii 7) within the text. In order to use this feature, your terminal software must respond to bell characters.
Arguments to the /BELL command are as follows:
0 No bells (default setting) 1 Informative messages from chat server only 2 Text entered by other chatters only 3 All events.
/BYE - exit the chat server.
-
Syntax: /B[ye]
The /BYE command, which may be shortened to /B, disconnects the user from the chat server, and informs everyone that he's left. There is no need for the user to /LEAVE any logged channels before issuing this command.
If the user accessed the server via the router's CHAT command, he will be returned to the router's main command prompt, otherwise he will be completely disconnected.
/CHANNEL - display / change logged channel(s).
-
Syntax: /C[hannel] [number] | DEFAULT [number]
The /CHANNEL command displays / changes the channel(s) the user is logged to. When no argument is supplied, the logged channel(s) is / are displayed. If a valid numeric argument is supplied, the user is logged to the specified channel.
Examples: /C Displays your current channel(s) /C 22 Change to channel 22 /C default 1234 Default to channel 1234.When a new channel is selected, the user remains logged to any previous channels, (so he can "monitor" several channels at once) but any subsequent text he sends will go to the new channel (unless targeted otherwise).
Channels 1 to 255 (except 101) are "local" to this server. Channel 101 links with RoundTable/BPQchat, if enabled. Channels 256 to 32767 may be linked to other Xrouter chat servers.
If a connection with the "Tampa Ping-Pong converse" system has been enabled, channels 0 to -32767 correspond to channels 0 to 32767 on Ping-Pong, otherwise they can be used as local channels.
The default channel at log-on is 1000. You may check or change this using the "/channel default" form of this command.
The /JOIN command has a similar function, and /LEAVE is used to de-select unwanted channels.
/ECHO -- control host echo
-
Syntax: /EC[ho]
The /ECHO command toggles host echo on and off. The default setting is ON, i.e. the user receives a copy of any text he sends to the channel.
Although host echo slightly increases bandwidth usage, it helps to put the user's text into temporal context amongst the other channel texts, especially when there is latency on the links. The user can more easily spot mistakes such as an incorrectly entered name or callsign.
/EXIT - exit the chat server.
-
Syntax: /E[xit]
The /EXIT command, which may be shortened to /E, disconnects the user from the chat server, and informs everyone that he's left. There is no need for the user to /leave any logged channels before issuing this command.
If the user accessed the server via the router's CHAT command, he will be returned to the router's main command prompt, otherwise he will be completely disconnected.
/HEADERLN - controls display format
-
Syntax: /HEA[derln] [on | off]
The /HEADERLN command controls whether or not the "header" and text of messages are displayed on the same line.
If the setting is OFF (default), the header and text are displayed on the same line. This leads to a more compact display, especially when the texts are short.
If the setting is ON, headers and text are displayed on separate lines.
/HELP - obtain help.
-
Syntax: /HELP [topic]
When used without arguments, the /HELP command gives brief instruction on how to access various levels of help.
If a topic is specified, detailed help for that topic (if available) is displayed. The topic may be a command name, or any other chat server related topic. A list of the available help topics can be obtained by specifying "*" as a topic.
Examples: /H Display general instructions. /H * List available help topics. /H /who Display help for /WHO command.Note: When using /H to display help for a command, the leading slash for that command may be omitted. Thus "/H /who" and "/H who" are equally permissible.
/JOIN - join (log onto) a channel.
-
Syntax: /J[oin] <channel>
The /JOIN command logs the user to a channel, and performs a similar function to the /CHANNEL command.
When a new channel is selected, the user remains logged to any previous channels, (so he can "monitor" several channels at once) but any subsequent text he sends will go to the new channel (unless targeted otherwise). (Unwanted channels may be de-selected using the complementary /LEAVE command.)
Example: /J 22 Join channel 22
See /CHANNEL for a description of the channels.
/KEEPALIVE - enables / disables link "keep alives".
-
Syntax: /KE[epalive] [ON | OFF] Examples: /K Reports current on / off state. /KE ON Turns keepalives on.There is no time-out on connections with XRchat, BUT if you are connected for long periods with no activity, some part of the link you are using may time out. For example, a NAT entry may time out, or an inter-node link may disconnect. Keep alive messages are intended to keep such links open, by sending a short text every 10 minutes.
If you are monitoring for long periods, the keepalives may become irritating, so don't enable them unless you need them.
/KM - kill mail
-
Syntax: /KM
The /KM (KillMail) command is used to delete personal messages after you have finished with them.
If someone sends you a certain type of personal chat message while you are not logged in, that message is stored at your server, and you will be notified when you next log in. You may then use the /RM command to read the messages, and the /KM command to delete them afterwards.
/KNOWN - known nodes
-
Syntax: /K[nown]
The /KNOWN command, which may be shortened to /K, is used to display a detailed list of the known RoundTable nodes. The display includes the node call and alias, plus the software version used at that node.
/kn Known nodes: SFSCHT:VE3UIL-11 1.0.0.8 RCWCHT:N1RCW-2 1.0.0.1 HAMQSO:KB8PMY-6 6.0.0.108 LVCHT2:K7ILO-6 6.0.0.112 SSCHT:W7JDC-5 1.4.53.1 NCVCHAT:KD8NCV-7 6.0.0.109 ETCHAT:K7ET-5 1.0.0.1 BOMCHAT:W7BOM-5 1.4.53.1 SVCHAT:KD7NHC-5 1.0.0.1 CMHQSO:KB8UVN-6 1.0.0.1 POLQSO:KD8ELG-6 1.4.52.1 DELQSO:N8BHL-6 1.4.49.1 (End of list)
/LEAVE - leave (log off) a channel.
-
Syntax: /L[eave] <channel>
The /LEAVE command logs the user off the specified channel. When a user joins a channel, he remains logged to any previous channels, so this command allows him to de-select unwanted channels.
Example: /L 22 - Leave channel 22
/LINKS - display / change peer links
-
Syntax: /LI[nks] [*] /LI[nks] ADD <peercall> /LI[nks] ADD <ip_addr>:<tcp_port> <peername> /LI[nks] DROP <callsign | peername>The /LINKS command shows the status of the links with other chat servers, and allows sysops to add and drop links without rebooting Xrouter.
"/LI[nks]" by itself displays a list of the links with users and other servers:
/li Callsign Type Connected Last-Heard Sent Unsent Rcvd Lost Sta VE3UIL-11 L4 20/03 08:56 20/03 16:05 83 0 303 0 2 TXE ZL2AQY-8 L4 20/03 16:01 20/03 16:01 3 0 1 0 2 TXE VE2PKT-8 L4 20/03 16:01 20/03 16:01 3 0 1 0 2 TXE VK2DOT-8 L4 20/03 16:01 20/03 16:01 3 0 4 0 2 TXE VE3UIL-8 L4 20/03 16:01 20/03 16:01 3 0 1 0 2 TXE N9PMO-7 L4 20/03 16:01 20/03 16:01 3 0 2 0 2 TXE ZL2AQY-11 L4 20/03 16:01 20/03 16:01 3 0 1 0 2 TXE W9OTR-9 L4 20/03 16:01 20/03 16:01 3 0 2 0 2 TXE G8PZT CON 20/03 16:01 20/03 16:07 2 0 8 0 2 TXE G8PZT-11 L4 20/03 16:04 20/03 16:04 0 0 0 0 1 TXE GB7CP-8 L4 20/03 16:04 20/03 16:04 1 0 0 0 2 (End of list)
The fields are as follows:
Callsign - Callsign of user or peer server. Type - Connection type (L2, L4, TCP etc). Connected - Date / time when connection started. Last-heard - Date / time when last data rcvd. Sent - No. of messages sent to this peer. Unsent - No. of messages dropped due to congested link. Rcvd - No. of messages received from this peer. Lost - No. of messages not rcvd due to link congestion. Sta - Connection state (1=opening, 2=open, 3=closing) TXE - Indicates TX empty, i.e. nothing queued.
"/LI[nks] *" additionally displays a list of the defined chat links, whether they are currently connected or not.
"/LI ADD" adds a peer server to the list, and has two forms, one for NetRom links and one for TCP/IP links.
In the Netrom case, <peercall> is the netrom callsign (not alias) of the peer server, and it must exist in Xrouter's nodes table otherwise the link will not be opened. If you have trouble with peers dropping in and out of the nodes table, create a "locked" node entry.
In order to define a link with a RoundTable/BPQ chat server the callsign must be prefixed with a '+' e.g. "+XE1FH-11". The link will not be allowed unless both callsign and alias are in the nodes table.
In the TCP/IP case, <peername> is the server ID of a Tampa Ping-Pong server, <ip_addr> is its IP address, and <tcp_port> is the TCP port number of the server.
Examples: /LI ADD +G1SSL-11 /LI DROP G8NTU-8 /LI ADD 80.195.22.37:3601 *brmcht /MSG - send a short message to a channel or a single user.
-
Syntax: /M[sg] <channel | callsign | callsign@server> <text>
The /MSG command is used to send a short message (70 chars max.) to any specified channel or single user. You may for example use this command to direct a message to a channel you are monitoring, but not actually logged to.
If you direct a message to a specific user, he may be on this or any other chat server. The private nature of the message will be indicated to the recipient by asterisks around the sender's call, e.g. <*g8pzt@kdchat*> (Paula): Meet me on channel 69.
If the target user's server is specified in the command, and the user isn't currently logged on, the message will be stored until he logs on. e.g. "/M g6yak@kdrcht Give me a shout on 'KD when you read this.."
Examples: /M 32 Hello People /M g6yak Meet me on channel 69 /M g6yak@kdrcht See u on KD laterThe first form sends "Hello People" to all the users of channel 32, and the second form sends a private msg to g6yak only. Providing G6YAK is logged on to any chat server, the message will find him. The third form sends a private message to G6YAK on the KDRCHT server. If G6YAK is not currently logged on, the message will be stored for him.
Note: As with all things Packet, the term "private" is relative, as nothing is truly private when it is broadcast!
/NAME - set name.
-
Syntax: /N[ame] <your name> [channel]
The /NAME command sets the user's name, which will be displayed on the user list and prefixed to everything he sends to others.
Users are not allowed to join any channels until they have supplied a name (12 chars max), so it acts as a "log on" command. The name need be supplied only at the initial logon, and may be changed as the user wishes.
On the first use of this command, the user may optionally specify a channel to join instead of the default (channel 0).
TCP/IP users must first use the /USER command (see below) to enter their callsign.
Examples: /N Paula Set name to "Paula" /N Paula 23 Set name and join channel 23 /NODES - display roundtable nodes
-
Syntax: /NO[des]
The /NODES command displays a detailed list of the known RoundTable / BPQchat nodes. This command currently duplicates the function of the /KNOWN command.
The display includes the node call and alias, plus the software version used at that node.
/PERSONAL - display / change personal description.
-
Syntax: /P[ersonal] [text | @]
The /PERSONAL command is used to display or change the user's personal description. This is a short text of up to 32 characters, which is displayed on the user list. It may typically contain the user's home town and "brag" information. If the user logs onto any "public" channels (i.e. those above channel 255), this information will appear on the user lists of all other chat servers.
If used without arguments, the /PERSONAL command displays the user's current text.
If the argument is "@", the existing text is removed.
Examples: /P - Displays current text /P Kidderminster, sysop - Set new text. /P @ - Clear previous text. /PORTS - Display RoundTable nodes, users and links.
-
Syntax: /P[orts]
The /PORTS command is only available in room 101. It displays a list of the RoundTable chat nodes and the peer(s) they are reached via, plus a list of the users currently logged onto the RoundTable network, plus a list of the defined RoundTable chatlinks and their current status.
/QTH - display / set qth.
-
Syntax: /Q[th] [your-qth]
The /QTH command is used to set your QTH. QTH is not currently required by the XRchat system, but is mandatory if you log in to room 101 (RoundTable/BPQ chat).
Examples: /Q - Displays current QTH setting. /Q Weston Super Mare - Sets new QTH.Note: QTH may include spaces, and can be up to 64 characters.
/QUIT - exit the chat server.
-
Syntax: /QU[it]
The /QUIT command, which may be shortened to /Q, disconnects the user from the chat server, and informs everyone that he's left. There is no need for the user to /leave any logged channels before issuing this command.
If the user accessed the server via the router's CHAT command, he will be returned to the router's main command prompt, otherwise he will be completely disconnected.
/RM - readmail
-
Syntax: /RM
The /RM (ReadMail) command is used to read any personal messages that were left for the user while he was offline.
If someone sends a certain type of personal chat message to a user while he isn't logged in, that message is stored on the chat server, and he is notified when he next logs in. He may then use the /RM command to read the messages.
Messages are not deleted after they are read. The /KM (KillMail) command is used to delete unwanted messages.
/STAMP - controls timestamping of message texts.
-
Syntax: /S[TAMP] [on | off]
With stamp ON (default) each mesage is timestamped in the following style, designed to be readable both by humans and by client software:
[1234] 09:35 {21:33} <ZL2BAU@BAUCHT> (Peter): Hello folksThe first field is the channel number. This may seem pointless, but you will soon appreciate it if you are logged to more than one channel!
The second field is the chatserver's timestamp, i.e. the local time the message was received at, and redistributed by, the server. This is useful if you are away from the screen for a while, or are logging the activity to disk.
The third field is the originating server's timestamp, i.e. the local time at which the message was entered into the system. With servers linked across different timezones, the two timestamps may differ by up to 12 hours. Personally I find it useful to know what the other user's local time is, because it helps put their comments into perspective. The timestamps can also highlight propagation delays.
The fourth field consists of the sender's callsign and the "alias" of the originating server. Users may (and often do) log onto more than one server, often at the same time.
The fifth field is the user's name.
Those who are used to chatting on the Ping-Pong system seem to be unable to cope with anything which is different, so with STAMP OFF the header information is abbreviated in the Ping-Pong style as follows:
<g8pzt:Paula>: Test
/TOPIC - display / change channel topic.
-
Syntax: /T[opic] [channel] [text | @]
Every channel has an optional topic, and the /TOPIC command can be used to display the existing topic or change it. The topic can be up to 12 characters, and is displayed on the /Who list.
Examples: /T - Show current ch. topic /T 32 - Show channel 32 topic /T 32 TCP/IP discussion - Set topic for ch. 32 /T @ - Clear topic. /USER - tcp/ip logon.
-
Syntax: /U[ser] <callsign> [name]
The /USER command is available only to TCP/IP users. It sets the user's callsign (and optionally his name), which will be displayed on the user list and prefixed to everything he sends to others.
The user will not be able to join the conference without supplying both callsign (9 chars max) and name (12 chars max), but if the name is omitted from this command he may enter it in the normal way with the /NAME command.
Examples: /U g8pzt - Set callsign to "g8pzt". /U g8pzt Paula - Set callsign and name. /USERS - display roundtable/bpqchat users.
-
Syntax: /U[sers]
The /USERS command is available only when logged to the RoundTable/BPQChat channel (room 101). It displays all the users currently logged into the RoundTable/BPQ chat network.
For each user, the callsign, name and QTH are displayed, together with the alias of the server where they are logged in.
/u 4 station(s) connected: OH5RM at RMCHAT Jouko, Kouvola, South-Finland [oh] Idle for 8397s OH7HJ at JJTCHA Juha, Käsämä, KP42QP, [oh] Idle for 1883s KD6PGI at HRCHAT Ken, Hood River, OR USA [General] Idle for 404s G8PZT at KDRCHT Paula, Kidderminster [General] Idle for 0s
/VERBOSE - enable / disable verbose alerts
-
Syntax: /VERB[ose] [on | off]
Controls whether or not the user gets advised of things happening on other channels. e.g. if sysop is monitoring channel 1234 with verbose on, she would be advised whenever anyone logs on or off any channel.
This is primarily of use to GUI clients, allowing them to build and maintain their own lists of who's on what channel.
/VERSION - display chat server version.
-
Syntax: /V[ersion]
The /VERSION command displays the chat server version, author and compilation date. Please quote it if reporting bugs.
/WHO - list channels and users.
-
Syntax: /W[ho] [*]
The /WHO command lists who is logged onto the chat server, and what channels they are on.
If no arguments are supplied, the active channels are listed, along with the callsigns of their users:
/w Channel Topic Users 44 TCP/IP 101 RoundTable OH5RM G8BPQ OH7HJ KD6PGI ZL2AQY 1000 The Lounge ZL2AQY G8PZT 1234 XRPi Sysops ZL2AQY VK2DOT-1 (End of list)If an asterisk is supplied as the argument, each user is displayed in more detail. The display would typically show the user's callsign, name, personal text and logon date/time.
/w * Channel User @Server Idle Name Details 101 OH5RM @OH5RM-8 2h Jouko 101 G8BPQ @KD6PGI-2 39m John 101 OH7HJ @OH7JJT-8 26m Juha 101 KD6PGI @KD6PGI-2 2m Ken 101 ZL2AQY @ZL2BAU-8 30s /- 1000 ZL2AQY @AKXRPi 8d Eddie about 1000 G8PZT @KDRCHT 0s Paula Sleeping 1234 ZL2AQY @AKXRPi 8d Eddie about 1234 VK2DOT-1 @DOTCHT 1h Rod as (End of list)
See also