added help for chat

[spider.git] / cmd / Commands_en.hlp

diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp
index db5742dd18c9c42e1e12b5ecb2272c6be60b7c75..928bdb7e59ce644aacc35cb3e0cd85f67470e514 100644 (file)
--- a/cmd/Commands_en.hlp
+++ b/cmd/Commands_en.hlp
@@ -280,6 +280,42 @@ which will arrange for them to be forward candidates again.
 
 Order is not important.
 
 
 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.
 === 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 +414,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>^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.
 
 DBCREATE allows you to define a database in the system. It doesn't actually
 create anything, just defines it.
 


@@ -430,6 +467,16 @@ to allow
 
 to work as they may be used to.
 
 
 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
  
 See DBIMPORT for the importing of existing AK1A format data to databases.
 See DBSHOW for generic database enquiry
  


@@ -780,6 +827,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. 
 
 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
 === 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 +872,14 @@ immediately.
 
 It otherwise is used in the same way as the KILL command.
 
 
 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.
 === 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.


@@ -1736,6 +1799,12 @@ for more information.
 Display all the bad words in the system, see SET/BADWORD
 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.
 === 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 +1835,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.
 
 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.
 === 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.


@@ -2095,6 +2172,25 @@ is provided for users of this software by http://www.qrz.com
 
 See also SHOW/WM7D for an alternative.
 
 
 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
 === 9^SHOW/REGISTERED [<prefix>]^Show the registered users
 
 === 0^SHOW/ROUTE <callsign> ...^Show the route to the callsign