1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
4 <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
5 <TITLE>The DXSpider Installation and Administration Manual : Sysop commands</TITLE>
6 <LINK HREF="adminmanual-9.html" REL=previous>
7 <LINK HREF="adminmanual.html#toc10" REL=contents>
11 <A HREF="adminmanual-9.html">Previous</A>
12 <A HREF="adminmanual.html#toc10">Contents</A>
14 <H2><A NAME="s10">10. Sysop commands</A></H2>
16 <P>Most maintenance tasks are automatic but there are some commands that are useful for a sysop. These are listed below
17 in alphabetical order. The number in brackets following the command name is the permissions level needed to use the command.
19 <H2><A NAME="ss10.1">10.1 announce sysop (5)</A>
22 <P><CODE><B>announce sysop <text></B></CODE>
24 <P>Send an announcement to Sysops only
26 <H2><A NAME="ss10.2">10.2 connect (5) </A>
29 <P><CODE><B>connect <callsign></B> Start a connection to another DX Cluster</CODE>
31 <P>Start a connection process that will culminate in a new connection to the
32 DX cluster <callsign>. This process creates a new 'client' process which will
33 use the script in /spider/connect/<callsign> to effect the 'chat' exchange
34 necessary to traverse the network(s) to logon to the cluster <callsign>.
37 <H2><A NAME="ss10.3">10.3 catch (9) </A>
40 <P><CODE><B><node_call> All [<msgno> ...]</B> Mark a message as sent</CODE>
42 <P>When you send messages the fact that you have forwarded it to another node
43 is remembered so that it isn't sent again. When you have a new partner
44 node and you add their callsign to your /spider/msg/forward.pl file, all
45 outstanding non-private messages will be forwarded to them. This may well
46 be ALL the non-private messages. You can prevent this by using these
49 catch GB7DJK 300 301 302 303
50 <P>and to undo what you have just done:-
52 uncatch GB7DJK 300 301 302 303
53 <P>which will arrange for them to be forward candidates again.
55 <H2><A NAME="ss10.4">10.4 dbcreate (9)</A>
58 <P><CODE><B>dbcreate <name></B> Create a database entry<BR>
59 <B>dbcreate <name> chain <name> [<name>..]</B> Create a chained database entry<BR>
60 <B>dbcreate <name> remote <node></B> Create a remote database entry<BR></CODE>
62 <P>DBCREATE allows you to define a database in the system. It doesn't actually
63 create anything, just defines it.
64 <P>The databases that are created are simple DB_File hash databases, they are
65 therefore already 'indexed'.
66 <P>You can define a local database with the first form of the command eg:
68 <P>You can also chain databases with the addition of the 'chain' keyword.
69 This will search each database one after the other. A typical example
71 <P>DBCREATE sdx_qsl chain sql_ad
72 <P>No checking is done to see if the any of the chained databases exist, in
73 fact it is usually better to do the above statement first then do each of
74 the chained databases.
75 <P>Databases can exist offsite. To define a database that lives on another
77 <P>DBCREATE buckmaster remote gb7dxc
78 <P>Remote databases cannot be chained; however, the last database in a
79 a chain can be a remote database eg:
80 <P>DBCREATE qsl chain gb7dxc
81 <P>To see what databases have been defined do:
82 <P>DBAVAIL (or it will have been aliased to SHOW/COMMAND)
83 <P>It would be normal for you to add an entry into your local Aliases file
84 to allow people to use the 'SHOW/<dbname>' style syntax. So you would
85 need to add a line like:-
92 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
100 <P>to work as they may be used to.
101 <P>See DBIMPORT for the importing of existing AK1A format data to databases.
102 See DBSHOW for generic database enquiry
104 <H2><A NAME="ss10.5">10.5 dbimport (9)</A>
107 <P><CODE><B>dbimport <dbname></B> Import AK1A data into a database</CODE>
109 <P>If you want to import or update data in bulk to a database you can use
110 this command. It will either create or update entries into an existing
111 database. For example:-
112 <P>DBIMPORT oblast /tmp/OBLAST.FUL
113 <P>will import the standard OBLAST database that comes with AK1A into the
114 oblast database held locally.
116 <H2><A NAME="ss10.6">10.6 dbremove (9)</A>
119 <P><CODE><B>dbremove <dbname></B> Delete a database</CODE>
121 <P>DBREMOVE will completely remove a database entry and also delete any data
122 file that is associated with it.
123 <P>There is no warning, no comeback, no safety net.
126 <P>will remove the oblast database from the system and it will also remove
127 the associated datafile.
129 <P>There is no warning, no comeback, no safety net.
130 <P>You have been warned.
132 <H2><A NAME="ss10.7">10.7 debug (9)</A>
135 <P><CODE><B>debug</B> Set the cluster program into debug mode</CODE>
137 <P>Executing this command will only have an effect if you are running the cluster
145 <P>It will interrupt the cluster just after the debug command has finished.
147 <H2><A NAME="ss10.8">10.8 directory (5)</A>
150 <P>Works just like the user command except that sysops can see ALL messages.
152 <H2><A NAME="ss10.9">10.9 disconnect (8)</A>
155 <P><CODE><B>disconnect <call> [<call> ...]</B> Disconnect a user or node</CODE>
157 <P>Disconnect any <call> connected locally
159 <H2><A NAME="ss10.10">10.10 export (9)</A>
162 <P><CODE><B>export <msgno> <filename></B> Export a message to a file</CODE>
164 <P>Export a message to a file. This command can only be executed on a local
165 console with a fully privileged user. The file produced will be in a form
166 ready to be imported back into the cluster by placing it in the import
167 directory (/spider/msg/import).
168 <P>This command cannot overwrite an existing file. This is to provide some
169 measure of security. Any files written will owned by the same user as the
170 main cluster, otherwise you can put the new files anywhere the cluster can
171 access. For example:-
172 <P>EXPORT 2345 /tmp/a
174 <H2><A NAME="ss10.11">10.11 forward/opername (1)</A>
177 <P><CODE><B>forward/opername <call></B> Send out information on this <call> to all clusters</CODE>
179 <P>This command sends out any information held in the user file which can
180 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
181 and Homenode. PC41s are only sent for the information that is available.
183 <H2><A NAME="ss10.12">10.12 init (5)</A>
186 <P><CODE><B>init <node call></B> Re-initialise a link to an AK1A compatible node</CODE>
188 <P>This command attempts to re-initialise a link to a (usually) AK1A node
189 that has got confused, usually by a protocol loop of some kind. It may
190 work - but you usually will be better off simply disconnecting it (or
191 better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
193 <P>Best of luck - you will need it.
195 <H2><A NAME="ss10.13">10.13 kill (5)</A>
198 <P><CODE><B>kill <msgno> [<msgno> ...]</B> Remove or erase a message from the system<BR>
199 <B>kill from <call></B> Remove all messages from a callsign<BR>
200 <B>kill to <call></B> Remove all messages to a callsign<BR></CODE>
202 <P>You can get rid of any message to or originating from your callsign using
203 this command. You can remove more than one message at a time.
204 <P>As a sysop you can kill any message on the system.
206 <H2><A NAME="ss10.14">10.14 kill full (5)</A>
207 <CODE><B>kill full <msgno> [<msgno>]</B> Delete a message from the whole cluster</CODE></H2>
209 <P>Delete a message (usually a 'bulletin') from the whole cluster system.
210 <P>This uses the subject field, so any messages that have exactly the same subject
211 will be deleted. Beware!
213 <H2><A NAME="ss10.15">10.15 load/aliases (9)</A>
216 <P><CODE><B>load/aliases</B> Reload the command alias table</CODE>
218 <P>Reload the /spider/cmd/Aliases file after you have editted it. You will need to
219 do this if you change this file whilst the cluster is running in order for the
220 changes to take effect.
222 <H2><A NAME="ss10.16">10.16 load/baddx (9)</A>
223 <CODE><B>load/baddx</B> Reload the bad DX table</CODE></H2>
225 <P>Reload the /spider/data/baddx.pl file if you have changed it manually whilst
226 the cluster is running. This table contains the DX Calls that, if spotted,
227 will not be passed on. FR0G and TEST are classic examples.
229 <H2><A NAME="ss10.17">10.17 load/badmsg (9)</A>
232 <P><CODE><B>load/badmsg</B> Reload the bad message table</CODE>
234 <P>Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
235 the cluster is running. This table contains a number of perl regular
236 expressions which are searched for in the fields targetted of each message.
237 If any of them match then that message is immediately deleted on receipt.
239 <H2><A NAME="ss10.18">10.18 load/badwords (9)</A>
242 <P><CODE><B>load/badwords</B> Reload the badwords file</CODE>
244 <P>Reload the /spider/data/badwords file if you have changed it manually whilst
245 the cluster is running. This file contains a list of words which, if found
246 on certain text portions of PC protocol, will cause those protocol frames
247 to be rejected. It will all put out a message if any of these words are
248 used on the announce, dx and talk commands. The words can be one or
249 more on a line, lines starting with '#' are ignored.
251 <H2><A NAME="ss10.19">10.19 load/bands (9)</A>
254 <P><CODE><B>load/bands</B> Reload the band limits table</CODE>
256 <P>Reload the /spider/data/bands.pl file if you have changed it manually whilst
257 the cluster is running.
259 <H2><A NAME="ss10.20">10.20 load/cmd_cache (9)</A>
262 <P><CODE><B>load/cmd_cache</B> Reload the automatic command cache</CODE>
264 <P>Normally, if you change a command file in the cmd or local_cmd tree it will
265 automatially be picked up by the cluster program. Sometimes it can get confused
266 if you are doing a lot of moving commands about or delete a command in the
267 local_cmd tree and want to use the normal one again. Execute this command to
268 reset everything back to the state it was just after a cluster restart.
270 <H2><A NAME="ss10.21">10.21 load/forward (9)</A>
273 <P><CODE><B>load/forward</B> Reload the msg forwarding routing table</CODE>
274 <P>Reload the /spider/msg/forward.pl file if you have changed it
275 manually whilst the cluster is running.
277 <H2><A NAME="ss10.22">10.22 load/messages (9)</A>
280 <P><CODE><B>load/messages</B> Reload the system messages file</CODE>
282 <P>If you change the /spider/perl/Messages file (usually whilst fiddling/writing ne
283 commands) you can have them take effect during a cluster session by executing this
284 command. You need to do this if get something like :-
285 <P>unknown message 'xxxx' in lang 'en'
287 <H2><A NAME="ss10.23">10.23 load/prefixes (9)</A>
290 <P><CODE><B>load/prefixes</B> Reload the prefix table</CODE>
292 <P>Reload the /spider/data/prefix_data.pl file if you have changed it manually whilst
293 the cluster is running.
295 <H2><A NAME="ss10.24">10.24 merge (5)</A>
298 <P><CODE><B>merge <node> [<no spots>/<no wwv>]</B> Ask for the latest spots and WWV</CODE>
300 <P>MERGE allows you to bring your spot and wwv database up to date. By default
301 it will request the last 10 spots and 5 WWVs from the node you select. The
302 node must be connected locally.
303 <P>You can request any number of spots or wwv and although they will be appended
304 to your databases they will not duplicate any that have recently been added
305 (the last 2 days for spots and last month for WWV data).
307 <H2><A NAME="ss10.25">10.25 msg (9)</A>
310 <P><CODE><B>msg <cmd> <msgno> [data ...]</B> Alter various message parameters</CODE>
312 <P>Alter message parameters like To, From, Subject, whether private or bulletin
313 or return receipt (RR) is required or whether to keep this message from timing
318 MSG TO <msgno> <call> - change TO callsign to <call>
319 MSG FRom <msgno> <call> - change FROM callsign to <call>
320 MSG PRrivate <msgno> - set private flag
321 MSG NOPRrivate <msgno> - unset private flag
322 MSG RR <msgno> - set RR flag
323 MSG NORR <msgno> - unset RR flag
324 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
325 MSG NOKEep <msgno> - unset the keep flag
326 MSG SUbject <msgno> <new> - change the subject to <new>
327 MSG WAittime <msgno> - remove any waitting time for this message
328 MSG NOREad <msgno> - mark message as unread
329 MSG REad <msgno> - mark message as read
330 MSG QUeue - queue any outstanding bulletins
331 MSG QUeue 1 - queue any outstanding private messages
334 <P>You can look at the status of a message by using:-
335 <P>STAT/MSG <msgno>
336 <P>This will display more information on the message than DIR does.
338 <H2><A NAME="ss10.26">10.26 pc (8)</A>
341 <P><CODE><B>pc <call> <text></B> Send text (eg PC Protocol) to <call></CODE>
343 <P>Send some arbitrary text to a locally connected callsign. No processing is done on
344 the text. This command allows you to send PC Protocol to unstick things if problems
345 arise (messages get stuck etc). eg:-
346 <P>pc gb7djk PC33^GB7TLH^GB7DJK^400^
347 <P>You can also use in the same way as a talk command to a connected user but
348 without any processing, added of "from <blah> to <blah>" or whatever.
349 <P>pc G1TLH Try doing that properly!!!
351 <H2><A NAME="ss10.27">10.27 ping (1)</A>
354 <P><CODE><B>ping <node></B> Send a ping command to another cluster node</CODE>
356 <P>This command is used to estimate the quality of the link to another cluster.
357 The time returned is the length of time taken for a PC51 to go to another
358 cluster and be returned.
359 <P>Any visible cluster node can be PINGed.
361 <H2><A NAME="ss10.28">10.28 rcmd (1)</A>
364 <P><CODE><B>rcmd <node call> <cmd></B> Send a command to another DX cluster</CODE>
366 <P>This command allows you to send nearly any command to another DX Cluster
367 node that is connected to the system.
368 <P>Whether you get any output is dependant on a) whether the other system knows
369 that the node callsign of this cluster is in fact a node b) whether the
370 other system is allowing RCMDs from this node and c) whether you have
371 permission to send this command at all.
373 <H2><A NAME="ss10.29">10.29 read (5)</A>
376 <P><CODE><B>read <msgno></B> Read a message on the system</CODE>
378 <P>As a sysop you may read any message on the system
380 <H2><A NAME="ss10.30">10.30 set/debug (9)</A>
383 <P><CODE><B>set/debug <name></B> Add a debug level to the debug set</CODE>
385 <P>You can remove this level with unset/debug <name>
387 <H2><A NAME="ss10.31">10.31 set/isolate (9)</A>
390 <P><CODE><B>set/isolate <node call></B> Isolate a node from the rest of the network</CODE>
392 <P>Connect a node to your system in such a way that you are a full protocol
393 member of its network and can see all spots on it, but nothing either leaks
394 out from it nor goes back into from the rest of the nodes connected to you.
395 <P>You can potentially connect several nodes in this way.
396 <P>You can see which nodes are isolated with the show/isolate (1) command.
397 <P>You can remove the isolation with the command unset/isolate.
399 <H2><A NAME="ss10.32">10.32 set/sys_location (9)</A>
402 <P><CODE><B>set/sys_location <lat & long></B> Set your cluster latitude and longitude</CODE>
404 <P>In order to get accurate headings and such like you must tell the system
405 what your latitude and longitude is. If you have not yet done a SET/QRA
406 then this command will set your QRA locator for you. For example:-
407 <P>SET/LOCATION 52 22 N 0 57 E
409 <H2><A NAME="ss10.33">10.33 set/lockout (9)</A>
412 <P><CODE><B>set/lockout <call></B> Stop a callsign connecting to the cluster</CODE>
414 <P>You can show who is locked out with the show/lockout (9) command.
415 <P>To allow the user to connect again, use the command unset/lockout
417 <H2><A NAME="ss10.34">10.34 set/node (9)</A>
420 <P><CODE><B>set/node <call> [<call> ...]</B> Make the callsign an AK1A cluster</CODE>
422 <P>Tell the system that the call(s) are to be treated as AK1A cluster and
423 fed PC Protocol rather normal user commands.
424 <P>From version 1.41 you can also set the following types of cluster
432 <P>To see what your nodes are set to, use the show/nodes command.
434 <H2><A NAME="ss10.35">10.35 set/obscount (9)</A>
437 <P><CODE><B>set/obscount <count> <node call></B> Set the 'pump-up' obscelence counter</CODE>
439 <P>From version 1.35 onwards neighbouring nodes are pinged at regular intervals (see
440 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
441 counter which is decremented on every outgoing ping and then reset to
442 the 'obscount' value on every incoming ping. The default value of this
444 <P>What this means is that a neighbouring node will be pinged twice at
445 (default) 300 second intervals and if no reply has been heard just before
446 what would be the third attempt, that node is disconnected.
447 <P>If a ping is heard then the obscount is reset to the full value. Using
448 default values, if a node has not responded to a ping within 15 minutes,
451 <H2><A NAME="ss10.36">10.36 set/pinginterval (9)</A>
454 <P><CODE><B>set/pinginterval <time> <node call></B> Set the ping time to neighbouring nodes</CODE>
456 <P>As from version 1.35 all neighbouring nodes are pinged at regular intervals
457 in order to determine the rolling quality of the link and, in future, to
458 affect routing decisions. The default interval is 300 secs or 5 minutes.
459 <P>You can use this command to set a different interval. Please don't.
460 <P>But if you do the value you enter is treated as minutes up 60 and seconds
461 for numbers greater than that.
462 <P>This is used also to help determine when a link is down at the far end
463 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
464 for more information.
466 <H2><A NAME="ss10.37">10.37 set/privilege (9)</A>
469 <P><CODE><B>set/privilege <n> <call> [<call> ...]</B> Set the privilege level on a call</CODE>
471 <P>Set the privilege level on a callsign. The privilege levels that pertain
472 to commands are as default:-
477 1 - allow remote nodes normal user RCMDs
478 5 - various privileged commands (including shutdown, but not disc-
479 connect), the normal level for another node.
480 8 - more privileged commands (including disconnect)
481 9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
485 <P>If you are a sysop and you come in as a normal user on a remote connection
486 your privilege will automatically be set to 0.
488 <H2><A NAME="ss10.38">10.38 set/password (9)</A>
491 <P><CODE><B>set/password <callsign> <string></B> Set a users password</CODE>
493 <P>The password for a user can only be set by a full sysop. The string
494 can contain any characters but any spaces are removed (you can type in
495 spaces - but they won't appear in the password). You can see the
496 result with STAT/USER. The password is the usual 30 character baycom
499 <H2><A NAME="ss10.39">10.39 set/sys_qra (9)</A>
502 <P><CODE><B>set/sys_qra <locator></B> Set your cluster QRA locator</CODE>
504 <H2><A NAME="ss10.40">10.40 show/call (1)</A>
507 <P><CODE><B>show/call</B> Show any callbook details on a program</CODE>
508 This command queries an international callbook server on the internet
509 and returns any information available for that callsign.
511 <H2><A NAME="ss10.41">10.41 show/program (5)</A>
514 <P><CODE><B>show/program</B> Show the locations of all the included program modules</CODE>
516 <P>Show the name and location where every program module was load from. This
517 is useful for checking where you think you have loaded a .pm file from.
519 <H2><A NAME="ss10.42">10.42 shutdown (5)</A>
522 <P><CODE><B>shutdown</B> Shutdown the cluster</CODE>
524 <P>Shutdown the cluster and disconnect all the users. If you have Spider
525 set to respawn in /etc/inittab it will of course restart.
527 <H2><A NAME="ss10.43">10.43 spoof (9)</A>
530 <P><CODE><B>spoof <callsign> <command></B> Run commands as another user</CODE>
532 <P>This is a very simple yet powerful command for the sysop. It allows you to
533 issue commands as if you were a different user. This is very useful for the
534 kind of things that users seem to always get wrong.. like home_node for
537 <H2><A NAME="ss10.44">10.44 stat/db (5)</A>
540 <P><CODE><B>stat/db <dbname></B> Show the status of a database</CODE>
542 <P>Show the internal status of a database descriptor.
543 <P>Depending on your privilege level you will see more or less information.
544 This command is unlikely to be of much use to anyone other than a sysop.
546 <H2><A NAME="ss10.45">10.45 stat/channel (5)</A>
549 <P><CODE><B>stat/channel <callsign></B> Show the status of a channel on the cluster</CODE>
551 <P>Show the internal status of the channel object either for the channel that
552 you are on or else for the callsign that you asked for.
553 <P>Only the fields that are defined (in perl term) will be displayed.
555 <H2><A NAME="ss10.46">10.46 stat/msg (5)</A>
558 <P><CODE><B>stat/msg <msgno></B> Show the status of a message</CODE>
560 <P>This command shows the internal status of a message and includes information
561 such as to whom it has been forwarded, its size, origin etc etc.
563 <H2><A NAME="ss10.47">10.47 stat/user (5)</A>
566 <P><CODE><B>stat/user <callsign></B> Show the full status of a user</CODE>
568 <P>Shows the full contents of a user record including all the secret flags
570 <P>Only the fields that are defined (in perl term) will be displayed.
576 <A HREF="adminmanual-9.html">Previous</A>
577 <A HREF="adminmanual.html#toc10">Contents</A>