add DXCIDR, fix version no tracking
[spider.git] / cmd / Commands_en.hlp
index a1ab2305bbf944d3e4aa9e612a6801034d689f52..244688d99efea04bbac4ee37b8ad654d5f96c872 100644 (file)
@@ -500,8 +500,23 @@ You also use one of these databases in a chain. This may be useful
 locally. 
 
 See DBIMPORT for the importing of existing AK1A format data to databases.
+See DXEXPORT for how to export an AK1A data in a form able to be imported.
 See DBSHOW for generic database enquiry
+
+
+=== 9^DBEXPORT <dbname> <filename>^Export an AK1A data to a file
+Sometimes one needs to export the data from an existing database file,
+maybe for a backup or to send to another node.
+
+  DBEXPORT oblast /tmp/OBLAST.FUL
+
+will export the OBLAST database to /tmp/OBLAST.FUL
+
+There is no protection, it is up to you not to overwrite a file that
+is important to you.
+
+See DBIMPORT for the importing of existing AK1A format data to databases.
+
 === 9^DBIMPORT <dbname> <filename>^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
@@ -512,6 +527,8 @@ database. For example:-
 will import the standard OBLAST database that comes with AK1A into the
 oblast database held locally.
 
+See DBEXPORT for how to export an AK1A database
+
 === 9^DBREMOVE <dbname>^Delete a database
 DBREMOVE will completely remove a database entry and also delete any data
 file that is associated with it. 
@@ -583,8 +600,20 @@ You can abbreviate all the commands to one letter and use ak1a syntax:-
 === 5^DIRECTORY-^
 Sysops can see all users' messages.
 
-=== 8^DISCONNECT <call> [<call> ...]^Disconnect a user or cluster
-Disconnect any <call> connected locally
+=== 8^DISCONNECT <call> [<call> ...]^Disconnect user(s) or node(s)
+Disconnect any <call> connected locally.
+
+In addition you can disconnect all users (except yourself) with
+
+  DISC users
+
+or all nodes with:
+
+  DISC nodes
+
+or everything (except yourself) with
+
+  DISC all
 
 === 0^DX [BY <call>] <freq> <call> <remarks>^Send a DX spot
 This is how you send a DX Spot to other users. You can, in fact, now
@@ -606,6 +635,41 @@ You can credit someone else by saying:-
 The <freq> is compared against the available bands set up in the 
 cluster.  See SHOW/BANDS for more information.
 
+=== 9^DXQSL_EXPORT <filename>^Export SH/DXSQL information to a file
+The SHOW/DXQSL command shows any QSL managers that have been extracted
+from comments on a DX spot.
+
+Use this command to export the current state of the information to
+a CSV style text file. For example:
+
+   DXQSL_EXPORT /tmp/qsl.csv
+
+NOTE: this command will overwrite any file that you have write
+permission for.
+
+See also DXQSL_IMPORT to import one of these files.
+
+=== 9^DXQSL_IMPORT <filename>^Import SH/DXSQL information from a file
+The SHOW/DXQSL command shows any QSL managers that have been extracted
+from comments on a DX spot.
+
+Use this command to restore a file created by the DXSQL_EXPORT command.
+For example:
+
+   DXQSL_IMPORT /tmp/qsl.csv
+
+The data in this file will UPDATE any information that may already be
+present. This may not be what you want. To make the data the same as
+the import file then you must:
+
+* stop the node
+* remove /spider/data/qsl.v1
+* restart the node
+* login as sysop
+* do the import
+
+Preferably before too many DX spots with qsl manager info come in.
+
 === 0^ECHO <line>^Echo the line to the output
 This command is useful in scripts and so forth for printing the
 line that you give to the command to the output. You can use this
@@ -813,6 +877,21 @@ This command sends out any information held in the user file which can
 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
 and Homenode. PC41s are only sent for the information that is available.
  
+=== 8^GET/KEPS^Obtain the latest AMSAT Keplarian Elements from the web
+There are various ways that one can obtain the AMSAT keps. Traditionally the
+regular method was to get on the mailing list and then arrange for the email
+to be piped into convkeps.pl and arrange from the crontab to run LOAD/KEPS. 
+For various reasons, it was quite easy for one to be silently dropped 
+from this mailing list. 
+
+With the advent of asynchronous (web) connections in DXSpider it is now 
+possible to use this command to get the latest keps direct from the
+AMSAT web site. One can do this from the command line or one can add a line 
+in the local DXSpider crontab file to do periodically (say once a week).
+
+This command will clear out the existing keps and then run LOAD/KEPS 
+for you (but only) after a successful download from the AMSAT website.
 === 0^HELP^The HELP Command
 HELP is available for a number of commands. The syntax is:-
 
@@ -1373,6 +1452,12 @@ This will show YOU the output from SH/VHFTABLE and also store it in the
 message. 
 
 You can carry on with the message until you are ready to send it. 
+
+=== 6^SEND_CONFIG^Broadcast PC92 C records
+This is the PC92 equivalent of INIT. In that it will send out a new
+PC92 C record to all interfaces. This can be used to bring other nodes
+up to date quicker after a restart.
+
 === 0^SET/ADDRESS <your address>^Record your postal address
 
 === 9^SET/AGWENGINE^Enable the AGW Engine
@@ -1641,6 +1726,20 @@ then this command will set your QRA locator for you. For example:-
 === 9^SET/LOCKOUT <call>^Stop a callsign connecting to the cluster
 === 9^UNSET/LOCKOUT <call>^Allow a callsign to connect to the cluster
 
+=== 8^SET/MAXCONNECT <value> [<call> ..]^Set max incoming connections for user/node
+Set the maximum no of connections (parents) an incoming user or node is
+allowed to have. If this incoming connection takes it over the separate
+limits for users and nodes (defaults: 3 and 8 respectively), then the
+connection is refused (with a polite message).
+
+The idea behind this to limit the number of copies of messages that
+are sent to users (and nodes). Nodes really don't need to have more than
+5 or 6 partners and users don't need more than two connections into the
+cluster cloud.
+
+This check is only for INCOMING connections, no check is performed for
+outgoing connections.
+
 === 0^SET/NAME <your name>^Set your name
 Tell the system what your name is eg:-
   SET/NAME Dirk
@@ -1954,13 +2053,20 @@ Show all the nodes connected to this node.
 This command shows information on all the active connections known to
 the node. This command gives slightly more information than WHO.
 
-=== 0^SHOW/CONTEST <year and month>^Show all the contests for a month
+=== 0^SHOW/CONTEST [<year>] [<month>]^Show all the contests for a month
 Show all known contests which are maintained at http://www.sk3bg.se/contest/
 for a particular month or year. The format is reasonably flexible.
 For example:-
   
-  SH/CONTEST sep2003
-  SH/CONTEST 03 march
+  SH/CONTEST 
+  SH/CONTEST mar
+  SH/CONTEST mar 13
+  SH/CONTEST 13 march
+
+If there is no month/year then the current month's contests are shown.
+
+Note that it expects ENGLISH (jan/feb/mar/apr/may/jun/jul/aug/sep/oct/nov/dec)
+month names.
 
 === 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
 This is very nearly the same as SHOW/TIME, the only difference the format
@@ -2054,6 +2160,12 @@ any order to the basic SHOW/DX command, they are:-
 
  by_state <list> - look for spots spotted by people in the US state
                    specified.
+
+ origin          - the node from which this spot originated (must be an
+                   exact callsign with SSID e.g. gb7tlh-4)
+
+ ip              - the IP address of the spotter (either in IPV4 or IPV6)
+                   format. These addresses can be partial. 
  
  e.g. 
    
@@ -2071,6 +2183,8 @@ any order to the basic SHOW/DX command, they are:-
    SH/DX state in,oh
    SH/DX by_state in,oh
    SH/DX hb2008g exact
+   SH/DX origin gb7tlh-4
+   SH/DX ip 82.65.128.4       (or SH/DX ip 2a00:1450:4009:800::200e)
   
 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
 This command takes the <prefix> (which can be a full or partial 
@@ -2197,7 +2311,13 @@ the worldwide statistics.
 This command shows the hop counts set up for a node. You can specify
 which category you want to see. If you leave the category out then 
 all the categories will be listed.
+
+=== 0^SHOW/IK3QAR <callsign>^Obtain QSL info from IK3QAR database
+Get QSL information from the online dabase run by IK3QAR.
+
+Your sysop needs to set up this command by obtaining a password from IK3QAR.
+Instructions are available in local/Internet.pm
+
 === 1^SHOW/ISOLATE^Show list of ISOLATED nodes
 
 === 9^SHOW/LOCKOUT <prefix>|ALL^Show the list of locked out or excluded callsigns
@@ -2240,6 +2360,16 @@ Upto 366 days can be checked both in the past and in the future.
 Please note that the rise and set times are given as the UT times of rise and 
 set on the requested UT day.
 
+=== 0^SHOW/MOTD^Show your MOTD (the Message of the Day)
+The Message of the Day is normally printed whenever one logs on. However
+many people now login using logging programs or something other than plain
+telnet or ax25 connections. This command allows the user (or the program)
+to see what is in the MOTD.
+
+The actual MOTD that you are shown depends on what carrier you are logged
+on via, whether you are registered and some other factors that your sysop
+may have thrown in.
+
 === 0^SHOW/MUF <prefix> [<hours>][long]^Show the likely propagation to a prefix
 This command allow you to estimate the likelihood of you contacting
 a station with the prefix you have specified. The output assumes a modest
@@ -2319,17 +2449,18 @@ So if you have said: ACC/SPOT on hf
 Doing a SHOW/MYDX will now only, ever, show HF spots. All the other 
 options on SH/DX can still be used.
 
-=== 0^SHOW/NEWCONFIGURATION [<node>]^Show all the nodes and users visible
-This command allows you to see all the users that can be seen
-and the nodes to which they are connected. 
+=== 0^SHOW/NEWCONFIGURATION [USERS|<node call>]^Show the cluster map
+Show the map of the whole cluster.
 
-This command produces essentially the same information as 
-SHOW/CONFIGURATION except that it shows all the duplication of
-any routes that might be present It also uses a different format
-which may not take up quite as much space if you don't have any
-loops.
+This shows the structure of the cluster that you are connected to. By
+default it will only show the nodes that are known. By adding the keyword
+USER to the command it will show all the users as well.
 
-BE WARNED: the list that is returned can be VERY long
+As there will be loops, you will see '...', this means that the information
+is as printed earlier and that is a looped connection from here on.
+
+BE WARNED: the list that is returned can be VERY long (particularly
+with the USER keyword)
 
 === 0^SHOW/NEWCONFIGURATION/NODE^Show all the nodes connected locally
 Show all the nodes connected to this node in the new format.