added apropos command
[spider.git] / cmd / Commands_en.hlp
1 #
2 # please put your help in in alphabetical order
3 #
4 # a string search is done in the command field (case is ignored)
5 # and all commands matching the asked for command are printed out
6 #
7 # the order of the fields in each header is 
8 #   privilege, command, Description 
9 # if the command ends in a - then that line isn't printed, but any
10 # subsequent lines are
11 #
12 # Comment lines are indented before printing
13 #
14 === 0^ANNOUNCE <text>^Send an announcement to LOCAL users only
15
16 === 0^ANNOUNCE FULL <text>^Send an announcement cluster wide
17 This will send your announcement cluster wide
18
19 === 5^ANNOUNCE SYSOP <text>^Send an announcement to Sysops only
20
21 === 0^ANNOUNCE-
22 <text> is the text of the announcement you wish to broadcast 
23
24 === 0^APROPOS <string>^Search help database for <string>
25 Search the help database for <string> (it isn't case sensitive), and print
26 the names of all the commands that may be relevant.
27
28 === 0^BYE^Exit from the cluster
29 This will disconnect you from the cluster
30
31 === 5^CONNECT <callsign>^Start a connection to another DX Cluster
32 Start a connection process that will culminate in a new connection to the
33 DX cluster <callsign>. This process creates a new 'client' process which will
34 use the script in /spider/connect/<callsign> to effect the 'chat' exchange
35 necessary to traverse the network(s) to logon to the cluster <callsign>.
36
37 === 9^DEBUG^Set the cluster program into debug mode
38 Executing this command will only have an effect if you are running the cluster
39 in debug mode i.e.
40
41         perl -d cluster.pl
42
43 It will interrupt the cluster just after the debug command has finished.
44 === 0^DIRECTORY^List messages 
45 === 0^DIRECTORY ALL^List all messages
46 === 0^DIRECTORY OWN^List your own messages
47 === 0^DIRECTORY NEW^List your own new messages
48 List the messages in the messages directory. 
49
50 If there is a 'p' one space after the message number then it is a 
51 personal message.
52
53 If there is a - after the message number then this indicates that the
54 message has been read.
55
56 === 5^DIRECTORY-^
57 Sysops can see all users' messages.
58
59 === 8^DISCONNECT <call> [<call> ...]^Disconnect a user or cluster
60 Disconnect any <call> connected locally
61
62 === 0^DX <freq> <callsign> <remarks>^Send a DX spot throughout the cluster
63 <freq> is compared against the available bands set up in the cluster.
64 see show/bands for more information.
65
66 === 0^HELP^The HELP Command
67 HELP is available for a number of commands. The syntax is:-
68
69   HELP <cmd>
70   
71 Where <cmd> is the name of the command you want help on.
72
73 All commands can be abbreviated, so SHOW/DX can be abbreviated
74 to SH/DX, ANNOUNCE can be shortened to AN and so on.
75
76 Look at the APROPOS <string> command which will search the help database
77 for the <string> you specify and give you a list of likely commands
78 to look at with HELP.
79 === 0^SHOW/DX^Interrogate the spot database
80 If you just type SHOW/DX you will get the last so many spots
81 (sysop configurable, but usually 10).
82    
83 In addition you can add any number of these commands in very nearly
84 any order to the basic SHOW/DX command, they are:-
85    
86 on <band>       - eg 160m 20m 2m 23cm 6mm
87 on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
88    
89 <number>        - the number of spots you want
90 <from>-<to>     - <from> spot no <to> spot no in the selected list
91    
92 <prefix>        - for a spotted callsign beginning with <prefix>
93 *<suffix>       - for a spotted callsign ending in <suffix>
94 *<string>*      - for a spotted callsign containing <string>
95    
96 day <number>    - starting <number> days ago
97 day <from>-<to> - <from> days <to> days ago
98    
99 info <text>     - any spots containing <text> in the info or remarks
100    
101 spotter <call>  - any spots spotted by <call>
102    
103 e.g. 
104    
105    SH/DX 9m0
106    SH/DX on 20m info iota
107    SH/DX 9a on vhf day 30
108
109 === 0^KILL <msgno> [<msgno> ...]^Remove or erase a message from the system
110 You can get rid of any message to or originating from your callsign using 
111 this command. You can remove more than one message at a time.
112
113 === 5^KILL-^
114 As a sysop you can kill any message on the system.
115
116 === 1^PING <node call>^Find out the delays an a circuit to another node
117 This command will enable sysops to determine the speed of an inter-cluster
118 node. 
119
120 Any visible cluster node can be PINGed.
121
122 === 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
123 This command allows you to send nearly any command to another DX Cluster
124 node that is connected to the system. 
125
126 Whether you get any output is dependant on a) whether the other system knows
127 that the node callsign of this cluster is in fact a node b) whether the
128 other system is allowing RCMDs from this node and c) whether you have
129 permission to send this command at all.
130
131 === 0^READ^Read the next unread personal message addressed to you
132 === 0^READ <msgno>^Read the specified message
133 You can read any messages that are sent as 'non-personal' and also any
134 message either sent by or sent to your callsign.
135
136 === 5^READ-^
137 As a sysop you may read any message on the system
138
139 === 0^REPLY^Reply to the last message that you have read
140 === 0^REPLY <msgno>^Reply to the specified message
141 === 0^REPLY PRIVATE <msgno>^Reply privately to the specified message
142 === 0^REPLY RR <msgno>^Reply to the specified message with read receipt
143 You can reply to a message and the subject will automatically have
144 "Re:" inserted in front of it, if it isn't already present.
145
146 You can also use all the extra qualifiers such as RR, PRIVATE, 
147 NOPRIVATE that you can use with the SEND command (see SEND
148 for further details)
149
150 === 0^SEND <call> [<call> ...]^Send a message to one or more callsigns
151 === 0^SEND RR <call>^Send a message and ask for a read receipt
152 === 0^SEND COPY <msgno> <call>^Send a copy of a  message to someone
153 === 0^SEND PRIVATE <call>^Send a personal message
154 === 0^SEND NOPRIVATE <call>^Send a message to all stations
155 All the SEND commands will create a message which will be sent either to
156 an individual callsign or to one of the 'bulletin' addresses. 
157
158 SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
159 it will mark the message as personal and send it to the cluster node that
160 that callsign is connected to.
161
162 You can have more than one callsign in all of the SEND commands.
163
164 You can have multiple qualifiers so that you can have for example:-
165
166   SEND RR COPY 123 PRIVATE G1TLH G0RDI
167
168 which should send a copy of message 123 to G1TLH and G0RDI and you will
169 receive a read receipt when they have read the message.
170   
171 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
172 This command takes the <prefix> (which can be a full or partial 
173 callsign if desired), looks up which internal country number it is
174 and then displays all the spots as per SH/DX for that country.
175    
176 The options for SHOW/DX also apply to this command.   
177 e.g. 
178    
179    SH/DXCC G
180    SH/DXCC W on 20m info iota
181
182 === 0^SHOW/PREFIX <callsign>^Interrogate the prefix database 
183 This command takes the <callsign> (which can be a full or partial 
184 callsign or a prefix), looks up which internal country number 
185 it is and then displays all the relevant prefixes for that country
186 together with the internal country no, the CQ and ITU regions. 
187
188 See also SHOW/DXCC
189
190 === 5^SHUTDOWN^Shutdown the cluster
191 Shutdown the cluster and disconnect all the users 
192
193 === 0^TALK <call> <text>^Send a text message to another station
194 === 0^TALK <call> > <node> <text>^Send a text message to another station via a node
195 Send a short message to any other station that is visible on the cluster
196 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
197 command, they don't have to be connected locally.
198
199 The second form of TALK is used when other cluster nodes are connected
200 with restricted information. This usually means that they don't send 
201 the user information usually associated with loging on and off the cluster.
202
203 If you know that G3JNB is likly to be present on GB7TLH, but you can only
204 see GB7TLH in the SH/C list but with no users, then you would use the
205 second form of the talk message.
206
207 === 0^WX <text>^Send a weather message to local users
208 === 0^WX FULL <text>^Send a weather message to all cluster users
209 === 5^WX SYSOP <text>^Send a weather message to other clusters only
210 Weather messages can sometimes be useful if you are experiencing an extreme
211 that may indicate enhanced conditions