added some help
[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 <text> is the text of the announcement you wish to broadcast 
16
17 === 0^ANNOUNCE FULL <text>^Send an announcement cluster wide
18 This will send your announcement cluster wide
19
20 === 5^ANNOUNCE SYSOP <text>^Send an announcement to Sysops only
21
22 === 0^APROPOS <string>^Search help database for <string>
23 Search the help database for <string> (it isn't case sensitive), and print
24 the names of all the commands that may be relevant.
25
26 === 0^BYE^Exit from the cluster
27 This will disconnect you from the cluster
28
29 === 5^CONNECT <callsign>^Start a connection to another DX Cluster
30 Start a connection process that will culminate in a new connection to the
31 DX cluster <callsign>. This process creates a new 'client' process which will
32 use the script in /spider/connect/<callsign> to effect the 'chat' exchange
33 necessary to traverse the network(s) to logon to the cluster <callsign>.
34
35 === 5^CATCHUP <node call> All|[<msgno> ...]^Mark a message as sent
36 === 5^UNCATCHUP <node call> All|[msgno> ...]^Unmark a message as sent
37 When you send messages the fact that you have forwarded it to another node 
38 is remembered so that it isn't sent again. When you have a new partner
39 node and you add their callsign to your /spider/msg/forward.pl file, all
40 outstanding non-private messages will be forwarded to them. This may well
41 be ALL the non-private messages. You can prevent this by using these 
42 commmands:-
43
44   catchup GB7DJK all
45   catchup GB7DJK 300 301 302 303 500-510
46         
47 and to undo what you have just done:-
48   
49   uncatchup GB7DJK all
50   uncatchup GB7DJK 300 301 302 303 500-510
51
52 which will arrange for them to be forward candidates again.
53
54 Order is not important.
55
56 === 0^DBAVAIL^Show a list of all the Databases in the system
57 Title says it all really, this command lists all the databases defined
58 in the system. It is also aliased to SHOW/COMMAND.
59
60 === 9^DBCREATE <name>^Create a database entry
61 === 9^DBCREATE <name> chain <name> [<name>..]^Create a chained database entry
62 === 9^DBCREATE <name> remote <node>^Create a remote database entry
63 DBCREATE allows you to define a database in the system. It doesn't actually
64 create anything, just defines it.
65
66 The databases that are created are simple DB_File hash databases, they are 
67 therefore already 'indexed'.
68
69 You can define a local database with the first form of the command eg:
70
71   DBCREATE oblast
72
73 You can also chain databases with the addition of the 'chain' keyword. 
74 This will search each database one after the other. A typical example 
75 is:
76
77   DBCREATE sdx_qsl chain sql_ad
78
79 No checking is done to see if the any of the chained databases exist, in
80 fact it is usually better to do the above staement first then do each of
81 the chained databases.
82
83 Databases can exist offsite. To define a database that lives on another 
84 node do:
85
86   DBCREATE buckmaster remote gb7dxc
87
88 Remote databases cannot be chained; however, the last database in a 
89 a chain can be a remote database eg:
90
91   DBCREATE qsl chain gb7dxc
92
93 To see what databases have been defined do:
94
95   DBAVAIL (or it will have been aliased to SHOW/COMMAND)
96
97 It would be normal for you to add an entry into your local Aliases file
98 to allow people to use the 'SHOW/<dbname>' style syntax. So you would
99 need to add a line like:-
100
101   's' => [
102     ..
103     ..
104     '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
105     ..
106     ..
107    ],
108
109 to allow 
110  
111   SH/BUCK g1tlh
112
113 to work as they may be used to.
114
115 See DBIMPORT for the importing of existing AK1A format data to databases.
116 See DBSHOW for generic database enquiry
117  
118 === 9^DBIMPORT <dbname> <filename>^Import AK1A data into a database
119 If you want to import or update data in bulk to a database you can use
120 this command. It will either create or update entries into an existing
121 database. For example:-
122
123   DBIMPORT oblast /tmp/OBLAST.FUL
124
125 will import the standard OBLAST database that comes with AK1A into the
126 oblast database held locally.
127
128 === 9^DBREMOVE <dbname>^Delete a database
129 DBREMOVE will completely remove a database entry and also delete any data
130 file that is associated with it. 
131
132 There is no warning, no comeback, no safety net. 
133
134 For example:
135
136   DBREMOVE oblast 
137
138 will remove the oblast database from the system and it will also remove
139 the associated datafile.
140
141 I repeat:
142
143 There is no warning, no comeback, no safety net.
144  
145 You have been warned.
146
147 === 0^DBSHOW <dbname> <key>^Display an entry, if it exists, in a database
148 This is the generic user interface to the database to the database system.
149 It is expected that the sysop will add an entry to the local Aliases file
150 so that users can use the more familiar AK1A style of enquiry such as:
151
152   SH/BUCK G1TLH
153
154 but if he hasn't and the database really does exist (use DBAVAIL or
155 SHOW/COMMAND to find out) you can do the same thing with:
156
157   DBSHOW buck G1TLH
158
159 === 9^DEBUG^Set the cluster program into debug mode
160 Executing this command will only have an effect if you are running the cluster
161 in debug mode i.e.
162
163         perl -d cluster.pl
164
165 It will interrupt the cluster just after the debug command has finished.
166 === 0^DIRECTORY^List messages 
167 === 0^DIRECTORY ALL^List all messages
168 === 0^DIRECTORY OWN^List your own messages
169 === 0^DIRECTORY NEW^List all new messages
170 === 0^DIRECTORY TO <call>^List all messages to <call>
171 === 0^DIRECTORY FROM <call>^List all messages from <call>
172 === 0^DIRECTORY SUBJECT <string>^List all messages with <string> in subject
173 === 0^DIRECTORY <nn>^List last <nn> messages
174 === 0^DIRECTORY <from>-<to>^List messages <from> message <to> message 
175 List the messages in the messages directory.
176
177 If there is a 'p' one space after the message number then it is a 
178 personal message. If there is a '-' between the message number and the
179 'p' then this indicates that the message has been read.
180
181 You can use shell escape characters such as '*' and '?' in the <call>
182 fields.
183
184 You can combine some of the various directory commands together eg:-
185
186    DIR TO G1TLH 5
187 or 
188    DIR SUBJECT IOTA 200-250
189
190 You can abbreviate all the commands to one letter and use ak1a syntax:-
191
192    DIR/T G1* 10
193    DIR/S QSL 10-100 5
194
195 === 5^DIRECTORY-^
196 Sysops can see all users' messages.
197
198 === 8^DISCONNECT <call> [<call> ...]^Disconnect a user or cluster
199 Disconnect any <call> connected locally
200
201 === 0^DX [BY <call>] <freq> <call> <remarks>^Send a DX spot
202 This is how you send a DX Spot to other users. You can, in fact, now
203 enter the <freq> and the <call> either way round. 
204
205    DX FR0G 144.600
206    DX 144.600 FR0G
207    DX 144600 FR0G 
208
209 will all give the same result. You can add some remarks to the end
210 of the command and they will be added to the spot.
211
212    DX FR0G 144600 this is a test
213
214 You can credit someone else by saying:-
215
216    DX by G1TLH FR0G 144.600 he isn't on the cluster
217
218 The <freq> is compared against the available bands set up in the 
219 cluster.  See SHOW/BANDS for more information.
220
221 === 9^EXPORT <msgno> <filename>^Export a message to a file
222 Export a message to a file. This command can only be executed on a local
223 console with a fully privileged user. The file produced will be in a form
224 ready to be imported back into the cluster by placing it in the import 
225 directory (/spider/msg/import).
226
227 This command cannot overwrite an existing file. This is to provide some 
228 measure of security. Any files written will owned by the same user as the 
229 main cluster, otherwise you can put the new files anywhere the cluster can
230 access. For example:-
231
232   EXPORT 2345 /tmp/a
233
234 === 9^EXPORT_USERS [<filename>]^Export the users database to ascii
235 Export the users database to a file in ascii format. If no filename
236 is given then it will export the file to /spider/data/user_asc.
237
238 If the file already exists it will be renamed to <filename>.o. In fact
239 up to 5 generations of the file can be kept each one with an extra 'o' on the
240 suffix. 
241
242 BE WARNED: this will write to any file you have write access to. No check is
243 made on the filename (if any) that you specify.
244
245 === 1^FORWARD/OPERNAME <call>^Send out information on this <call> to all clusters
246 This command sends out any information held in the user file which can 
247 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
248 and Homenode. PC41s are only sent for the information that is available.
249  
250 === 0^HELP^The HELP Command
251 HELP is available for a number of commands. The syntax is:-
252
253   HELP <cmd>
254   
255 Where <cmd> is the name of the command you want help on.
256
257 All commands can be abbreviated, so SHOW/DX can be abbreviated
258 to SH/DX, ANNOUNCE can be shortened to AN and so on.
259
260 Look at the APROPOS <string> command which will search the help database
261 for the <string> you specify and give you a list of likely commands
262 to look at with HELP.
263
264 === 5^INIT <node>^Re-initialise a link to an AK1A compatible node
265 This command attempts to re-initialise a link to a (usually) AK1A node
266 that has got confused, usually by a protocol loop of some kind. It may
267 work - but you usually will be better off simply disconnecting it (or
268 better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
269 node>).
270
271 Best of luck - you will need it.
272   
273 === 0^KILL <msgno> [<msgno..]^Delete a message from the local system
274 Delete a message from the local system. You will only be able to
275 delete messages that you have originated or been sent (unless you are
276 the sysop).
277
278 === 5^KILL FULL <msgno> [<msgno..]^Delete a message from the whole cluster
279 Delete a message (usually a 'bulletin') from the whole cluster system. 
280
281 This uses the subject field, so any messages that have exactly the
282 same subject will be deleted. Beware!
283
284 === 0^LINKS^Show which nodes is physically connected
285 This is a quick listing that shows which links are connected and
286 some information about them. See WHO for a list of all connections.
287
288 === 9^LOAD/ALIASES^Reload the command alias table
289 Reload the /spider/cmd/Aliases file after you have editted it. You
290 will need to do this if you change this file whilst the cluster is
291 running in order for the changes to take effect.
292
293 === 9^LOAD/BANDS^Reload the band limits table
294 Reload the /spider/data/bands.pl file if you have changed it manually whilst
295 the cluster is running. 
296
297 === 9^LOAD/BADDX^Reload the bad DX table
298 Reload the /spider/data/baddx.pl file if you have changed it manually whilst
299 the cluster is running. This table contains the DX Calls that, if spotted, 
300 will not be passed on. FR0G and TEST are classic examples.
301
302 === 9^LOAD/BADMSG^Reload the bad msg table
303 Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
304 the cluster is running. This table contains a number of perl regular 
305 expressions which are searched for in the fields targetted of each message. 
306 If any of them match then that message is immediately deleted on receipt. 
307
308 === 9^LOAD/BADWORDS^Reload the bad words table
309 Reload the /spider/data/badwords file if you have changed it manually whilst
310 the cluster is running. This file contains a list of words which, if found
311 on certain text portions of PC protocol, will cause those protocol frames
312 to be rejected. It will all put out a message if any of these words are
313 used on the announce, dx and talk commands. The words can be one or 
314 more on a line, lines starting with '#' are ignored.
315
316 === 9^LOAD/CMD_CACHE^Reload the automatic command cache
317 Normally, if you change a command file in the cmd or local_cmd tree it
318 will automatially be picked up by the cluster program. Sometimes it
319 can get confused if you are doing a lot of moving commands about or
320 delete a command in the local_cmd tree and want to use the normal one
321 again. Execute this command to reset everything back to the state it
322 was just after a cluster restart.
323
324 === 9^LOAD/FORWARD^Reload the msg forwarding routing table
325 Reload the /spider/msg/forward.pl file if you have changed it
326 manually whilst the cluster is running.
327
328 === 9^LOAD/MESSAGES^Reload the system messages file
329 If you change the /spider/perl/Messages file (usually whilst
330 fiddling/writing new commands) you can have them take effect during a
331 cluster session by executing this command. You need to do this if get
332 something like :-
333
334 unknown message 'xxxx' in lang 'en'
335
336 === 9^LOAD/PREFIXES^Reload the prefix table
337 Reload the /spider/data/prefix_data.pl file if you have changed it
338 manually whilst the cluster is running.
339
340 === 5^MERGE <node> [<no spots>/<no wwv>]^Ask for the latest spots and WWV 
341 MERGE allows you to bring your spot and wwv database up to date. By default
342 it will request the last 10 spots and 5 WWVs from the node you select. The 
343 node must be connected locally.
344
345 You can request any number of spots or wwv and although they will be appended
346 to your databases they will not duplicate any that have recently been added 
347 (the last 2 days for spots and last month for WWV data).
348
349 === 9^MSG <cmd> <msgno> [data ... ]^Alter various message parameters
350 Alter message parameters like To, From, Subject, whether private or bulletin
351 or return receipt (RR) is required or whether to keep this message from timing
352 out.
353
354   MSG TO <msgno> <call>     - change TO callsign to <call>
355   MSG FRom <msgno> <call>   - change FROM callsign to <call>
356   MSG PRrivate <msgno>      - set private flag
357   MSG NOPRrivate <msgno>    - unset private flag
358   MSG RR <msgno>            - set RR flag
359   MSG NORR <msgno>          - unset RR flag
360   MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
361   MSG NOKEep <msgno>        - unset the keep flag
362   MSG SUbject <msgno> <new> - change the subject to <new>
363   MSG WAittime <msgno>      - remove any waitting time for this message
364   MSG NOREad <msgno>        - mark message as unread
365   MSG REad <msgno>          - mark message as read
366   MSG QUeue                 - queue any outstanding bulletins
367   MSG QUeue 1               - queue any outstanding private messages
368
369 You can look at the status of a message by using:-
370
371   STAT/MSG <msgno>      
372
373 This will display more information on the message than DIR does.
374    
375 === 8^PC <call> <text>^Send text (eg PC Protocol) to <call>
376 Send some arbitrary text to a locally connected callsign. No
377 processing is done on the text. This command allows you to send PC
378 Protocol to unstick things if problems arise (messages get stuck
379 etc). eg:-
380
381    pc gb7djk PC33^GB7TLH^GB7DJK^400^
382 or 
383    pc G1TLH Try doing that properly!!!
384
385 === 1^PING <node>^Send a ping command to another cluster
386 This command is used to estimate the quality of the link to another cluster. 
387 The time returned is the length of time taken for a PC51 to go to another 
388 cluster and be returned.
389
390 === 0^KILL <msgno> [<msgno> ...]^Remove or erase a message from the system
391 You can get rid of any message to or originating from your callsign using 
392 this command. You can remove more than one message at a time.
393
394 === 5^KILL <from>-<to>^Remove a range of messages from the system
395 === 5^KILL FROM <call>^Remove all messages from a callsign
396 === 5^KILL TO <call>^Remove all messages to a callsign
397 === 5^KILL FULL <msgno> [<msgno]^Remove a message from the entire cluster
398 Remove this message from the entire cluster system as well as your node.
399
400 === 5^KILL^
401 As a sysop you can kill any message on the system.
402
403 === 8^PC <call> <text>^Send arbitrary text to a connected callsign
404 Send any text you like to the callsign requested. This is used mainly to send
405 PC protocol to connected nodes either for testing or to unstick things. 
406
407 You can also use in the same way as a talk command to a connected user but
408 without any processing, added of "from <blah> to <blah" or whatever.
409  
410 === 1^PING <node call>^Find out the delays an a circuit to another node
411 This command will enable sysops to determine the speed of an inter-cluster
412 node. 
413
414 Any visible cluster node can be PINGed.
415
416 === 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
417 This command allows you to send nearly any command to another DX Cluster
418 node that is connected to the system. 
419
420 Whether you get any output is dependant on a) whether the other system knows
421 that the node callsign of this cluster is in fact a node b) whether the
422 other system is allowing RCMDs from this node and c) whether you have
423 permission to send this command at all.
424
425 === 0^READ^Read the next unread personal message addressed to you
426 === 0^READ <msgno>^Read the specified message
427 You can read any messages that are sent as 'non-personal' and also any
428 message either sent by or sent to your callsign.
429
430 === 5^READ-^
431 As a sysop you may read any message on the system
432
433 === 0^REPLY^Reply (privately) to the last message that you have read
434 === 0^REPLY <msgno>^Reply (privately) to the specified message
435 === 0^REPLY B <msgno>^Reply as a Bulletin to the specified message
436 === 0^REPLY NOPrivate <msgno>^Reply as a Bulletin to the specified message
437 === 0^REPLY RR <msgno>^Reply to the specified message with read receipt
438 You can reply to a message and the subject will automatically have
439 "Re:" inserted in front of it, if it isn't already present.
440
441 You can also use all the extra qualifiers such as RR, PRIVATE, 
442 NOPRIVATE, B that you can use with the SEND command (see SEND
443 for further details)
444
445 === 0^SEND <call> [<call> ...]^Send a message to one or more callsigns
446 === 0^SEND RR <call>^Send a message and ask for a read receipt
447 === 0^SEND COPY <msgno> <call>^Send a copy of a  message to someone
448 === 0^SEND PRIVATE <call>^Send a personal message
449 === 0^SEND NOPRIVATE <call>^Send a message to all stations
450 All the SEND commands will create a message which will be sent either to
451 an individual callsign or to one of the 'bulletin' addresses. 
452
453 SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
454 it will mark the message as personal and send it to the cluster node that
455 that callsign is connected to.
456
457 You can have more than one callsign in all of the SEND commands.
458
459 You can have multiple qualifiers so that you can have for example:-
460
461   SEND RR COPY 123 PRIVATE G1TLH G0RDI
462
463 which should send a copy of message 123 to G1TLH and G0RDI and you will
464 receive a read receipt when they have read the message.
465
466 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
467 SP is an alias for SEND PRIVATE
468
469 === 0^SET/ADDRESS <your address>^Record your postal address
470
471 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
472 === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
473
474 === 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
475
476 === 0^SET/BEEP^Add a beep to DX and other messages on your terminal
477 === 0^UNSET/BEEP^Stop beeps for DX and other messages on your terminal
478
479 === 5^SET/CLX <call> [<call>..]^Make the callsign an CLX node
480
481 === 9^SET/DEBUG <name>^Add a debug level to the debug set
482 === 9^UNSET/DEBUG <name>^Remove a debug level from the debug set
483
484 === 0^SET/DX^Allow DX messages to come out on your terminal
485 === 0^UNSET/DX^Stop DX messages coming out on your terminal
486
487 === 0^SET/DXGRID^Allow Grid Squares on the end of DX announcements
488 === 0^UNSET/DXGRID^Stop Grid Squares on the end of DX announcements
489 A standard feature which is enabled in version 1.43 and above is 
490 that if the spotter's grid square is known it is output on the end
491 of a DX announcement (there is just enough room). Some user programs
492 cannot cope with this. You can use this command to reset (or set)
493 this feature.
494
495 === 5^SET/DXNET <call> [<call>..]^Make the callsign an DXNet node
496
497 === 0^SET/ECHO^Make the cluster echo your input
498 === 0^UNSET/ECHO^Stop the cluster echoing your input
499 If you are connected via a telnet session, different implimentations
500 of telnet handle echo differently depending on whether you are 
501 connected via port 23 or some other port. You can use this command
502 to change the setting appropriately. 
503
504 The setting is stored in your user profile.
505
506 YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25.
507
508 === 0^SET/HERE^Tell the system you are present at your terminal
509 === 0^UNSET/HERE^Tell the system you are absent from your terminal
510
511 === 0^SET/HOMENODE <node> ^Set your normal cluster callsign
512 Tell the cluster system where you normally connect to. Any Messages sent
513 to you will normally find their way there should you not be connected.
514 eg:-
515   SET/HOMENODE gb7djk
516
517 === 9^SET/ISOLATE^Isolate a node from the rest of the network
518 Connect a node to your system in such a way that you are a full protocol
519 member of its network and can see all spots on it, but nothing either leaks
520 out from it nor goes back into from the rest of the nodes connected to you.
521
522 You can potentially connect several nodes in this way.
523  
524 === 9^UNSET/ISOLATE^Stop Isolation of a node from the rest of the network
525 Remove isolation from a node - SET/ISOLATE
526
527 === 0^SET/LANGUAGE <lang>^Set the language you want to use
528 You can select the language that you want the cluster to use. Currently
529 the languages available are en (english) and nl (dutch).
530
531 === 0^SET/LOCATION <lat & long>^Set your latitude and longitude
532 === 9^SET/SYS_LOCATION <lat & long>^Set your cluster latitude and longitude
533 In order to get accurate headings and such like you must tell the system
534 what your latitude and longitude is. If you have not yet done a SET/QRA
535 then this command will set your QRA locator for you. For example:-
536   SET/LOCATION 52 22 N 0 57 E
537
538 === 0^SET/LOGININFO^Inform when a station logs in locally
539 === 0^UNSET/LOGININFO^Inform when a station logs out locally
540
541 === 9^SET/LOCKOUT <call>^Stop a callsign connecting to the cluster
542 === 9^UNSET/LOCKOUT <call>^Allow a callsign to connect to the cluster
543
544 === 0^SET/NAME <your name>^Set your name
545 Tell the system what your name is eg:-
546   SET/NAME Dirk
547
548 === 5^SET/NODE <call> [<call>..]^Make the callsign an AK1A cluster
549 Tell the system that the call(s) are to be treated as AK1A cluster and
550 fed PC Protocol rather normal user commands.
551
552 === 8^SET/OBSCOUNT <count> <nodecall>^Set the 'pump-up' obscelence counter 
553 From 1.35 onwards neighbouring nodes are pinged at regular intervals (see
554 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
555 counter which is decremented on every outgoing ping and then reset to
556 the 'obscount' value on every incoming ping. The default value of this
557 parameter is 2. 
558
559 What this means is that a neighbouring node will be pinged twice at 
560 (default) 300 second intervals and if no reply has been heard just before
561 what would be the third attempt, that node is disconnected.
562
563 If a ping is heard then the obscount is reset to the full value. Using
564 default values, if a node has not responded to a ping within 15 minutes,
565 it is disconnected.
566
567 === 0^SET/PAGE <lines per page>^Set the lines per page
568 Tell the system how many lines you wish on a page when the number of line
569 of output from a command is more than this. The default is 20. Setting it
570 explicitly to 0 will disable paging. 
571   SET/PAGE 30
572   SET/PAGE 0
573
574 The setting is stored in your user profile.
575
576 === 9^SET/PINGINTERVAL <time> <nodecall>^Set ping time to neighbouring nodes 
577 As from release 1.35 all neighbouring nodes are pinged at regular intervals
578 in order to determine the rolling quality of the link and, in future, to
579 affect routing decisions. The default interval is 300 secs or 5 minutes.
580
581 You can use this command to set a different interval. Please don't. 
582
583 But if you do the value you enter is treated as minutes up 60 and seconds
584 for numbers greater than that.
585
586 This is used also to help determine when a link is down at the far end
587 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
588 for more information.
589
590 === 9^SET/PRIVILEGE <n> <call> [<call..]^Set privilege level on a call
591 Set the privilege level on a callsign. The privilege levels that pertain
592 to commands are as default:-
593   0 - normal user
594   1 - allow remote nodes normal user RCMDs
595   5 - various privileged commands (including shutdown, but not disc-
596       connect), the normal level for another node.
597   8 - more privileged commands (including disconnect)
598   9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
599       LEVEL.
600 If you are a sysop and you come in as a normal user on a remote connection
601 your privilege will automatically be set to 0.
602
603 === 9^SET/PASSWORD <callsign> <string>^Set a users password
604 The password for a user can only be set by a full sysop. The string
605 can contain any characters but any spaces are removed (you can type in
606 spaces - but they won't appear in the password). You can see the
607 result with STAT/USER.
608
609 === 5^SET/SPIDER <call> [<call>..]^Make the callsign an DXSpider node
610 Tell the system that the call(s) are to be treated as DXSpider node and
611 fed new style DX Protocol rather normal user commands.
612
613 === 9^SET/SYS_QRA <locator>^Set your cluster QRA locator
614 === 0^SET/QRA <locator>^Set your QRA locator
615 Tell the system what your QRA (or Maidenhead) locator is. If you have not
616 done a SET/LOCATION then your latitude and longitude will be set roughly
617 correctly (assuming your locator is correct ;-). For example:-
618   SET/QRA JO02LQ
619
620 === 0^SET/QTH <your qth>^Set your QTH
621 Tell the system where you are. For example:-
622   SET/QTH East Dereham, Norfolk
623
624 === 0^SET/TALK^Allow TALK messages to come out on your terminal
625 === 0^UNSET/TALK^Stop TALK messages coming out on your terminal
626
627 === 0^SET/WCY^Allow WCY messages to come out on your terminal
628 === 0^UNSET/WCY^Stop WCY messages coming out on your terminal
629
630 === 0^SET/WWV^Allow WWV messages to come out on your terminal
631 === 0^UNSET/WWV^Stop WWV messages coming out on your terminal
632
633 === 0^SET/WX^Allow WX messages to come out on your terminal
634 === 0^UNSET/WX^Stop WX messages coming out on your terminal
635
636 === 0^SHOW/CALL <callsign>^Show any callbook details on a callsign
637 This command queries an international callbook server on the internet
638 and returns any information available for that callsign. 
639
640 === 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
641 This is very nearly the same as SHOW/TIME, the only difference the format
642 of the date string if no arguments are given.
643
644 If no prefixes or callsigns are given then this command returns the local
645 time and UTC as the computer has it right now. If you give some prefixes
646 then it will show UTC and UTC + the local offset (not including DST) at
647 the prefixes or callsigns that you specify.
648
649 === 0^SHOW/DX^Interrogate the spot database
650 If you just type SHOW/DX you will get the last so many spots
651 (sysop configurable, but usually 10).
652    
653 In addition you can add any number of these commands in very nearly
654 any order to the basic SHOW/DX command, they are:-
655    
656 on <band>       - eg 160m 20m 2m 23cm 6mm
657 on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
658    
659 <number>        - the number of spots you want
660 <from>-<to>     - <from> spot no <to> spot no in the selected list
661    
662 <prefix>        - for a spotted callsign beginning with <prefix>
663 *<suffix>       - for a spotted callsign ending in <suffix>
664 *<string>*      - for a spotted callsign containing <string>
665    
666 day <number>    - starting <number> days ago
667 day <from>-<to> - <from> days <to> days ago
668    
669 info <text>     - any spots containing <text> in the info or remarks
670    
671 by <call>       - any spots spotted by <call> (spotter <call> is the 
672                   same).
673
674 qsl             - this automatically looks for any qsl info on the call
675                   held in the spot database.
676
677 iota [<iota>]   - If the iota island number is missing it will look for
678                   the string iota and anything which looks like an iota
679                   island number. If you specify then it will look for  
680                   that island.
681
682 qra [<locator>] - this will look for the specific locator if you specify
683                   one or else anything that looks like a locator.
684    
685 e.g. 
686    
687    SH/DX 9m0
688    SH/DX on 20m info iota
689    SH/DX 9a on vhf day 30
690    SH/DX rf1p qsl
691    SH/DX iota 
692    SH/DX iota eu-064
693    SH/DX qra jn86
694   
695 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
696 This command takes the <prefix> (which can be a full or partial 
697 callsign if desired), looks up which internal country number it is
698 and then displays all the spots as per SH/DX for that country.
699    
700 The options for SHOW/DX also apply to this command.   
701 e.g. 
702    
703    SH/DXCC G
704    SH/DXCC W on 20m info iota
705
706 === 0^SHOW/FILES [<filearea> [<string>]]^List the contents of a filearea
707 SHOW/FILES on its own will show you a list of the various fileareas
708 available on the system. To see the contents of a particular file
709 area type:-
710    SH/FILES <filearea>
711 where <filearea> is the name of the filearea you want to see the 
712 contents of.
713
714 You can also use shell globbing characters like '*' and '?' in a
715 string to see a selection of files in a filearea eg:-
716    SH/FILES bulletins arld*
717
718 See also TYPE - to see the contents of a file.
719
720 === 1^SHOW/ISOLATE^Show list of ISOLATED nodes
721
722 === 9^SHOW/LOCKOUT^Show the list of locked out or excluded callsigns
723
724 === 0^SHOW/MOON [<prefix>|<callsign>]^Show Moon rise and set times
725 Show the Moon rise and set times for a (list of) prefixes or callsigns, 
726 together with the azimuth and elevation of the sun currently at those
727 locations.
728
729 If you don't specify any prefixes or callsigns, it will show the times for
730 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
731 together with the current azimuth and elevation.
732
733 In addition, it will show the gain or loss dB relative to the nominal 
734 distance of 385,000Km due to the ellipsoidal nature of the orbit.
735
736 If all else fails it will show the Moonrise and set times for the node
737 that you are connected to. 
738
739 For example:-
740
741   SH/MOON
742   SH/MOON G1TLH W5UN
743
744 === 0^SHOW/MUF <prefix> [<hours>][long]^Show the likely propagation to a prefix
745 This command allow you to estimate the likelihood of you contacting
746 a station with the prefix you have specified. The output assumes a modest
747 power of 20dBW and receiver sensitivity of -123dBm (about 0.15muV/10dB SINAD)
748
749 The result predicts the most likely operating frequencies and signal
750 levels for high frequency (shortwave) radio propagation paths on
751 specified days of the year and hours of the day. It is most useful for
752 paths between 250 km and 6000 km, but can be used with reduced accuracy
753 for paths shorter or longer than this.
754
755 The command uses a routine MINIMUF 3.5 developed by the U.S. Navy and
756 used to predict the MUF given the predicted flux, day of the year,
757 hour of the day and geographic coordinates of the transmitter and
758 receiver. This routine is reasonably accurate for the purposes here,
759 with a claimed RMS error of 3.8 MHz, but much smaller and less complex
760 than the programs used by major shortwave broadcasting organizations,
761 such as the Voice of America.
762
763 The command will display some header information detailing its
764 assumptions, together with the locations, latitude and longitudes and
765 bearings. It will then show UTC (UT), local time at the other end
766 (LT), calculate the MUFs, Sun zenith angle at the midpoint of the path
767 (Zen) and the likely signal strengths. Then for each frequency for which
768 the system thinks there is a likelihood of a circuit it prints a value.
769
770 The value is currently a likely S meter reading based on the conventional
771 6dB / S point scale. If the value has a '+' appended it means that it is
772 1/2 an S point stronger. If the value is preceeded by an 'm' it means that
773 there is likely to be much fading and by an 's' that the signal is likely
774 to be noisy.  
775
776 By default SHOW/MUF will show the next two hours worth of data. You
777 can specify anything up to 24 hours worth of data by appending the no of
778 hours required after the prefix. For example:-
779
780   SH/MUF W
781
782 produces:
783
784   RxSens: -123 dBM SFI: 159   R: 193   Month: 10   Day: 21
785   Power :   20 dBW    Distance:  6283 km    Delay: 22.4 ms
786   Location                       Lat / Long           Azim
787   East Dereham, Norfolk          52 41 N 0 57 E         47
788   United-States-W                43 0 N 87 54 W        299
789   UT LT  MUF Zen  1.8  3.5  7.0 10.1 14.0 18.1 21.0 24.9 28.0 50.0
790   18 23 11.5 -35  mS0+ mS2   S3
791   19  0 11.2 -41  mS0+ mS2   S3
792
793 indicating that you will have weak, fading circuits on top band and 
794 80m but usable signals on 40m (about S3).
795
796 inputing:-
797
798   SH/MUF W 24
799
800 will get you the above display, but with the next 24 hours worth of
801 propagation data.
802
803   SH/MUF W L 24
804   SH/MUF W 24 Long
805
806 Gives you an estimate of the long path propagation characterics. It
807 should be noted that the figures will probably not be very useful, nor
808 terrible accurate, but it is included for completeness.
809
810 === 1^SHOW/NODE [<callsign> ...]^Show the type and version number of nodes
811 Show the type and version (if connected) of the nodes specified on the
812 command line. If no callsigns are specified then a sorted list of all
813 the non-user callsigns known to the system will be displayed.
814
815 === 0^SHOW/PREFIX <callsign>^Interrogate the prefix database 
816 This command takes the <callsign> (which can be a full or partial 
817 callsign or a prefix), looks up which internal country number 
818 it is and then displays all the relevant prefixes for that country
819 together with the internal country no, the CQ and ITU regions. 
820
821 See also SHOW/DXCC
822
823 === 5^SHOW/PROGRAM^Show the locations of all the included program modules
824 Show the name and location where every program module was load from. This
825 is useful for checking where you think you have loaded a .pm file from. 
826
827 === 0^SHOW/QRA <locator> [<locator>]^Show distance between locators
828 === 0^SHOW/QRA <lat> <long>^Convert latitude and longitude to a locator
829 This is a multipurpose command that allows you either to calculate the
830 distance and bearing between two locators or (if only one locator is
831 given on the command line) the distance and beraing from your station
832 to the locator. For example:-
833
834 SH/QRA IO92QL 
835 SH/QRA JN06 IN73
836
837 The first example will show the distance and bearing to the locator from
838 yourself, the second example will calculate the distance and bearing from
839 the first locator to the second. You can use 4 or 6 character locators.
840
841 It is also possible to convert a latitude and longitude to a locator by 
842 using this command with a latitude and longitude as an argument, for
843 example:-
844
845 SH/QRA 52 41 N 0 58 E
846
847 === 0^SHOW/SATELLITE <name> [<hours> <interval>]^Show tracking data
848 Show the tracking data from your location to the satellite of your choice
849 from now on for the next few hours.
850
851 If you use this command without a satellite name it will display a list
852 of all the satellites known currently to the system. 
853
854 If you give a name then you can obtain tracking data of all the passes
855 that start and finish 5 degrees below the horizon. As default it will
856 give information for the next three hours for every five minute period.
857
858 You can alter the number of hours and the step size, within certain 
859 limits. 
860
861 Each pass in a period is separated with a row of '-----' characters
862
863 So for example:-
864
865 SH/SAT AO-10 
866 SH/SAT FENGYUN1 12 2
867
868 === 0^SHOW/SUN [<prefix>|<callsign>]^Show sun rise and set times
869 Show the sun rise and set times for a (list of) prefixes or callsigns, 
870 together with the azimuth and elevation of the sun currently at those
871 locations.
872
873 If you don't specify any prefixes or callsigns, it will show the times for
874 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
875 together with the current azimuth and elevation.
876
877 If all else fails it will show the sunrise and set times for the node
878 that you are connected to. 
879
880 For example:-
881
882   SH/SUN
883   SH/SUN G1TLH K9CW ZS
884
885 === 0^SHOW/TIME [<prefix>|<callsign>]^Show the local time 
886 If no prefixes or callsigns are given then this command returns the local
887 time and UTC as the computer has it right now. If you give some prefixes
888 then it will show UTC and UTC + the local offset (not including DST) at
889 the prefixes or callsigns that you specify.
890
891 === 0^SHOW/WCY^Show last 10 WCY broadcasts
892 === 0^SHOW/WCY <n>^Show last <n> WCY broadcasts
893 Display the most recent WCY information that has been received by the system
894
895 === 0^SHOW/WWV^Show last 10 WWV broadcasts
896 === 0^SHOW/WWV <n>^Show last <n> WWV broadcasts
897 Display the most recent WWV information that has been received by the system
898
899 === 5^SHUTDOWN^Shutdown the cluster
900 Shutdown the cluster and disconnect all the users 
901
902 === 9^SPOOF <call> <command>^Do a command as though you are another user
903 This command is provided so that sysops can set a user's parameters without
904 me having to write a special 'sysop' version for every user command. It
905 allows you to pretend that you are doing the command as the user you specify.
906
907 eg:-
908
909    SPOOF G1TLH set/name Dirk
910    SPOOF G1TLH set/qra JO02LQ
911
912 === 5^STAT/DB <dbname>^Show the status of a database
913 Show the internal status of a database descriptor.
914
915 Depending on your privilege level you will see more or less information. 
916 This command is unlikely to be of much use to anyone other than a sysop.
917
918 === 5^STAT/CHANNEL [<callsign>]^Show the status of a channel on the cluster
919 Show the internal status of the channel object either for the channel that 
920 you are on or else for the callsign that you asked for.
921
922 Only the fields that are defined (in perl term) will be displayed.
923
924 === 5^STAT/MSG <msgno>^Show the status of a message
925 This command shows the internal status of a message and includes information
926 such as to whom it has been forwarded, its size, origin etc etc.
927
928 === 5^STAT/USER [<callsign>]^Show the full status of a user
929 Shows the full contents of a user record including all the secret flags
930 and stuff.
931
932 Only the fields that are defined (in perl term) will be displayed.
933
934 === 0^SYSOP^Regain your privileges if you login remotely
935 The system automatically reduces your privilege level to that of a
936 normal user if you login in remotely. This command allows you to
937 regain your normal privilege level. It uses the normal system: five
938 numbers are returned that are indexes into the character array that is
939 your assigned password (see SET/PASSWORD). The indexes start from
940 zero.
941
942 You are expected to return a string which contains the characters
943 required in the correct order. You may intersperse those characters
944 with others to obscure your reply for any watchers. For example (and
945 these values are for explanation :-):
946
947   password = 012345678901234567890123456789
948   > sysop
949   22 10 15 17 3
950 you type:-
951  aa2bbbb0ccc5ddd7xxx3n
952  or 2 0 5 7 3
953  or 20573
954
955 They will all match. If there is no password you will still be offered
956 numbers but nothing will happen when you input a string. Any match is
957 case sensitive.
958
959 === 0^TALK <call> [<text>]^Send a text message to another station
960 === 0^TALK <call> > <node> [<text>]^Send a text message to another station via a node
961 Send a short message to any other station that is visible on the cluster
962 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
963 command, they don't have to be connected locally.
964
965 The second form of TALK is used when other cluster nodes are connected
966 with restricted information. This usually means that they don't send 
967 the user information usually associated with logging on and off the cluster.
968
969 If you know that G3JNB is likely to be present on GB7TLH, but you can only
970 see GB7TLH in the SH/C list but with no users, then you would use the
971 second form of the talk message.
972
973 If you want to have a ragchew with someone you can leave the text message
974 out and the system will go into 'Talk' mode. What this means is that a
975 short message is sent to the recipient telling them that you are in a
976 'Talking' frame of mind and then you just type - everything you send will
977 go to the station that you asked for. 
978
979 All the usual announcements, spots and so on will still come out on your
980 terminal.
981
982 If you want to do something (such as send a spot) you preceed the normal 
983 command with a '/' character, eg:-
984
985    /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
986    /HELP talk
987
988 To leave talk mode type:
989    
990    /EX
991
992 === 0^TYPE <filearea>/<name>^Look at the contents of a file in one of the fileareas
993 Type out the contents of a file in a filearea. So, for example, in 
994 filearea 'bulletins' you want to look at file 'arld051' you would 
995 enter:-
996    TYPE bulletins/arld051
997
998 See also SHOW/FILES to see what fileareas are available and a 
999 list of content.
1000
1001 === 0^WHO^Show who is physically connected
1002 This is a quick listing that shows which callsigns are connected and
1003 what sort of connection they have
1004
1005 === 0^WX <text>^Send a weather message to local users
1006 === 0^WX FULL <text>^Send a weather message to all cluster users
1007 === 5^WX SYSOP <text>^Send a weather message to other clusters only
1008 Weather messages can sometimes be useful if you are experiencing an extreme
1009 that may indicate enhanced conditions
1010