X-Git-Url: http://scm.dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=sgml%2Fadminmanual_en.sgml;h=d8767a879cd5d1f344770a7124e32b1bdc9a175b;hb=1aac4bfce7659fc802741267238f7cc008a97ca7;hp=23bbd0b5b18b7e0d3b3d859a916a4110dca9b573;hpb=7c3d8bfac8fa88490ef5473116ef73656934c4bf;p=spider.git diff --git a/sgml/adminmanual_en.sgml b/sgml/adminmanual_en.sgml index 23bbd0b5..d8767a87 100644 --- a/sgml/adminmanual_en.sgml +++ b/sgml/adminmanual_en.sgml @@ -4,10 +4,10 @@ -
+There is now an excellent primer/tutorial on filtering written by Jim
+Samuels, W3BG with an introduction by Dave Hawes N3RD that I strongly
+suggest you read. You can read it here
+
+
+
+
+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:-
+
+
@@ -2376,6 +2437,164 @@ necessary to traverse the network(s) to logon to the cluster <callsign>.
Title says it all really, this command lists all the databases defined
in the system. It is also aliased to SHOW/COMMAND.
+
+
+
+
+
+
+
+
+
+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:
+
+
+
+
+
+
+
+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:-
+
+
+
+
+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:
+
+
@@ -2399,6 +2618,73 @@ SHOW/COMMAND to find out) you can do the same thing with:
DBSHOW buck G1TLH
+
+
+
+Executing this command will only have an effect if you are running the cluster
+in debug mode i.e.
+
+
+
+
+This command will completely remove a one or more callsigns
+from the US States database.
+
+There is NO SECOND CHANCE.
+
+It goes without saying that you should use this command CAREFULLY!
+
+Note that these callsign may be re-instated by any weekly updates from
+the FCC.
+
+
+
+This command will completely remove a one or more users from the database.
+
+There is NO SECOND CHANCE.
+
+It goes without saying that you should use this command CAREFULLY!
+
+
+
+This command is provided so that sysops can demonstrate commands to
+other users. It runs a command as though that user had typed it in and
+then sends the output to that user, together with the command that
+caused it.
+
+
@@ -2597,6 +2883,45 @@ produces:-
on the output.
+
+
+
+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 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 <filename>.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.
@@ -2834,6 +3159,22 @@ node>).
Best of luck - you will need it.
+
+
+
+JOIN allows you to join a network wide conference group. To join a
+group (called FOC in this case) type:-
+
+
@@ -2971,6 +3312,22 @@ Remove this message from the entire cluster system as well as your node.
+
+
+
+LEAVE allows you to leave a network wide conference group. To leave a
+group (called FOC in this case) type:-
+
+
@@ -2981,6 +3338,77 @@ Remove this message from the entire cluster system as well as your node.
This is a quick listing that shows which links are connected and
some information about them. See WHO for a list of all connections.
+
+
+
+Reload the /spider/cmd/Aliases file after you have editted it. You
+will need to do this if you change this file whilst the cluster is
+running in order for the changes to take effect.
+
+
+
+Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
+the cluster is running. This table contains a number of perl regular
+expressions which are searched for in the fields targetted of each message.
+If any of them match then that message is immediately deleted on receipt.
+
+
+
+Reload the /spider/data/badwords file if you have changed it manually whilst
+the cluster is running. This file contains a list of words which, if found
+on certain text portions of PC protocol, will cause those protocol frames
+to be rejected. It will all put out a message if any of these words are
+used on the announce, dx and talk commands. The words can be one or
+more on a line, lines starting with '#' are ignored.
+
+
+
+Reload the /spider/data/bands.pl file if you have changed it manually whilst
+the cluster is running.
+
+
+
+Normally, if you change a command file in the cmd or local_cmd tree it
+will automatially be picked up by the cluster program. Sometimes it
+can get confused if you are doing a lot of moving commands about or
+delete a command in the local_cmd tree and want to use the normal one
+again. Execute this command to reset everything back to the state it
+was just after a cluster restart.
+
+
+
+Reload the /spider/msg/forward.pl file if you have changed it
+manually whilst the cluster is running.
@@ -3010,6 +3438,30 @@ If there is a message number, then it will take the message, run
convkeps.pl on it and then load the data, all in one step.
These messages are sent to ALL by GB7DJK (and others) from time to time.
+
+
+
+If you change the /spider/perl/Messages file (usually whilst
+fiddling/writing new commands) you can have them take effect during a
+cluster session by executing this command. You need to do this if get
+something like :-
+
+unknown message 'xxxx' in lang 'en'
+
+
+
+Reload the /spider/data/prefix_data.pl file if you have changed it
+manually whilst the cluster is running.
@@ -3025,21 +3477,58 @@ 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).
-
-
-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:-
+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.
+
+
+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:-
+
+
+
+
+This sysop only cammand allows you to save the output of one or more
+commands to a file. For example:-
+
+
@@ -3647,6 +4195,14 @@ You can carry on with the message until you are ready to send it.
+
+
+
+
+
+
-
-
-
-
@@ -3727,6 +4291,20 @@ eg:-
+
+
+
+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.
+
@@ -3736,8 +4314,8 @@ eg:-
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).
@@ -3745,12 +4323,20 @@ and nl (Dutch).
+
+
+
-
@@ -3835,6 +4421,90 @@ When you execute this command it will ask you for your old password,
then ask you to type in your new password twice (to make sure you
get it right). You may or may not see the data echoed on the screen
as you type, depending on the type of telnet client you have.
+
+
+
+The password for a user can only be set by a full sysop. The string
+can contain any characters.
+
+The way this field is used depends on context. If it is being used in
+the SYSOP command context then you are offered 5 random numbers and you
+have to supply the corresponding letters. This is now mainly for ax25
+connections.
+
+If it is being used on incoming telnet connections then, if a password
+is set or the:
+
+
+
+
+As from release 1.35 all neighbouring nodes are pinged at regular intervals
+in order to determine the rolling quality of the link and, in future, to
+affect routing decisions. The default interval is 300 secs or 5 minutes.
+
+You can use this command to set a different interval. Please don't.
+
+But if you do the value you enter is treated as minutes up 30 and seconds
+for numbers greater than that.
+
+This is used also to help determine when a link is down at the far end
+(as certain cluster software doesn't always notice), see SET/OBSCOUNT
+for more information.
+
+If you must change it (and it may be useful for internet connected nodes
+on dynamic IP addresses that go away after a set time of usage) the time
+can be specified as:-
+
+
+
+
+Set the privilege level on a callsign. The privilege levels that pertain
+to commands are as default:-
+
@@ -3871,6 +4541,14 @@ Tell the system where you are. For example:-
SET/QTH East Dereham, Norfolk
+
+
@@ -3881,6 +4559,56 @@ Tell the system where you are. For example:-
Tell the system that the call(s) are to be treated as DXSpider node and
fed new style DX Protocol rather normal user commands.
+
+
+
+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.
+
+
+
+
+
+
+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:-
+
+
+
@@ -3888,6 +4616,31 @@ fed new style DX Protocol rather normal user commands.
+
+
+
+This command allows you to add or alter a callsign in the US state
+database. Use with extreme caution. Anything you do here will be
+overwritten by any weekly updates that affect this callsign
+
+
+
+
Display all the bad words in the system, see SET/BADWORD
for more information.
+
+
+
+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.
@@ -4008,6 +4773,23 @@ 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.
+
+
+
+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:-
+
+
@@ -4036,6 +4818,14 @@ and returns any information available for that callsign. This service
is provided for users of this software by http://www.qslinfo.de.
See also SHOW/QRZ, SHOW/WM7D.
+
+
+
@@ -4111,7 +4901,50 @@ any order to the basic SHOW/DX command, they are:-
You can also use this with the 'by' keyword so
eg by W dxcc
-
+
+
+
+
+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:-
+
+
@@ -4167,6 +5034,20 @@ This can be done with the SHOW/DX command like this:-
Show the total DX spots for the last <days> no of days (default is 31),
starting from a <date> (default: today).
+
+
+
+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
@@ -4281,6 +5162,14 @@ all the categories will be listed.
+
+
+
+
+
+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.
@@ -4531,6 +5439,14 @@ and returns any information available for that callsign. This service
is provided for users of this software by http://www.qrz.com
See also SHOW/WM7D for an alternative.
+
+
+
@@ -4576,6 +5492,23 @@ So for example:-
SH/SAT FENGYUN1 12 2
+
+
+
+View the contents of a startup script created with SET/STARTUP.
+
+
+
@@ -4788,6 +5721,25 @@ Display the most recent WWV information that has been received by the system
Shutdown the cluster and disconnect all the users
+
+
+
+This command is provided so that sysops can set a user's parameters without
+me having to write a special 'sysop' version for every user command. It
+allows you to pretend that you are doing the command as the user you specify.
+
+eg:-
+
+
@@ -5169,6 +6121,25 @@ will allow text with this word again.
+
+
+
+You can choose to log several different levels. The levels are
+
+
@@ -5177,6 +6148,22 @@ will allow text with this word again.
+
+
+
+Display both the Spotter's and the Spotted's CQ Zone on the end
+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: SET/DXGRID, SET/DXITU, SHOW/USSTATE
+
+Do a STAT/USER to see which flags you have set if you are confused.
@@ -5190,24 +6177,26 @@ 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.
-
-
-If the spotter's or spotted's US State is known it is output on the
-end of a DX announcement (there is just enough room).
+Display both the Spotter's and the Spotted's ITU Zone on the end
+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.
-A spotter's state will appear on the RHS of the time (like
-SET/DXGRID) and the spotted's State will appear on the LHS of the
-time field. Any information found will override any locator
-information from SET/DXGRID.
+Conflicts with: SET/DXGRID, SET/DXCQ, SHOW/USSTATE
-Some user programs cannot cope with this. You can use this command
-to reset (or set) this feature.
+Do a STAT/USER to see which flags you have set if you are confused.
@@ -5286,14 +6275,41 @@ You can unset the hops with command UNSET/HOPS. For example:-
unset/hops gb7mbc spots
+
+
+
+Remove isolation from a node - SET/ISOLATE
+
+
+
-
+
+
+
+This command allows the sysop to completely delete and remove a
+password for a user.
@@ -5314,17 +6330,73 @@ SYSOP command.
-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).
+
+
+Registration is a concept that you can switch on by executing the
+
+
+
+
+You can remove your startup script with UNSET/STARTUP.
+
+
+
@@ -5333,6 +6405,28 @@ normal.
+
+
+
+If the spotter's or spotted's US State is known it is output on the
+end of a DX announcement (there is just enough room).
+
+A spotter's state will appear on the RHS of the time (like
+SET/DXGRID) and the spotted's State will appear on the LHS of the
+time field. Any information found will override any locator
+information from SET/DXGRID.
+
+Some user programs cannot cope with this. You can use this command
+to reset (or set) this feature.
+
+Conflicts with: SET/DXCQ, SET/DXITU
+
+Do a STAT/USER to see which flags you have set if you are confused.