X-Git-Url: http://dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=cmd%2FCommands_en.hlp;h=1e25f894970cab3b13defa4e3197d8404eba2b70;hb=bff9ecf00b14e7d71d9504088a2fd7b9e5115fe1;hp=0b4766ed4c0e32cb0d75e8d081d67bee4f7021ac;hpb=4c92a7711c41cc7ba1c60d5a49a94db239032ac1;p=spider.git diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp index 0b4766ed..1e25f894 100644 --- a/cmd/Commands_en.hlp +++ b/cmd/Commands_en.hlp @@ -12,22 +12,229 @@ # 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. === 0^BYE^Exit from the cluster This will disconnect you from the cluster - -=== 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. +=== 5^CONNECT ^Start a connection to another DX Cluster +Start a connection process that will culminate in a new connection to the +DX cluster . This process creates a new 'client' process which will +use the script in /spider/connect/ to effect the 'chat' exchange +necessary to traverse the network(s) to logon to the cluster . + +=== 9^CATCH All|[ ...]^Mark a message as sent +=== 9^UNCATCH All|[msgno> ...]^Unmark a message as sent +When you send messages the fact that you have forwarded it to another node +is remembered so that it isn't sent again. When you have a new partner +node and you add their callsign to your /spider/msg/forward.pl file, all +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 + +and to undo what you have just done:- + + 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. + + perl -d cluster.pl + +It will interrupt the cluster just after the debug command has finished. +=== 0^DIRECTORY^List messages +=== 0^DIRECTORY ALL^List all messages +=== 0^DIRECTORY OWN^List your own messages +=== 0^DIRECTORY NEW^List all new messages +=== 0^DIRECTORY TO ^List all messages to +=== 0^DIRECTORY FROM ^List all messages from +=== 0^DIRECTORY SUBJECT ^List all messages with in subject +=== 0^DIRECTORY ^List last messages +=== 0^DIRECTORY -^List messages message message +List the messages in the messages directory. + +If there is a 'p' one space after the message number then it is a +personal message. If there is a '-' between the message number and the +'p' then this indicates that the message has been read. + +You can use shell escape characters such as '*' and '?' in the +fields. + +You can combine some of the various directory commands together eg:- + + DIR TO G1TLH 5 +or + DIR SUBJECT IOTA 200-250 + +You can abbreviate all the commands to one letter and use ak1a syntax:- + + DIR/T G1* 10 + DIR/S QSL 10-100 5 + +=== 5^DIRECTORY-^ +Sysops can see all users' messages. + +=== 8^DISCONNECT [ ...]^Disconnect a user or cluster +Disconnect any connected locally + +=== 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 + + +=== 1^FORWARD/OPERNAME ^Send out information on this to all clusters +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. + === 0^HELP^The HELP Command HELP is available for a number of commands. The syntax is:- @@ -36,7 +243,337 @@ HELP is available for a number of commands. The syntax is:- Where is the name of the command you want help on. All commands can be abbreviated, so SHOW/DX can be abbreviated -to SH/DX, ANNOUNCE can be shorted to AN and so on. +to SH/DX, ANNOUNCE can be shortened to AN and so on. + +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. + +=== 0^KILL [ [ [/]^Ask for the latest spots and WWV +MERGE allows you to bring your spot and wwv database up to date. By default +it will request the last 10 spots and 5 WWVs from the node you select. The +node must be connected locally. + +You can request any number of spots or wwv and although they will be appended +to your databases they will not duplicate any that have recently been added +(the last 2 days for spots and last month for WWV data). + +=== 9^MSG [data ... ]^Alter various message parameters +Alter message parameters like To, From, Subject, whether private or bulletin +or return receipt (RR) is required or whether to keep this message from timing +out. + + MSG TO - change TO callsign to + MSG FRom - change FROM callsign to + MSG PRrivate - set private flag + MSG NOPRrivate - unset private flag + MSG RR - set RR flag + MSG NORR - unset RR flag + MSG KEep - set the keep flag (message won't be deleted ever) + 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 + +You can look at the status of a message by using:- + + STAT/MSG + +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:- + pc gb7djk PC33^GB7TLH^GB7DJK^400^ +or + pc G1TLH Try doing that properly!!! + +=== 1^PING ^Send a ping command to another cluster +This command is used to estimate the quality of the link to another cluster. +The time returned is the length of time taken for a PC51 to go to another +cluster and be returned. + +=== 0^KILL [ ...]^Remove or erase a message from the system +You can get rid of any message to or originating from your callsign using +this command. You can remove more than one message at a time. + +=== 5^KILL -^Remove a range of messages from the system +=== 5^KILL FROM ^Remove all messages from a callsign +=== 5^KILL TO ^Remove all messages to a callsign +=== 5^KILL FULL [ ^Send arbitrary text to a connected callsign +Send any text you like to the callsign requested. This is used mainly to send +PC protocol to connected nodes either for testing or to unstick things. + +You can also use in the same way as a talk command to a connected user but +without any processing, added of "from to ^Find out the delays an a circuit to another node +This command will enable sysops to determine the speed of an inter-cluster +node. + +Any visible cluster node can be PINGed. + +=== 1^RCMD ^Send a command to another DX Cluster +This command allows you to send nearly any command to another DX Cluster +node that is connected to the system. + +Whether you get any output is dependant on a) whether the other system knows +that the node callsign of this cluster is in fact a node b) whether the +other system is allowing RCMDs from this node and c) whether you have +permission to send this command at all. + +=== 0^READ^Read the next unread personal message addressed to you +=== 0^READ ^Read the specified message +You can read any messages that are sent as 'non-personal' and also any +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 (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, B that you can use with the SEND command (see SEND +for further details) + +=== 0^SEND [ ...]^Send a message to one or more callsigns +=== 0^SEND RR ^Send a message and ask for a read receipt +=== 0^SEND COPY ^Send a copy of a message to someone +=== 0^SEND PRIVATE ^Send a personal message +=== 0^SEND NOPRIVATE ^Send a message to all stations +All the SEND commands will create a message which will be sent either to +an individual callsign or to one of the 'bulletin' addresses. + +SEND on its own acts as though you had typed SEND PRIVATE, that is +it will mark the message as personal and send it to the cluster node that +that callsign is connected to. + +You can have more than one callsign in all of the SEND commands. + +You can have multiple qualifiers so that you can have for example:- + + SEND RR COPY 123 PRIVATE G1TLH G0RDI + +which should send a copy of message 123 to G1TLH and G0RDI and you will +receive a read receipt when they have read the message. + +SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak) +SP is an alias for SEND PRIVATE + +=== 0^SET/ADDRESS ^Record your postal address + +=== 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal +=== 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal + +=== 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 + +=== 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/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 + +=== 0^SET/HOMENODE ^Set your normal cluster callsign +Tell the cluster system where you normally connect to. Any Messages sent +to you will normally find their way there should you not be connected. +eg:- + SET/HOMENODE gb7djk + +=== 9^SET/ISOLATE^Isolate a node from the rest of the network +Connect a node to your system in such a way that you are a full protocol +member of its network and can see all spots on it, but nothing either leaks +out from it nor goes back into from the rest of the nodes connected to you. + +You can potentially connect several nodes in this way. + +=== 9^UNSET/ISOLATE^Stop Isolation of a node from the rest of the network +Remove isolation from a node - SET/ISOLATE + +=== 0^SET/LANGUAGE ^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) and nl (dutch). + +=== 0^SET/LOCATION ^Set your latitude and longitude +=== 9^SET/SYS_LOCATION ^Set your cluster latitude and longitude +In order to get accurate headings and such like you must tell the system +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 + +=== 0^SET/NAME ^Set your name +Tell the system what your name is eg:- + SET/NAME Dirk + +=== 9^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. + +=== 9^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