X-Git-Url: http://www.dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=html%2Fadminmanual-10.html;h=fd0deaa8ef8b10be7cb334718520dc50861ca17c;hb=1bb3ae1a09a6117d93c02041bff9b5cd2d4819ef;hp=5b030d16313f7185d5af430e9c7e82acfa10f87e;hpb=e1f91307fae936112a25ed7ce08f47214ecec766;p=spider.git diff --git a/html/adminmanual-10.html b/html/adminmanual-10.html index 5b030d16..fd0deaa8 100644 --- a/html/adminmanual-10.html +++ b/html/adminmanual-10.html @@ -1,578 +1,207 @@ - - The DXSpider Installation and Administration Manual : Sysop commands + + The DXSpider Administration Manual v1.50: CVS + + -Next +Next Previous Contents
-

10. Sysop commands

+

10. CVS

-

Most maintenance tasks are automatic but there are some commands that are useful for a sysop. These are listed below -in alphabetical order. The number in brackets following the command name is the permissions level needed to use the command. -

-

10.1 announce sysop (5) -

- -

announce sysop <text> -

-

Send an announcement to Sysops only -

-

10.2 connect (5) +

10.1 CVS from a Linux platform

-

connect <callsign> Start a connection to another DX Cluster -

-

Start a connection process that will culminate in a new connection to the -DX cluster <callsign>. This process creates a new 'client' process which will -use the script in /spider/connect/<callsign> to effect the 'chat' exchange -necessary to traverse the network(s) to logon to the cluster <callsign>. -

-

-

10.3 catch (9) -

+

CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held +at +Sourceforge. This means +that it is possible to update your DXSpider installation to the latest +sources by using a few simple commands. A graphical interface to CVS for +Windows is explained in the next section.

-

<node_call> All [<msgno> ...] Mark 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. -

-

10.4 dbcreate (9) -

+

Please be aware that if you update your system using CVS, it is possible that +you could be running code that is very beta and not fully tested. There is +a possibility that it could be unstable.

-

dbcreate <name> Create a database entry
-dbcreate <name> chain <name> [<name>..] Create a chained database entry
-dbcreate <name> remote <node> 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 statement 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/<dbname>' 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 -

-

10.5 dbimport (9) -

+

I am of course assuming that you have a machine with both DXSpider and +Internet access running.

-

dbimport <dbname> 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. -

-

10.6 dbremove (9) -

+

BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR +ENTIRE SPIDER TREE!!

-

dbremove <dbname> 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. -

-

10.7 debug (9) -

+

Assuming you are connected to the Internet, you need to login to the +CVS repository and then update your Spider source. There are several +steps which are listed below ...

-

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. +

First login as the user sysop. Next you need to connect to the CVS +repository. You do this with the command below ...

-

-        perl -d cluster.pl
+cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
 
-
-

It will interrupt the cluster just after the debug command has finished. -

-

10.8 directory (5) -

- -

Works just like the user command except that sysops can see ALL messages. -

-

10.9 disconnect (8) -

- -

disconnect <call> [<call> ...] Disconnect a user or node -

-

Disconnect any <call> connected locally -

-

10.10 export (9) -

- -

export <msgno> <filename> 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 -

-

10.11 forward/opername (1) -

+

+

You will get a password prompt. Simply hit return here and your machine should +return to a normal linux prompt.

-

forward/opername <call> Send out information on this <call> 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. -

-

10.12 init (5) -

+

What happens next depends on whether you have an existing installation that +you want to update with the latest and greatest or whether you just want +to see what is there and/or run it on a new machine for testing.

+

If you are installing Spider from CVS then change directory to /home/sysop

+

If you are wanting to update Spider then cd to /tmp

-

init <node call> Re-initialise a link to an AK1A compatible node +

The next step will create a brand new 'spider' directory in your current +directory.

-

This command attempts to re-initialise a link to a (usually) AK1A node -that has got confused, usually by a protocol loop of some kind. It may -work - but you usually will be better off simply disconnecting it (or -better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your -node>). -

Best of luck - you will need it. -

-

10.13 kill (5) -

- -

kill <msgno> [<msgno> ...] Remove or erase a message from the system
-kill from <call> Remove all messages from a callsign
-kill to <call> Remove all messages to a callsign
-

-

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. -

As a sysop you can kill any message on the system. -

-

10.14 kill full (5) -kill full <msgno> [<msgno>] Delete a message from the whole cluster

- -

Delete a message (usually a 'bulletin') from the whole cluster system. -

This uses the subject field, so any messages that have exactly the same subject -will be deleted. Beware! -

-

10.15 load/aliases (9) -

- -

load/aliases Reload the command alias table -

-

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. -

-

10.16 load/baddx (9) -load/baddx Reload the bad DX table

- -

Reload the /spider/data/baddx.pl file if you have changed it manually whilst -the cluster is running. This table contains the DX Calls that, if spotted, -will not be passed on. FR0G and TEST are classic examples. -

-

10.17 load/badmsg (9) -

- -

load/badmsg Reload the bad message table -

-

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. -

-

10.18 load/badwords (9) -

- -

load/badwords Reload the badwords file -

-

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. -

-

10.19 load/bands (9) -

- -

load/bands Reload the band limits table -

-

Reload the /spider/data/bands.pl file if you have changed it manually whilst -the cluster is running. -

-

10.20 load/cmd_cache (9) -

- -

load/cmd_cache Reload the automatic command cache -

-

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. -

-

10.21 load/forward (9) -

+
+cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider
+
+

+

This command is all on one line.

-

load/forward Reload the msg forwarding routing table -

Reload the /spider/msg/forward.pl file if you have changed it -manually whilst the cluster is running. -

-

10.22 load/messages (9) -

+

Hopefully your screen should show you downloading files. The -z3 simply compresses +the download to improve speed. +When this has finished, you will have exactly the same as if you had untarred a full +tarball PLUS some extra directories and files that CVS needs to do the magic that +it does.

-

load/messages Reload the system messages file -

-

If you change the /spider/perl/Messages file (usually whilst fiddling/writing ne -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' -

-

10.23 load/prefixes (9) -

+

Now if you are doing a new installation, that's it. Carry on as if you have +just downloaded and untarred the lastest tarball.

-

load/prefixes Reload the prefix table -

-

Reload the /spider/data/prefix_data.pl file if you have changed it manually whilst -the cluster is running. -

-

10.24 merge (5) -

- -

merge <node> [<no spots>/<no wwv>] 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). -

-

10.25 msg (9) -

- -

msg <cmd> <msgno> [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. +

If you want to upgrade your current installation then do this ...

-  MSG TO <msgno> <call>     - change TO callsign to <call>
-  MSG FRom <msgno> <call>   - change FROM callsign to <call>
-  MSG PRrivate <msgno>      - set private flag
-  MSG NOPRrivate <msgno>    - unset private flag
-  MSG RR <msgno>            - set RR flag
-  MSG NORR <msgno>          - unset RR flag
-  MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
-  MSG NOKEep <msgno>        - unset the keep flag
-  MSG SUbject <msgno> <new> - change the subject to <new>
-  MSG WAittime <msgno>      - remove any waitting time for this message
-  MSG NOREad <msgno>        - mark message as unread
-  MSG REad <msgno>          - mark message as read
-  MSG QUeue                 - queue any outstanding bulletins
-  MSG QUeue 1               - queue any outstanding private messages
+tar cvfz /tmp/s.tgz spider
+cd /
+tar xvfzp /tmp/s.tgz
 
-

You can look at the status of a message by using:- -

STAT/MSG <msgno> -

This will display more information on the message than DIR does. -

-

10.26 pc (8) -

+

+

This is assuming you downloaded to the /tmp directory of course.

-

pc <call> <text> Send text (eg PC Protocol) to <call> -

-

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^ -

You can also use in the same way as a talk command to a connected user but -without any processing, added of "from <blah> to <blah>" or whatever. -

pc G1TLH Try doing that properly!!! -

-

10.27 ping (1) -

- -

ping <node> Send a ping command to another cluster node -

-

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. -

Any visible cluster node can be PINGed. -

-

10.28 rcmd (1) -

- -

rcmd <node call> <cmd> 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. -

-

10.29 read (5) -

- -

read <msgno> Read a message on the system -

-

As a sysop you may read any message on the system -

-

10.30 set/debug (9) -

- -

set/debug <name> Add a debug level to the debug set -

-

You can remove this level with unset/debug <name> -

-

10.31 set/isolate (9) -

- -

set/isolate <node call> 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. -

You can see which nodes are isolated with the show/isolate (1) command. -

You can remove the isolation with the command unset/isolate. -

-

10.32 set/sys_location (9) -

+

NOTE: the 'p' on the end of the 'xvfz' is IMPORTANT! It keeps the permissions +correct. YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????

+

Remember to recompile the C client (cd /spider/src; make)

-

set/sys_location <lat & long> 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 -

-

10.33 set/lockout (9) -

+

At this point the files have been upgraded. You can (usually) restart the cluster +in your own time. However, if you attempt to use any new commands or features +expect it to be fatal! At least your cluster will have been restarted then so it +will be too late to worry about it!

-

set/lockout <call> Stop a callsign connecting to the cluster -

-

You can show who is locked out with the show/lockout (9) command. -

To allow the user to connect again, use the command unset/lockout -

-

10.34 set/node (9) -

- -

set/node <call> [<call> ...] 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. -

From version 1.41 you can also set the following types of cluster +

Now the magic part! From now on when you want to update, simply connect to the +Internet and then, as the user sysop ...

+

-set/spider
-set/dxnet
-set/clx
-set/arcluster
+cd /spider
+cvs -z3 update -d
 
-

To see what your nodes are set to, use the show/nodes command. -

-

10.35 set/obscount (9) -

- -

set/obscount <count> <node call> Set the 'pump-up' obscelence counter -

-

From version 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. -

-

10.36 set/pinginterval (9) -

- -

set/pinginterval <time> <node call> Set the ping time to neighbouring nodes -

-

As from version 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 60 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. -

-

10.37 set/privilege (9) -

- -

set/privilege <n> <call> [<call> ...] Set the privilege level on a call -

-

Set the privilege level on a callsign. The privilege levels that pertain -to commands are as default:- -

+

+

+

and your files will be updated. As above, remember to recompile the "C" client +if it has been updated (CVS will tell you) and restart if any of the perl scripts +have been altered or added, again, CVS will tell you.

+ +

You will find any changes documented in the /spider/Changes file.

+ +

10.2 CVS from a Windows platform +

+ +

After the initial setup, an update to your DXSpider software is no more than a couple +of clicks away. This section is intended to explain and illustrate the use of the +WinCVS application to update your DXSpider software. The current stable version of +WinCVS is Ver. 1.2. You can get this software at:

+

+http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip

+

Pick your download mirror and then install WinCVS after the download is complete.

+

In this next section I have included a series of links to .jpg files to take advantage of the +picture and 1000 words equivalency. The .jpg files are in the C:\spider\html directory. If +someone using a Linux system is reading this section from boredom, the files are in +/home/sysop/spider/html. One aside, a Linux user can also get a copy of gcvs and do your updates +graphically as opposed to from the command line. The following descriptions are almost identical +between WinCvs and gcvs. The following screen shots have duplicate links, depending upon whether +you are viewing this information under the Windows or Linux operating system.

+

When WinCVS is installed, running, and you are connected to the internet, the initial screen looks like:

+

+initial.jpg

+

If you want, you can also look at these .jpg files with another viewer that might provide some +better clarity to the image. On the left is the directory tree for your hard disk. Notice that +the spider directory has a gray highlight.

+

To start configuring WinCVS, click on Admin at the top of the screen and then Preferences. This +should get you:

+

+pref-gen.jpg

+

In the top line for CVSROOT, enter:

-  0 - normal user
-  1 - allow remote nodes normal user RCMDs
-  5 - various privileged commands (including shutdown, but not disc-
-      connect), the normal level for another node.
-  8 - more privileged commands (including disconnect)
-  9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
-      LEVEL.
+anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
+
+
+

+

and select +

+
+"passwd" file on the cvs server
+
+
+

+

for Authentication on the General tab.

+

Next, move to the right to the Ports tab.

+

+pref-ports.jpg

+

In here, check the box on the second line down for the "pserver" port. Enter a port number of 2401.

+

Finally, go to the WinCvs tab all the way to the right.

+

+pref-wincvs.jpg

+

Enter Notepad as the viewer to open files. For the HOME folder, put "C:\spider" and click OK +because the configuration is now complete.

+

You are now ready to upgrade your copy of DXSpider. Click on the greyed Spider folder +shown in the directory tree on the left of the WinCVS display. Two things should happen. The Spider +folder will be selected and the greyed-out arrow located just below the word Query in the top line will +turn to solid green.

+

For anyone using gcvs under Linux, the green arrow is located on the extreme left of the display, +under the word File. A gcvs screen looks like:

+

+gcvs.jpg

+

Click on the now green arrow to start the download process. An Update Settings box will be displayed +to which you can simply say OK.

+

+update-OK.jpg

+

For future reference, the Update Settings box is the place where you can enter information to revert +to a prior version of DXSpider. Information on reverting to a Before Date is contained in the WinCVS +manual.

+

After a short period of time, a series of file names will scroll by in the lower pane of the WinCVS +window. Eventually you should see +

+
+*****CVS exited normally with code 0*****
 
-

If you are a sysop and you come in as a normal user on a remote connection -your privilege will automatically be set to 0. -

-

10.38 set/password (9) -

- -

set/password <callsign> <string> Set a users password -

-

The password for a user can only be set by a full sysop. The string -can contain any characters but any spaces are removed (you can type in -spaces - but they won't appear in the password). You can see the -result with STAT/USER. The password is the usual 30 character baycom -type password. -

-

10.39 set/sys_qra (9) -

- -

set/sys_qra <locator> Set your cluster QRA locator -

-

10.40 show/call (1) -

- -

show/call Show any callbook details on a program -This command queries an international callbook server on the internet -and returns any information available for that callsign. -

-

10.41 show/program (5) -

- -

show/program Show the locations of all the included program modules -

-

Show the name and location where every program module was load from. This -is useful for checking where you think you have loaded a .pm file from. -

-

10.42 shutdown (5) -

- -

shutdown Shutdown the cluster -

-

Shutdown the cluster and disconnect all the users. If you have Spider -set to respawn in /etc/inittab it will of course restart. -

-

10.43 spoof (9) -

- -

spoof <callsign> <command> Run commands as another user -

-

This is a very simple yet powerful command for the sysop. It allows you to -issue commands as if you were a different user. This is very useful for the -kind of things that users seem to always get wrong.. like home_node for -example. -

-

10.44 stat/db (5) -

- -

stat/db <dbname> Show the status of a database -

-

Show the internal status of a database descriptor. -

Depending on your privilege level you will see more or less information. -This command is unlikely to be of much use to anyone other than a sysop. -

-

10.45 stat/channel (5) -

- -

stat/channel <callsign> Show the status of a channel on the cluster -

-

Show the internal status of the channel object either for the channel that -you are on or else for the callsign that you asked for. -

Only the fields that are defined (in perl term) will be displayed. -

-

10.46 stat/msg (5) -

-

stat/msg <msgno> Show the status of a message -

-

This command shows the internal status of a message and includes information -such as to whom it has been forwarded, its size, origin etc etc. +appear in the lower pane. You're done. The updated files are in place ready for you to stop and then +restart your DXSpider. After the restart, you're running with the latest version of DXSpider.

-

10.47 stat/user (5) -

+completed.jpg

+

To paraphrase from the CVS section... Now the magic part! From now on when you want to update, simply +connect to the Internet and start WinCVS. +

+
+Click on the greyed-out Spider directory in the left screen
+Click on the green down arrow
+Click OK on the Update Settings dialog box
+Restart your Spider software
+
+
+

-

stat/user <callsign> Show the full status of a user -

-

Shows the full contents of a user record including all the secret flags -and stuff. -

Only the fields that are defined (in perl term) will be displayed. -

-

-


-Next +Next Previous Contents