6. Implemented PC49 delete/full from outside (kill full on the inside)
[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 === 1^FORWARD/OPERNAME <call>^Send out information on this <call> to all clusters
67 This command sends out any information held in the user file which can 
68 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
69 and Homenode. PC41s are only sent for the information that is available.
70  
71 === 0^HELP^The HELP Command
72 HELP is available for a number of commands. The syntax is:-
73
74   HELP <cmd>
75   
76 Where <cmd> is the name of the command you want help on.
77
78 All commands can be abbreviated, so SHOW/DX can be abbreviated
79 to SH/DX, ANNOUNCE can be shortened to AN and so on.
80
81 Look at the APROPOS <string> command which will search the help database
82 for the <string> you specify and give you a list of likely commands
83 to look at with HELP.
84
85 === 0^KILL <msgno> [<msgno..]^Delete a message from the local system
86 Delete a message from the local system. You will only be able to delete messages
87 that you have originated or been sent (unless you are the sysop).
88
89 === 5^KILL FULL <msgno> [<msgno..]^Delete a message from the whole cluster
90 Delete a message (usually a 'bulletin') from the whole cluster system. 
91
92 This uses the subject field, so any messages that have exactly the same subject
93 will be deleted. Beware!
94
95 === 9^LOAD/ALIASES^Reload the command alias table
96 Reload the /spider/cmd/Aliases file after you have editted it. You will need to
97 do this if you change this file whilst the cluster is running in order for the
98 changes to take effect.
99
100 === 9^LOAD/BANDS^Reload the band limits table
101 Reload the /spider/data/bands.pl file if you have changed it manually whilst
102 the cluster is running. 
103
104 === 9^LOAD/CMD_CACHE^Reload the automatic command cache
105 Normally, if you change a command file in the cmd or local_cmd tree it will
106 automatially be picked up by the cluster program. Sometimes it can get confused
107 if you are doing a lot of moving commands about or delete a command in the 
108 local_cmd tree and want to use the normal one again. Execute this command to
109 reset everything back to the state it was just after a cluster restart.
110
111 === 9^LOAD/MESSAGES^Reload the system messages file
112 If you change the /spider/perl/Messages file (usually whilst fiddling/writing new
113 commands) you can have them take effect during a cluster session by executing this
114 command. You need to do this if get something like :-
115
116 unknown message 'xxxx' in lang 'en'
117
118 === 9^LOAD/PREFIXES^Reload the prefix table
119 Reload the /spider/data/prefix_data.pl file if you have changed it manually whilst
120 the cluster is running. 
121
122 === 8^PC <call> <text>^Send text (eg PC Protocol) to <call>
123 Send some arbitrary text to a locally connected callsign. No processing is done on
124 the text. This command allows you to send PC Protocol to unstick things if problems
125 arise (messages get stuck etc). eg:-
126    pc gb7djk PC33^GB7TLH^GB7DJK^400^
127 or 
128    pc G1TLH Try doing that properly!!!
129
130 === 1^PING <node>^Send a ping command to another cluster
131 This command is used to estimate the quality of the link to another cluster. 
132 The time returned is the length of time taken for a PC51 to go to another 
133 cluster and be returned.
134
135 === 0^KILL <msgno> [<msgno> ...]^Remove or erase a message from the system
136 You can get rid of any message to or originating from your callsign using 
137 this command. You can remove more than one message at a time.
138
139 === 5^KILL-^
140 As a sysop you can kill any message on the system.
141
142 === 1^PING <node call>^Find out the delays an a circuit to another node
143 This command will enable sysops to determine the speed of an inter-cluster
144 node. 
145
146 Any visible cluster node can be PINGed.
147
148 === 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
149 This command allows you to send nearly any command to another DX Cluster
150 node that is connected to the system. 
151
152 Whether you get any output is dependant on a) whether the other system knows
153 that the node callsign of this cluster is in fact a node b) whether the
154 other system is allowing RCMDs from this node and c) whether you have
155 permission to send this command at all.
156
157 === 0^READ^Read the next unread personal message addressed to you
158 === 0^READ <msgno>^Read the specified message
159 You can read any messages that are sent as 'non-personal' and also any
160 message either sent by or sent to your callsign.
161
162 === 5^READ-^
163 As a sysop you may read any message on the system
164
165 === 0^REPLY^Reply to the last message that you have read
166 === 0^REPLY <msgno>^Reply to the specified message
167 === 0^REPLY PRIVATE <msgno>^Reply privately to the specified message
168 === 0^REPLY RR <msgno>^Reply to the specified message with read receipt
169 You can reply to a message and the subject will automatically have
170 "Re:" inserted in front of it, if it isn't already present.
171
172 You can also use all the extra qualifiers such as RR, PRIVATE, 
173 NOPRIVATE that you can use with the SEND command (see SEND
174 for further details)
175
176 === 0^SEND <call> [<call> ...]^Send a message to one or more callsigns
177 === 0^SEND RR <call>^Send a message and ask for a read receipt
178 === 0^SEND COPY <msgno> <call>^Send a copy of a  message to someone
179 === 0^SEND PRIVATE <call>^Send a personal message
180 === 0^SEND NOPRIVATE <call>^Send a message to all stations
181 All the SEND commands will create a message which will be sent either to
182 an individual callsign or to one of the 'bulletin' addresses. 
183
184 SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
185 it will mark the message as personal and send it to the cluster node that
186 that callsign is connected to.
187
188 You can have more than one callsign in all of the SEND commands.
189
190 You can have multiple qualifiers so that you can have for example:-
191
192   SEND RR COPY 123 PRIVATE G1TLH G0RDI
193
194 which should send a copy of message 123 to G1TLH and G0RDI and you will
195 receive a read receipt when they have read the message.
196
197 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
198 SP is an alias for SEND PRIVATE
199
200 === 0^SET/ADDRESS <your address>^Record your postal address
201
202 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
203 === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
204
205 === 0^SET/BEEP^Add a beep to DX and other messages on your terminal
206 === 0^UNSET/BEEP^Stop beeps for DX and other messages on your terminal
207
208 === 9^SET/DEBUG <name>^Add a debug level to the debug set
209 === 9^UNSET/DEBUG <name>^Remove a debug level from the debug set
210
211 === 0^SET/DX^Allow DX messages to come out on your terminal
212 === 0^UNSET/DX^Stop DX messages coming out on your terminal
213
214 === 0^SET/HERE^Tell the system you are present at your terminal
215 === 0^UNSET/HERE^Tell the system you are absent from your terminal
216
217 === 0^SET/HOMENODE <node> ^Set your normal cluster callsign
218 Tell the cluster system where you normally connect to. Any Messages sent
219 to you will normally find their way there should you not be connected.
220 eg:-
221   SET/HOMENODE gb7djk
222
223 === 0^SET/LOCATION <lat & long>^Set your latitude and longitude
224 In order to get accurate headings and such like you must tell the system
225 what your latitude and longitude is. If you have not yet done a SET/QRA
226 then this command will set your QRA locator for you. For example:-
227   SET/LOCATION 52 22 N 0 57 E
228
229 === 0^SET/LOCKOUT <call>^Stop a callsign connecting to the cluster
230 === 0^UNSET/LOCKOUT <call>^Allow a callsign to connect to the cluster
231
232 === 0^SET/NAME <your name>^Set your name
233 Tell the system what your name is eg:-
234   SET/NAME Dirk
235
236 === 9^SET/NODE <call> [<call>..]^Make the callsign an AK1A cluster
237 Tell the system that the call(s) are to be treated as AK1A cluster and
238 fed PC Protocol rather normal user commands.
239
240 === 0^SET/PAGE <lines per page>^Set the lines per page
241 Tell the system how many lines you wish on a page when the number of line
242 of output from a command is more than this. The default is 20. Setting it
243 explicitly to 0 will disable paging. 
244   SET/PAGE 30
245   SET/PAGE 0
246
247 === 9^SET/PRIVILEGE <n> <call> [<call..]^Set privilege level on a call
248 Set the privilege level on a callsign. The privilege levels that pertain
249 to commands are as default:-
250   0 - normal user
251   1 - allow remote nodes normal user RCMDs
252   5 - various privileged commands (including shutdown, but not disc-
253       connect), the normal level for another node.
254   8 - more privileged commands (including disconnect)
255   9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
256       LEVEL.
257 If you are a sysop and you come in as a normal user on a remote connection
258 your privilege will automatically be set to 0.
259
260 === 0^SET/QRA <locator>^Set your QRA locator
261 Tell the system what your QRA (or Maidenhead) locator is. If you have not
262 done a SET/LOCATION then your latitude and longitude will be set roughly
263 correctly (assuming your locator is correct ;-). For example:-
264   SET/QRA JO02LQ
265
266 === 0^SET/QTH <your qth>^Set your QTH
267 Tell the system where you are. For example:-
268   SET/QTH East Dereham, Norfolk
269
270 === 0^SET/TALK^Allow TALK messages to come out on your terminal
271 === 0^UNSET/TALK^Stop TALK messages coming out on your terminal
272
273 === 0^SET/WWV^Allow WWV messages to come out on your terminal
274 === 0^UNSET/WWV^Stop WWV messages coming out on your terminal
275
276 === 0^SHOW/DX^Interrogate the spot database
277 If you just type SHOW/DX you will get the last so many spots
278 (sysop configurable, but usually 10).
279    
280 In addition you can add any number of these commands in very nearly
281 any order to the basic SHOW/DX command, they are:-
282    
283 on <band>       - eg 160m 20m 2m 23cm 6mm
284 on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
285    
286 <number>        - the number of spots you want
287 <from>-<to>     - <from> spot no <to> spot no in the selected list
288    
289 <prefix>        - for a spotted callsign beginning with <prefix>
290 *<suffix>       - for a spotted callsign ending in <suffix>
291 *<string>*      - for a spotted callsign containing <string>
292    
293 day <number>    - starting <number> days ago
294 day <from>-<to> - <from> days <to> days ago
295    
296 info <text>     - any spots containing <text> in the info or remarks
297    
298 spotter <call>  - any spots spotted by <call>
299    
300 e.g. 
301    
302    SH/DX 9m0
303    SH/DX on 20m info iota
304    SH/DX 9a on vhf day 30
305   
306 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
307 This command takes the <prefix> (which can be a full or partial 
308 callsign if desired), looks up which internal country number it is
309 and then displays all the spots as per SH/DX for that country.
310    
311 The options for SHOW/DX also apply to this command.   
312 e.g. 
313    
314    SH/DXCC G
315    SH/DXCC W on 20m info iota
316
317 === 0^SHOW/PREFIX <callsign>^Interrogate the prefix database 
318 This command takes the <callsign> (which can be a full or partial 
319 callsign or a prefix), looks up which internal country number 
320 it is and then displays all the relevant prefixes for that country
321 together with the internal country no, the CQ and ITU regions. 
322
323 See also SHOW/DXCC
324
325 === 0^SHOW/WWV^Show last 10 WWV broadcasts
326 === 0^SHOW/WWV <n>^Show last <n> WWV broadcasts
327 Display the most recent WWV information that has been received by the system
328
329 === 5^SHUTDOWN^Shutdown the cluster
330 Shutdown the cluster and disconnect all the users 
331
332 === 0^TALK <call> <text>^Send a text message to another station
333 === 0^TALK <call> > <node> <text>^Send a text message to another station via a node
334 Send a short message to any other station that is visible on the cluster
335 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
336 command, they don't have to be connected locally.
337
338 The second form of TALK is used when other cluster nodes are connected
339 with restricted information. This usually means that they don't send 
340 the user information usually associated with loging on and off the cluster.
341
342 If you know that G3JNB is likly to be present on GB7TLH, but you can only
343 see GB7TLH in the SH/C list but with no users, then you would use the
344 second form of the talk message.
345
346 === 0^WX <text>^Send a weather message to local users
347 === 0^WX FULL <text>^Send a weather message to all cluster users
348 === 5^WX SYSOP <text>^Send a weather message to other clusters only
349 Weather messages can sometimes be useful if you are experiencing an extreme
350 that may indicate enhanced conditions