fix unset/logininfo help
[spider.git] / cmd / Commands_en.hlp
index 6a5131980a17849bd3052ad3d15f1083397bc58e..592b71827a5751e60c0157999f87c07431ecc1e0 100644 (file)
@@ -9,6 +9,8 @@
 # if the command ends in a - then that line isn't printed, but any
 # subsequent lines are
 #
+# $Id$
+#
 # Comment lines are indented before printing
 #
 === 0^ACCEPT^Set a filter to accept something
@@ -280,6 +282,42 @@ which will arrange for them to be forward candidates again.
 
 Order is not important.
 
+=== 0^CHAT <group> <text>^Chat or Conference to a group
+It is now possible to JOIN a group and have network wide conferencing to that
+group. DXSpider does not (and probably will not) implement the AK1A 
+conference mode as this seems very limiting, is hardly used and doesn't seem
+to work too well anyway.
+
+This system uses the existing ANN system and is compatible with both other
+DXSpider nodes and AK1A clusters (they use ANN/<group>). 
+
+You can be a member of as many "groups" as you want. To join a group type:-
+
+  JOIN FOC    (where FOC is the group name)
+
+To leave a group type:-
+
+  LEAVE FOC
+
+You can see which groups you are in by typing:-
+
+  STAT/USER
+
+and you can see whether your mate is in the group, if he connects to the
+same node as you, by typing:-
+
+  STAT/USER g1tlh
+
+To send a message to a group type:-
+
+  CHAT FOC hello everyone
+
+or
+
+  CH #9000 hello I am back
+
+See also JOIN, LEAVE, SHOW/CHAT
+
 === 0^CLEAR/ANNOUNCE [1|all]^Clear a announce filter line
 This command allows you to clear (remove) a line in a annouce filter or to 
 remove the whole filter.
@@ -378,6 +416,7 @@ in the system. It is also aliased to SHOW/COMMAND.
 === 9^DBCREATE <name>^Create a database entry
 === 9^DBCREATE <name> chain <name> [<name>..]^Create a chained database entry
 === 9^DBCREATE <name> remote <node>^Create a remote database entry
+=== 9^DBCREATE <name> cmd <dxspider command>^make a local command available as a DB
 DBCREATE allows you to define a database in the system. It doesn't actually
 create anything, just defines it.
 
@@ -430,6 +469,16 @@ to allow
 
 to work as they may be used to.
 
+You can also make local commands available as 'pseudo' databases. You
+can therefore make spider special commands available as a database. I
+imagine that this will be primarily useful for remote access from 
+legacy nodes. For example:-
+
+  DBCREATE dxqsl cmd show/dxqsl
+
+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 DBSHOW for generic database enquiry
  
@@ -780,6 +829,14 @@ Note that this command is similar to SPOOF and will have the same side
 effects. Commands are run at the privilege of the user which is being
 demonstrated to. 
 
+=== 0^JOIN <group>^Join a chat or conference group
+JOIN allows you to join a network wide conference group. To join a
+group (called FOC in this case) type:-
+
+  JOIN FOC
+
+See also CHAT, LEAVE, SHOW/CHAT
+
 === 0^KILL <msgno> [<msgno..]^Delete a message from the local system
 === 0^KILL <from msgno>-<to msgno>^Delete a range of messages
 === 0^KILL from <regex>^Delete messages FROM a callsign or pattern
@@ -817,6 +874,14 @@ immediately.
 
 It otherwise is used in the same way as the KILL command.
 
+=== 0^LEAVE <group>^Leave a chat or conference group
+LEAVE allows you to leave a network wide conference group. To leave a
+group (called FOC in this case) type:-
+
+  LEAVE FOC
+
+See also CHAT, JOIN, SHOW/CHAT
+
 === 0^LINKS^Show which nodes is physically connected
 This is a quick listing that shows which links are connected and
 some information about them. See WHO for a list of all connections.
@@ -1410,7 +1475,7 @@ of a DX announcement (there is just enough room). Some user programs
 cannot cope with this. The Spotter's CQ is on the RHS of the 
 time, the Spotted's CQ is on the LHS.
 
-Conflicts with: SHOW/DXGRID, SHOW/DXITU, SHOW/USSTATE
+Conflicts with: SET/DXGRID, SET/DXITU, SHOW/USSTATE
 
 Do a STAT/USER to see which flags you have set if you are confused.  
 
@@ -1421,7 +1486,7 @@ of a DX announcement (there is just enough room). Some user programs
 cannot cope with this. The Spotter's ITU is on the RHS of the 
 time, the Spotted's ITU is on the LHS.
 
-Conflicts with: SHOW/DXGRID, SHOW/DXCQ, SHOW/USSTATE
+Conflicts with: SET/DXGRID, SET/DXCQ, SHOW/USSTATE
 
 Do a STAT/USER to see which flags you have set if you are confused.  
 
@@ -1433,7 +1498,7 @@ 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.
 
-Conflicts with: SHOW/DXCQ, SHOW/DXITU
+Conflicts with: SET/DXCQ, SET/DXITU
 
 Do a STAT/USER to see which flags you have set if you are confused.  
 
@@ -1506,8 +1571,8 @@ Remove isolation from a node - SET/ISOLATE
 
 === 0^SET/LANGUAGE <lang>^Set the language you want to use
 You can select the language that you want the cluster to use. Currently
-the languages available are en (English), de (German), es (Spanish) 
-and nl (Dutch).
+the languages available are en (English), de (German), es (Spanish),
+Czech (cz), French (fr), Portuguese (pt), Italian (it) and nl (Dutch).
 
 === 0^SET/LOCATION <lat & long>^Set your latitude and longitude
 === 9^SET/SYS_LOCATION <lat & long>^Set your cluster latitude and longitude
@@ -1516,8 +1581,8 @@ 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
+=== 0^SET/LOGININFO^Inform when a station logs in/out locally
+=== 0^UNSET/LOGININFO^No longer inform when a station logs in/out locally
 
 === 9^SET/LOCKOUT <call>^Stop a callsign connecting to the cluster
 === 9^UNSET/LOCKOUT <call>^Allow a callsign to connect to the cluster
@@ -1640,19 +1705,26 @@ password for a user.
 
 === 0^SET/PROMPT <string>^Set your prompt to <string>
 === 0^UNSET/PROMPT^Set your prompt back to default
-This command will set your user prompt to exactly the string that you 
+This command will set your user prompt to the string that you 
 say. The point of this command to enable a user to interface to programs
 that are looking for a specific prompt (or else you just want a different
-fixed prompt).
+prompt).
 
   SET/PROMPT clx >
 
-UNSET/PROMPT will undo the SET/PROMPT command and set you prompt back to
-normal.
+There are some substitutions that can be added to the prompt:
 
-=== 5^SET/SPIDER <call> [<call>..]^Make the callsign an DXSpider node
-Tell the system that the call(s) are to be treated as DXSpider node and
-fed new style DX Protocol rather normal user commands.
+  %C - callsign [which will have ( and ) around it if not here]
+  %D - date
+  %T - time
+  %M - cluster 'mycall'
+
+The standard prompt is defined as:
+
+  SET/PROMPT %C de %M %D %T dxspider >
+
+UNSET/PROMPT will undo the SET/PROMPT command and set your prompt back to
+normal.
 
 === 9^SET/SYS_QRA <locator>^Set your cluster QRA Grid locator
 === 0^SET/QRA <locator>^Set your QRA Grid locator
@@ -1681,7 +1753,29 @@ cannot use DX, ANN etc.
 
 The only exception to this is that a non-registered user can TALK or
 SEND messages to the sysop.
+
+=== 6^SET/STARTUP <call>^Create a user startup script
+=== 0^SET/STARTUP^Create your own startup script
+Create a startup script of DXSpider commands which will be executed
+everytime that you login into this node. You can only input the whole
+script afresh, it is not possible to 'edit' it. Inputting a new script is
+just like typing in a message using SEND. To finish inputting type: /EX
+on a newline, to abandon the script type: /ABORT.
+
+You may find the (curiously named) command BLANK useful to break 
+up the output. If you simply want a blank line, it is easier to 
+input one or more spaces and press the <return> key.
+
+See UNSET/STARTUP to remove a script.
+
+=== 6^UNSET/STARTUP <call>^Remove a user startup script
+=== 0^UNSET/STARTUP^Remove your own startup script
+You can remove your startup script with UNSET/STARTUP.  
+
+=== 5^SET/SPIDER <call> [<call>..]^Make the callsign an DXSpider node
+Tell the system that the call(s) are to be treated as DXSpider node and
+fed new style DX Protocol rather normal user commands.
+
 === 0^SET/TALK^Allow TALK messages to come out on your terminal
 === 0^UNSET/TALK^Stop TALK messages coming out on your terminal
 
@@ -1707,7 +1801,7 @@ information from SET/DXGRID.
 Some user programs cannot cope with this. You can use this command 
 to reset (or set) this feature.
 
-Conflicts with: SHOW/DXCQ, SHOW/DXITU
+Conflicts with: SET/DXCQ, SET/DXITU
 
 Do a STAT/USER to see which flags you have set if you are confused.  
 
@@ -1736,6 +1830,12 @@ for more information.
 Display all the bad words in the system, see SET/BADWORD
 for more information.
 
+=== 0^SHOW/CHAT [<group>] [<lines>]^Show any chat or conferencing 
+This command allows you to see any chat or conferencing that has  
+occurred whilst you were away. SHOW/CHAT on its own will show data for
+all groups. If you use a group name then it will show only chat for
+that group.
+
 === 0^SHOW/CONFIGURATION [<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.
@@ -1766,6 +1866,14 @@ 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
+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
+
 === 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
 This is very nearly the same as SHOW/TIME, the only difference the format
 of the date string if no arguments are given.
@@ -1830,7 +1938,34 @@ any order to the basic SHOW/DX command, they are:-
                   
                    You can also use this with the 'by' keyword so 
                    eg by W dxcc  
-   
+ real or rt      - Format the output the same as for real time spots. The
+                   formats are deliberately different (so you can tell
+                   one sort from the other). This is useful for some 
+                   logging programs that can't cope with normal sh/dx 
+                   output. An alias of SHOW/FDX is available.
+       
+ filter          - Filter the spots, before output, with the user's 
+                   spot filter. An alias of SHOW/MYDX is available.
+
+ zone <zones>    - look for spots in the cq zone (or zones) specified.
+                   zones are numbers separated by commas.
+
+ by_zone <zones> - look for spots spotted by people in the cq zone
+                   specified.
+
+ itu <itus>      - look for spots in the itu zone (or zones) specified
+                   itu zones are numbers separated by commas.
+
+ by_itu <itus>   - look for spots spotted by people in the itu zone
+                   specified.
+  
+ state <list>    - look for spots in the US state (or states) specified
+                   The list is two letter state codes separated by commas.
+
+ by_state <list> - look for spots spotted by people in the US state
+                   specified.
  e.g. 
    
    SH/DX 9m0
@@ -1842,6 +1977,10 @@ any order to the basic SHOW/DX command, they are:-
    SH/DX qra jn86
    SH/DX dxcc oq2
    SH/DX dxcc oq2 by w dxcc
+   SH/DX zone 4,5,6
+   SH/DX by_zone 4,5,6
+   SH/DX state in,oh
+   SH/DX by_state in,oh
   
 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
 This command takes the <prefix> (which can be a full or partial 
@@ -1861,6 +2000,16 @@ This can be done with the SHOW/DX command like this:-
    SH/DX dxcc g
    SH/DX dxcc w on 20m iota
 
+This is an alias for: SH/DX dxcc
+
+=== 0^SHOW/FDX^Show the DX data in realtime format.
+Normally SHOW/DX outputs spot data in a different format to the
+realtime data. This is a deliberate policy (so you can tell the 
+difference between the two). Some logging programs cannot handle
+this so SHOW/FDX outputs historical data in real time format.
+
+This is an alias for: SHOW/DX real
+
 === 0^SHOW/DXSTATS [days] [date]^Show the DX Statistics
 Show the total DX spots for the last <days> no of days (default is 31), 
 starting from a <date> (default: today).
@@ -2036,6 +2185,19 @@ Gives you an estimate of the long path propagation characterics. It
 should be noted that the figures will probably not be very useful, nor
 terrible accurate, but it is included for completeness.
 
+=== 0^SHOW/MYDX^Show the DX data filtered with your spot filter.
+SHOW/DX potentially shows all the spots available in the system. Using
+SHOW/MYDX will, instead, filter the availble spots using any spot filter 
+that you have set, first. 
+
+This command, together with ACCEPT/SPOT or REJECT/SPOT, will allow
+you to customise the spots that you receive.
+
+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. 
@@ -2095,6 +2257,25 @@ is provided for users of this software by http://www.qrz.com
 
 See also SHOW/WM7D for an alternative.
 
+=== 0^SHOW/DXQSL <callsign>^Show any QSL info gathered from spots
+The node collects information from the comment fields in spots (things
+like 'VIA EA7WA' or 'QSL-G1TLH') and stores these in a database.
+
+This command allows you to interrogate that database and if the callsign
+is found will display the manager(s) that people have spotted. This 
+information is NOT reliable, but it is normally reasonably accurate if
+it is spotted enough times.
+
+For example:-
+
+  sh/dxqsl 4k9w
+
+You can check the raw input spots yourself with:-
+
+  sh/dx 4k9w qsl
+
+This gives you more background information.
+
 === 9^SHOW/REGISTERED [<prefix>]^Show the registered users
 
 === 0^SHOW/ROUTE <callsign> ...^Show the route to the callsign
@@ -2124,6 +2305,10 @@ So for example:-
  SH/SAT AO-10 
  SH/SAT FENGYUN1 12 2
 
+=== 6^SHOW/STARTUP <call>^View a user startup script
+=== 0^SHOW/STARTUP^View your own startup script
+View the contents of a startup script created with SET/STARTUP.
+
 === 6^SHOW/STATION ALL [<regex>]^Show list of users in the system
 === 0^SHOW/STATION [<callsign> ..]^Show information about a callsign
 Show the information known about a callsign and whether (and where)