X-Git-Url: http://dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=cmd%2FCommands_en.hlp;h=585811d29b4710a00bd777b2998cb036839d8d5e;hb=3f1c5ab45aa13e99da6bea0bfcc6d4434beb5871;hp=83d33ef879a8f3a36a222bda630903e2c20efa9e;hpb=094315a61715270dbcf64d38d0b445ce6289f1ae;p=spider.git diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp index 83d33ef8..585811d2 100644 --- a/cmd/Commands_en.hlp +++ b/cmd/Commands_en.hlp @@ -12,15 +12,13 @@ # Comment lines are indented before printing # === 0^ANNOUNCE ^Send an announcement to LOCAL users only + is the text of the announcement you wish to broadcast === 0^ANNOUNCE FULL ^Send an announcement cluster wide This will send your announcement cluster wide === 5^ANNOUNCE SYSOP ^Send an announcement to Sysops only -=== 0^ANNOUNCE- - is the text of the announcement you wish to broadcast - === 0^APROPOS ^Search help database for Search the help database for (it isn't case sensitive), and print the names of all the commands that may be relevant. @@ -43,16 +41,119 @@ outstanding non-private messages will be forwarded to them. This may well be ALL the non-private messages. You can prevent this by using these commmands:- - catch GB7DJK all - catch GB7DJK 300 301 302 303 + catch GB7DJK all + catch GB7DJK 300 301 302 303 and to undo what you have just done:- - - uncatch GB7DJK all - uncatch GB7DJK 300 301 302 303 + + uncatch GB7DJK all + uncatch GB7DJK 300 301 302 303 which will arrange for them to be forward candidates again. +=== 0^DBAVAIL^Show a list of all the Databases in the system +Title says it all really, this command lists all the databases defined +in the system. It is also aliased to SHOW/COMMAND. + +=== 9^DBCREATE ^Create a database entry +=== 9^DBCREATE chain [..]^Create a chained database entry +=== 9^DBCREATE remote ^Create a remote database entry +DBCREATE allows you to define a database in the system. It doesn't actually +create anything, just defines it. + +The databases that are created are simple DB_File hash databases, they are +therefore already 'indexed'. + +You can define a local database with the first form of the command eg: + + DBCREATE oblast + +You can also chain databases with the addition of the 'chain' keyword. +This will search each database one after the other. A typical example +is: + + DBCREATE sdx_qsl chain sql_ad + +No checking is done to see if the any of the chained databases exist, in +fact it is usually better to do the above staement first then do each of +the chained databases. + +Databases can exist offsite. To define a database that lives on another +node do: + + DBCREATE buckmaster remote gb7dxc + +Remote databases cannot be chained; however, the last database in a +a chain can be a remote database eg: + + DBCREATE qsl chain gb7dxc + +To see what databases have been defined do: + + DBAVAIL (or it will have been aliased to SHOW/COMMAND) + +It would be normal for you to add an entry into your local Aliases file +to allow people to use the 'SHOW/' style syntax. So you would +need to add a line like:- + + 's' => [ + .. + .. + '^sh\w*/buc', 'dbshow buckmaster', 'dbshow', + .. + .. + ], + +to allow + + SH/BUCK g1tlh + +to work as they may be used to. + +See DBIMPORT for the importing of existing AK1A format data to databases. +See DBSHOW for generic database enquiry + +=== 9^DBIMPORT ^Import AK1A data into a database +If you want to import or update data in bulk to a database you can use +this command. It will either create or update entries into an existing +database. For example:- + + DBIMPORT oblast /tmp/OBLAST.FUL + +will import the standard OBLAST database that comes with AK1A into the +oblast database held locally. + +=== 9^DBREMOVE ^Delete a database +DBREMOVE will completely remove a database entry and also delete any data +file that is associated with it. + +There is no warning, no comeback, no safety net. + +For example: + + DBREMOVE oblast + +will remove the oblast database from the system and it will also remove +the associated datafile. + +I repeat: + +There is no warning, no comeback, no safety net. + +You have been warned. + +=== 0^DBSHOW ^Display an entry, if it exists, in a database +This is the generic user interface to the database to the database system. +It is expected that the sysop will add an entry to the local Aliases file +so that users can use the more familiar AK1A style of enquiry such as: + + SH/BUCK G1TLH + +but if he hasn't and the database really does exist (use DBAVAIL or +SHOW/COMMAND to find out) you can do the same thing with: + + DBSHOW buck G1TLH + === 9^DEBUG^Set the cluster program into debug mode Executing this command will only have an effect if you are running the cluster in debug mode i.e. @@ -95,9 +196,49 @@ Sysops can see all users' messages. === 8^DISCONNECT [ ...]^Disconnect a user or cluster Disconnect any connected locally -=== 0^DX ^Send a DX spot throughout the cluster - is compared against the available bands set up in the cluster. -see show/bands for more information. +=== 0^DX [BY ] ^Send a DX spot +This is how you send a DX Spot to other users. You can, in fact, now +enter the and the either way round. + + DX FR0G 144.600 + DX 144.600 FR0G + DX 144600 FR0G + +will all give the same result. You can add some remarks to the end +of the command and they will be added to the spot. + + DX FR0G 144600 this is a test + +You can credit someone else by saying:- + + DX by G1TLH FR0G 144.600 he isn't on the cluster + +The is compared against the available bands set up in the +cluster. See SHOW/BANDS for more information. + +=== 9^EXPORT ^Export a message to a file +Export a message to a file. This command can only be executed on a local +console with a fully privileged user. The file produced will be in a form +ready to be imported back into the cluster by placing it in the import +directory (/spider/msg/import). + +This command cannot overwrite an existing file. This is to provide some +measure of security. Any files written will owned by the same user as the +main cluster, otherwise you can put the new files anywhere the cluster can +access. For example:- + + EXPORT 2345 /tmp/a + +=== 9^EXPORT_USERS []^Export the users database to ascii +Export the users database to a file in ascii format. If no filename +is given then it will export the file to /spider/data/user_asc. + +If the file already exists it will be renamed to .o. In fact +up to 5 generations of the file can be kept each one with an extra 'o' on the +suffix. + +BE WARNED: this will write to any file you have write access to. No check is +made on the filename (if any) that you specify. === 1^FORWARD/OPERNAME ^Send out information on this to all clusters This command sends out any information held in the user file which can @@ -118,42 +259,62 @@ Look at the APROPOS command which will search the help database for the you specify and give you a list of likely commands to look at with HELP. +=== 5^INIT ^Re-initialise a link to an AK1A compatible node +This command attempts to re-initialise a link to a (usually) AK1A node +that has got confused, usually by a protocol loop of some kind. It may +work - but you usually will be better off simply disconnecting it (or +better, if it is a real AK1A node, doing an RCMD DISC/F ). + +Best of luck - you will need it. + === 0^KILL [ [ [/]^Ask for the latest spots and WWV MERGE allows you to bring your spot and wwv database up to date. By default @@ -179,6 +340,8 @@ out. MSG NOKEep - unset the keep flag MSG SUbject - change the subject to MSG WAittime - remove any waitting time for this message + MSG NOREad - mark message as unread + MSG REad - mark message as read MSG QUeue - queue any outstanding bulletins MSG QUeue 1 - queue any outstanding private messages @@ -189,9 +352,11 @@ You can look at the status of a message by using:- This will display more information on the message than DIR does. === 8^PC ^Send text (eg PC Protocol) to -Send some arbitrary text to a locally connected callsign. No processing is done on -the text. This command allows you to send PC Protocol to unstick things if problems -arise (messages get stuck etc). eg:- +Send some arbitrary text to a locally connected callsign. No +processing is done on the text. This command allows you to send PC +Protocol to unstick things if problems arise (messages get stuck +etc). eg:- + pc gb7djk PC33^GB7TLH^GB7DJK^400^ or pc G1TLH Try doing that properly!!! @@ -244,15 +409,16 @@ message either sent by or sent to your callsign. === 5^READ-^ As a sysop you may read any message on the system -=== 0^REPLY^Reply to the last message that you have read -=== 0^REPLY ^Reply to the specified message -=== 0^REPLY PRIVATE ^Reply privately to the specified message +=== 0^REPLY^Reply (privately) to the last message that you have read +=== 0^REPLY ^Reply (privately) to the specified message +=== 0^REPLY B ^Reply as a Bulletin to the specified message +=== 0^REPLY NOPrivate ^Reply as a Bulletin to the specified message === 0^REPLY RR ^Reply to the specified message with read receipt You can reply to a message and the subject will automatically have "Re:" inserted in front of it, if it isn't already present. You can also use all the extra qualifiers such as RR, PRIVATE, -NOPRIVATE that you can use with the SEND command (see SEND +NOPRIVATE, B that you can use with the SEND command (see SEND for further details) === 0^SEND [ ...]^Send a message to one or more callsigns @@ -284,15 +450,40 @@ SP is an alias for SEND PRIVATE === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal +=== 5^SET/ARCLUSTER [..]^Make the callsign an AR-Cluster node + === 0^SET/BEEP^Add a beep to DX and other messages on your terminal === 0^UNSET/BEEP^Stop beeps for DX and other messages on your terminal +=== 5^SET/CLX [..]^Make the callsign an CLX node + === 9^SET/DEBUG ^Add a debug level to the debug set === 9^UNSET/DEBUG ^Remove a debug level from the debug set === 0^SET/DX^Allow DX messages to come out on your terminal === 0^UNSET/DX^Stop DX messages coming out on your terminal +=== 0^SET/DXGRID^Allow Grid Squares on the end of DX announcements +=== 0^UNSET/DXGRID^Stop Grid Squares on the end of DX announcements +A standard feature which is enabled in version 1.43 and above is +that if the spotter's grid square is known it is output on the end +of a DX announcement (there is just enough room). Some user programs +cannot cope with this. You can use this command to reset (or set) +this feature. + +=== 5^SET/DXNET [..]^Make the callsign an DXNet node + +=== 0^SET/ECHO^Make the cluster echo your input +=== 0^UNSET/ECHO^Stop the cluster echoing your input +If you are connected via a telnet session, different implimentations +of telnet handle echo differently depending on whether you are +connected via port 23 or some other port. You can use this command +to change the setting appropriately. + +The setting is stored in your user profile. + +YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25. + === 0^SET/HERE^Tell the system you are present at your terminal === 0^UNSET/HERE^Tell the system you are absent from your terminal @@ -323,6 +514,9 @@ what your latitude and longitude is. If you have not yet done a SET/QRA then this command will set your QRA locator for you. For example:- SET/LOCATION 52 22 N 0 57 E +=== 0^SET/LOGININFO^Inform when a station logs in locally +=== 0^UNSET/LOGININFO^Inform when a station logs out locally + === 9^SET/LOCKOUT ^Stop a callsign connecting to the cluster === 9^UNSET/LOCKOUT ^Allow a callsign to connect to the cluster @@ -330,17 +524,48 @@ then this command will set your QRA locator for you. For example:- Tell the system what your name is eg:- SET/NAME Dirk -=== 9^SET/NODE [..]^Make the callsign an AK1A cluster +=== 5^SET/NODE [..]^Make the callsign an AK1A cluster Tell the system that the call(s) are to be treated as AK1A cluster and fed PC Protocol rather normal user commands. +=== 8^SET/OBSCOUNT ^Set the 'pump-up' obscelence counter +From 1.35 onwards neighbouring nodes are pinged at regular intervals (see +SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up' +counter which is decremented on every outgoing ping and then reset to +the 'obscount' value on every incoming ping. The default value of this +parameter is 2. + +What this means is that a neighbouring node will be pinged twice at +(default) 300 second intervals and if no reply has been heard just before +what would be the third attempt, that node is disconnected. + +If a ping is heard then the obscount is reset to the full value. Using +default values, if a node has not responded to a ping within 15 minutes, +it is disconnected. + === 0^SET/PAGE ^Set the lines per page Tell the system how many lines you wish on a page when the number of line of output from a command is more than this. The default is 20. Setting it explicitly to 0 will disable paging. SET/PAGE 30 SET/PAGE 0 - + +The setting is stored in your user profile. + +=== 9^SET/PINGINTERVAL