Online Amateur Radio Community Wiki

User Tools

Site Tools

Trace: • hlpchat
packet:xrpi:manpages:hlpchat

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
packet:xrpi:manpages:hlpchat [2025/04/19 14:09] – m0mzfpacket:xrpi:manpages:hlpchat [2025/04/19 18:00] (current) – removed m0mzf
Line 1: Line 1:
-=======Chat Server Help======= +
-=====ALERT.HLP===== +
-<code> +
-The /ALERT command, which may be shortened to /A, is used to enable +
-or 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. +
-</code> +
-=====ANSI.HLP===== +
-<code> +
-The /ANSI command, which may be shortened to /AN, is used to enable or +
-disable the use of ansi colour. +
-    Syntax: /AN[si] [ON | OFF] +
-    Examples: /ANSI          Reports current on / off state. +
-              /ANSI ON       Turn colour on. +
-In order to make use of this feature, callers must be using an ANSI +
-compatible terminal, such as XRouter's console, or Windows Telnet. +
-If ANSI is ON, each user's messages are shown in a different colour, +
-making it easier to follow conversations. +
-</code> +
-=====BELL.HLP===== +
-<code> +
-The /BELL command, which may be shortened to /BE, is used to enable or +
-disable activity warnings. +
-    Syntax: /BE[ll] [0-3] +
-    Examples: /BE      Reports current bell setting. +
-              /BE 2    Bell on received chat. +
-The /BELL command controls which events are accompanied by an audible +
-warning.  Arguments are as follows: +
-       0       No bells (default) +
-       1       Informative messages from chat server only +
-       2       Text entered by other chatters only +
-       3       All events +
-Note: In order to use this feature, your terminal must respond to the +
-      ASCII "bell" character. +
-</code> +
-=====BYE.HLP===== +
-<code> +
-The /BYE command, which may be shortened to /B, disconnects you from the +
-conference, and informs everyone that you've left. +
-If you joined the conference using the CHAT command, you will be +
-returned to the router's main command prompt, otherwise you will be +
-completely disconnected. +
-</code> +
-=====CHANNEL.HLP===== +
-<code> +
-The /CHANNEL command displays / changes the channel(s) you are logged to. +
-   Syntax: /C[hannel] [number] | DEFAULT [number] +
-   Examples: /C               Displays your current channel(s) +
-             /C 22            Change to channel 22 +
-             /C default 1234  Default to channel 1234 upon connection. +
-When you select a channel, you remain logged to previous channels, +
-(so you can "monitor" several channels at once) but any text you send will +
-go to the new channel (unless you redirect it). Use /L[eave] to deselect +
-unwanted channels. +
-Channels 1 to 255 (except 101) are "local" to this server. +
-Channel 101 links with RoundTable/BPQchat, if enabled by sysop. +
-Channels 256 to 32767 may be linked to other Xrouter chat servers. +
-If the sysop has enabled connection with the "Tampa Ping-Pong converse" +
-system, 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. +
-</code> +
-=====ECHO.HLP===== +
-<code> +
-The /ECHO command, which may be shortened to /EC, controls host echo. +
-    Syntax: /EC[ho] [on | off] +
-Host echo defaults to ON, i.e. you receive a copy of anything you send, +
-which helps to put it into context amongst other user's postings, +
-especially when there is latency on the link.  +
-However, because this increases bandwidth usage, you may prefer to +
-turn it off using "/ECHO OFF". +
-</code> +
-=====EXIT.HLP===== +
-<code> +
-The /EXIT command, which may be shortened to /E, disconnects you from +
-the conference, and informs everyone that you've left. +
-If you joined the conference using the CHAT command, you will be +
-returned to the router's main command prompt, otherwise you will be +
-completely disconnected. +
-</code> +
-=====HEADERLN.HLP===== +
-<code> +
-The /HEADERLN command, which may be shortened to /HEA, controls whether +
-or not the "header" and "text" of messages are displayed on the same line. +
-   Syntax:  /HEA[derln] [ON | OFF] +
-If HEADERLN is OFF (default), the header (i.e. timestamps etc.) and text +
-of messages are displayed on the same line.  This gives a more compact +
-display, especially when the texts are short. +
-If HEADERLN is ON, header and text are displayed on separate lines, +
-which some users may feel aids readability. +
-</code> +
-=====JOIN.HLP===== +
-<code> +
-The /JOIN command logs you to another channel. +
-   Syntax: /J[oin] <channel> +
-   Example:  /J 22   Join channel 22 +
-When you join a channel, you remain logged to any previous channels, +
-(so you can "monitor" several channels at once) but any text you send will +
-go to the new channel (unless you redirect it - see /Msg). Use /L[eave] to deselect unwanted channels. +
-Channels 1 to 255 (except 101) are "local" to this server. +
-Channel 101 links with RoundTable/BPQchat, if enabled by sysop. +
-Channels 256 to 32767 may be linked to other Xrouter chat servers. +
-If the sysop has enabled connection with the "Tampa Ping-Pong converse" +
-system, channels 0 to -32767 correspond to channels 0 to 32767 on +
-Ping-Pong, otherwise they can be used as local channels.  +
-See also: /CHANNEL +
-</code> +
-=====KEEPALIV.HLP===== +
-<code> +
-The /KEEEPALIVE command, which may be shortened to /KE, is used to enable +
-or disable the sending of link "keep alive" messages. +
-    Syntax: /KE[epalive] [ON | OFF | secs] +
-    Examples: /KE            Reports current on / off state. +
-              /KE ON         Turns keepalives on. +
-              /KE 600        Turns keepalives on, interval 600 secs +
-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 so often (default 5 minutes). This interval can +
-be changed using the "/KE <secs>" form. The new interval is remembered +
-while you remain connected. +
-If you are monitoring for long periods, the keepalives may become +
-irritating, so don't enable them unless you need them. +
-</code> +
-=====KM.HLP===== +
-<code> +
-The /KM (KillMail) command is used to delete personal messages after +
-you have finished with them. +
-    Syntax: /KM +
-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. +
-</code> +
-=====KNOWN.HLP===== +
-<code> +
-The /KNOWN command, which may be shortened to /K, is used to display +
-a detailed list of the known RoundTable nodes. +
-    Syntax: /K[nown] +
-The display includes the node call and alias, plus the software version +
-used at that node. +
-</code> +
-=====LEAVE.HLP===== +
-<code> +
-The /LEAVE command logs you off a channel. +
-   Syntax: /L[eave] <channel> +
-   Example:  /L 22   - Leave channel 22 +
-When you join a channel, you remain logged to any previous channels, +
-so the /Leave command allows you to deselect unwanted channels. +
-See also: /CHANNEL  /JOIN +
-</code> +
-=====LINKS.HLP===== +
-<code> +
-The /LINKS command displays the links with users and other chat +
-servers, and is primarily of interest to sysops. +
-        Syntax: /LI[nks] [*] +
-                /LI[nks] ADD <callsign> +
-                /LI[nks] ADD <servname> <ip_address>:<tcp_port> +
-                /LI[nks] DROP <callsign | servname>  +
-        Examples:  /LI ADD GB7GLO-9 +
-                   /LI ADD mlvnchat 44.131.94.33:3600 +
-The ADD and DROP subcommands are only available to sysops.  <callsign> is +
-the Netrom callsign of a peer chat server. <servname> is the server name +
-of a "Ping-Pong converse" server. The "/LI *" form displays additional +
-information. +
-The response to /LI contains the following fields: +
-        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. +
-The "lost" count may sometimes indicate a large number, if the peer +
-server has crashed. +
-</code> +
-=====MSG.HLP===== +
-<code> +
-The /MSG command sends a short message to a channel or a single user. +
-   Syntax: /M[sg] <channel | callsign | callsign@server> <text> +
-   Examples: /M 32 Hello People                - Msg to all on channel 32 +
-             /M g6yak Meet me on channel 69    - Private msg to g6yak only +
-             /M g6yak@kdrcht See u on KD later - Private message-drop +
-Message can be up to approx 70 characters.  You may for example use this +
-command to direct a message to one of the channels you are monitoring, +
-or to any other channel. +
-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.."  +
-</code> +
-=====NAME.HLP===== +
-<code> +
-The /NAME command sets your name, which will be displayed on the user +
-list and prefixed to everything you send to others.  You will not be +
-able to join the conference without supplying a name (12 chars max). +
-   Syntax:  /N[ame] <your name> [channel] +
-On the first use of this command, you may optionally specify a channel +
-to join instead of the default (channel 0). +
-(TCP/IP users should use the /USER command to enter their callsign and name.) +
-   Examples: /N Paula       Set name to "Paula" +
-             /N Paula 23    Set name to "Paula" and join channel 23 +
-</code> +
-=====NODES.HLP===== +
-<code> +
-The /NODES command, which may be shortened to /NO, is used to display +
-a detailed list of the known RoundTable nodes. This command currently +
-duplicates the function of the /K command. +
-    Syntax: /NO[des] +
-The display includes the node call and alias, plus the software version +
-used at that node. +
-</code> +
-=====PERSONAL.HLP===== +
-<code> +
-The /PERSONAL command displays / changes your personal description. +
-   Syntax: /P[ersonal] [text | @] +
-   Examples: /P                        - Displays your current text +
-             /P Kidderminster, sysop   - Set new text +
-             /P @                      - Clear your text. +
-Your personal text can be up to 32 characters, and is displayed on the +
-user list. +
-</code> +
-=====PORTS.HLP===== +
-<code> +
-The /PORTS command, which may be shortened to /P, is used to display +
-a list of RoundTable ports and links. It is only available in room 101. +
-    Syntax: /P[orts] +
-The display includes the known RoundTable nodes, the RoundTable link +
-partners, the nodes learned via those partners, and the users connected +
-at this RoundTable node. +
-</code> +
-=====QTH.HLP===== +
-<code> +
-The /QTH command, which may be shortened to /Q, is used to set your QTH. +
-    Syntax: /Q[th] [your-qth] +
-    Examples: /Q                        Displays current QTH setting. +
-              /Q Weston Super Mare      Sets new QTH. +
-Note that the QTH may include spaces, and can be up to 64 characters long. +
-QTH is not currently required by the XRchat system, but is mandatory if +
-you log in to room 101 (RoundTable/BPQ chat). +
-</code> +
-=====QUIT.HLP===== +
-<code> +
-The /QUIT command, which may be shortened to /QU, disconnects you from +
-the conference, and informs everyone that you've left. +
-If you joined the conference using the router's CHAT command, you will be +
-returned to the router's main command prompt, otherwise you will be +
-completely disconnected. +
-</code> +
-=====RECENT.HLP===== +
-<code> +
-The /RECENT command displays the last 10 messages received in the +
-last 24 hours. +
-  Syntax:  /R[ecent] [channel] +
-  Examples:  /RECENT  - Show recent messages from all channels +
-             /RE 1234 - Show recent messages from channel 1234 only +
-The purpose of this command is to display messages that you might +
-have missed while you weren't connected, allowing you to conduct +
-non-real-time conversations. +
-Messages currently expire after 24 hours. +
-</code> +
-=====RM.HLP===== +
-<code> +
-The /RM (ReadMail) command is used to read any personal messages that +
-were left for you while you were offline. +
-    Syntax: /RM +
-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. +
-Messages are not deleted after they are read. You must use /KM (KillMail) +
-when you no longer need the messages. +
-</code> +
-=====STAMP.HLP===== +
-<code> +
-The /STAMP command, which may be shortened to /S, controls the +
-time-stamping of messages. +
-   Syntax:  /S[tamp] [ON | OFF] +
-With STAMP ON (default) each message is time stamped in a form designed +
-to be readable by humans and software.  This header contains the channel +
-number, local and sender's time, plus sender's callsign, host, and name. +
-With STAMP OFF, messages are prefixed by a condensed header which shows +
-only the sender's callsign and name. +
-</code> +
-=====STATUS.HLP===== +
-<code> +
-The /STATUS command ss used to display or change your availability +
-status (presence). +
-  Syntax:  /STAT[us] [code] +
-Valid status / presence codes are as follows:                                       +
-       A[vail], AW[ay], B[usy], BR[b], D[nd], +
-       I[n&out], L[unch], P[hone], S[leep] +
-  Examples: /STATUS     — Show your current status +
-            /STAT ?     - Display the available status codes +
-            /STATUS BRB - Set your status to "Be Right Back" +
-</code> +
-=====TOPIC.HLP===== +
-<code> +
-The /TOPIC command displays / changes a channel topic. +
-   Syntax: /T[opic] [channel] [text | @] +
-   Examples: /T                        - Displays topic for your channel +
-             /T 32                     - Display channel 32 topic +
-             /T 32 TCP/IP discussion   - Set new topic for channel 32 +
-             /T 32 @                   - Clear topic. +
-Topic can be up to 12 characters, and is displayed on the /Who list. +
-</code> +
-=====USER.HLP===== +
-<code> +
-The /USER command is available only to TCP/IP users.  It sets your callsign +
-(and optionally your name), which will be displayed on the user list and +
-prefixed to everything you send to others.  You will not be able to join +
-the conference without supplying both callsign (9 chars max) and name +
-(12 chars max), but you may use the /Name command later if you don't +
-supply a name here. +
-   Syntax:  /U[ser] <your callsign> [your name] +
-   Examples: /U g8pzt          - Set callsign to "g8pzt". +
-             /U g8pzt Paula    - Set callsign to "g8pzt" and name to "Paula" +
-</code> +
-=====USERS.HLP===== +
-<code> +
-The /USERS command is available only when logged to the RoundTable +
-channel (room 101). It displays all the users currently logged into +
-the RoundTable/BPQ chat network. +
-   Syntax:  /U[sers] +
-For each user, the callsign, name and QTH are displayed, together +
-with the alias of the server where they are logged in. +
-</code> +
-=====VERBOSE.HLP===== +
-<code> +
-/VERBOSE - Enable / disable Verbose alerts +
-Syntax: /VERB[ose] [on | off] +
-The /VERBOSE command controls whether or not the server advises you +
-of things happening on other channels.  e.g. if you are monitoring +
-channel 1234 with verbose on, you would be advised whenever anyone +
-logs on or off any other channel. +
-This is primarily of use to GUI clients, allowing them to build and +
-maintain their own lists of who's on what channel. +
-This command is not yet fully functional, and currently has exactly +
-the same action as the /STAMP command. +
-</code> +
-=====VERSION.HLP===== +
-<code> +
-The /VERSION command displays the chat server version, author and +
-compilation date.  Please quote it if reporting bugs. +
-The command may be shortened to /VERS, and it takes no arguments. +
-</code> +
-=====WHO.HLP===== +
-<code> +
-The /WHO command lists who is in the conference. +
-  Syntax:  /W     Lists channels & users in brief format +
-           /W *   Lists users in detail +
-</code>+
packet/xrpi/manpages/hlpchat.1745071749.txt.gz · Last modified: 2025/04/19 14:09 by m0mzf