make adjustments to the manuals and add help for accept and reject
[spider.git] / txt / adminmanual.txt
index d8078515dd125c5efae856265fa768b1e498f5d3..1c7eb7121b414043f34f6821234159ca328890ab 100644 (file)
@@ -1,6 +1,6 @@
   The DXSpider Administration Manual v1.49
-  Ian Maude, G0VGS, (ianmaude@btinternet.com)
-  December 2001 revision 1.2
+  Ian Maude, G0VGS, (g0vgs@gb7mbc.net)
+  February 2002 revision 1.3
 
   A reference for SysOps of the DXSpider DXCluster program.
   ______________________________________________________________________
 
 
   As usual, any text behind a # is treated as a comment and not read.
+  To use this file, simply rename it from startup.issue to startup.  In
+  our example above there are three options.  The first option is the
+  amount of spots that a user can request with the sh/dx command.
+  Normally the default is to give 10 spots unless the user specifies
+  more.  Without this line enabled, the maximum a user can request is
+  100 spots.  Depending on your link quality you may wish to enable more
+  or less by specifying the number.  If you simply uncomment the line,
+  the maximum would be 1 spot!
+
+
+  The other 2 options are dealt with more fully in the security section.
+
 
   Secondly, it is used to store the login scripts for users and nodes.
   Currently this can only be done by the sysop but it is envisaged that
   eventually users will be able to set their own.  An example is
   included in the distibution but here is a further example.
 
+
+
        #
        # G0FYD
        #
 
        dbcreate <name>
 
-
-
-
   To simply create a database locally, you just tell the command the
   name of the database.  This does not create the actual database, it
   simply defines it to say that it exists.
 
 
 
-       dbavail
-       DB Name          Location   Chain
-       qsl              Local
-       buck             GB7ADX
-       hftest           GB7DXM
-       G0VGS de GB7MBC  3-Feb-2001 1925Z >
 
 
+  dbavail
+  DB Name          Location   Chain
+  qsl              Local
+  buck             GB7ADX
+  hftest           GB7DXM
+  G0VGS de GB7MBC  3-Feb-2001 1925Z >
 
 
 
   /spider/data called motd and edit it to say whatever you want.  It is
   purely a text file and will be sent automatically to anyone logging in
   to the cluster.
-
-
   6.2.  MOTD_NOR
 
   This message of the day file lives in the same directory as the
   registered they will receive the same message as any other user.
 
 
-
-
   6.3.  Downtime message
 
   If for any reason the cluster is down, maybe for upgrade or
 
   An example would look like this ....
 
-
-
        sh/files
        bulletin      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
 
 
 
+
   You can see that in the files area (basically the packclus directory)
   there is a file called news and a directory called bulletin.  You can
   also see that dates they were created.  In the case of the file news,
 
 
 
+
   The page length will of course depend on what you have it set to!
 
 
   6.5.  The Aliases file
 
-  You will find a file in /spider/cmd/ called Aliases.  First, copy this
-  file to /spider/local_cmd/Aliases and edit this file.  You will see
-  something like this ...
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  You will find a file in /spider/cmd/ called Aliases.  This is the file
+  that controls what a user gets when issuing a command.  It is also
+  possible to create your own aliases for databases and files you create
+  locally.
 
 
+  You should not alter the original file in /spider/cmd/ but create a
+  new file with the same name in /spider/local_cmd.  This means that any
+  new Aliases files that is downloaded will not overwrite your self
+  created Aliases and also that you do not override any new Aliases with
+  your copy in /spider/local_cmd/.  You must remember that any files you
+  store in /spider/local/ or /spider/local_cmd override the originals if
+  the same lines are used in both files.
 
 
+  The best way of dealing with all this then is to only put your own
+  locally created Aliases in the copy in /spider/local_cmd.  The example
+  below is currently in use at GB7MBC.
 
 
 
 
+       #
+       # Local Aliases File
+       #
 
+       package CmdAlias;
 
+       %alias = (
+           'n' => [
+             '^news$', 'type news', 'type',
+           ],
+           's' => [
+             '^sh\w*/buck$', 'show/qrz', 'show',
+             '^sh\w*/hftest$', 'dbshow hftest', 'dbshow',
+             '^sh\w*/qsl$', 'dbshow qsl', 'dbshow',
+             '^sh\w*/vhf$', 'dbshow vhf', 'dbshow',
+             '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow',
+               ],
+       )
 
 
-  #!/usr/bin/perl
 
-  # provide some standard aliases for commands for terminally
-  # helpless ak1a user (helpless in the sense that they never
-  # read nor understand help files)
 
-  # This file is automagically reloaded if its modification time is
-  # later than the one stored in CmdAlias.pm
 
-  # PLEASE make this file consistant with reality! (the patterns MUST
-  # match the filenames!)
+  Each alphabetical section should be preceded by the initial letter and
+  the section should be wrapped in square brackets as you can see.  The
+  syntax is straightforward.  The first section on each line is the new
+  command that will be allowed once the alias is included.  The second
+  section is the command it is replacing and the last section is the
+  actual command that is being used.
 
-  # Don't alter this file, copy it into the local_cmd tree and modify it.
-  # This file will be replaced everytime I issue a new release.
 
-  # You only need to put aliases in here for commands that don't work as
-  # you desire naturally, e.g sh/dx on its own just works as you expect
-  # so you need not add it as an alias.
-
-
-
-  package CmdAlias;
-
-  %alias = (
-      '?' => [
-            '^\?', 'apropos', 'apropos',
-          ],
-      'a' => [
-            '^ann.*/full', 'announce full', 'announce',
-            '^ann.*/sysop', 'announce sysop', 'announce',
-            '^ann.*/(.*)$', 'announce $1', 'announce',
-          ],
-          'b' => [
-          ],
-          'c' => [
-          ],
-          'd' => [
-            '^del', 'kill', 'kill',
-            '^del\w*/fu', 'kill full', 'kill',
-            '^di\w*/a\w*', 'directory all', 'directory',
-            '^di\w*/b\w*', 'directory bulletins', 'directory',
-            '^di\w*/n\w*', 'directory new', 'directory',
-            '^di\w*/o\w*', 'directory own', 'directory',
-            '^di\w*/s\w*', 'directory subject', 'directory',
-            '^di\w*/t\w*', 'directory to', 'directory',
-            '^di\w*/f\w*', 'directory from', 'directory',
-            '^di\w*/(\d+)', 'directory $1', 'directory',
-          ],
-          'e' => [
-          ],
-          'f' => [
-          ],
-          'g' => [
-          ],
-          'h' => [
-          ],
-          'i' => [
-          ],
-          'j' => [
-          ],
-          'k' => [
-          ],
-          'l' => [
-            '^l$', 'directory', 'directory',
-            '^ll$', 'directory', 'directory',
-            '^ll/(\d+)', 'directory $1', 'directory',
-          ],
-          'm' => [
-          ],
-          'n' => [
-            '^news', 'type news', 'type',
-          ],
-          'o' => [
-          ],
-          'p' => [
-          ],
-          'q' => [
-            '^q', 'bye', 'bye',
-          ],
-          'r' => [
-            '^r$', 'read', 'read',
-            '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
-          ],
-          's' => [
-            '^s/p$', 'send', 'send',
-            '^sb$', 'send noprivate', 'send',
-            '^set/home$', 'set/homenode', 'set/homenode',
-            '^set/nobe', 'unset/beep', 'unset/beep',
-            '^set/nohe', 'unset/here', 'unset/here',
-            '^set/noan', 'unset/announce', 'unset/announce',
-            '^set/nodx', 'unset/dx', 'unset/dx',
-            '^set/nota', 'unset/talk', 'unset/talk',
-            '^set/noww', 'unset/wwv', 'unset/wwv',
-            '^set/nowx', 'unset/wx', 'unset/wx',
-            '^sh$', 'show', 'show',
-            '^sh\w*/buck', 'dbshow buck', 'dbshow',
-            '^sh\w*/bu', 'show/files bulletins', 'show/files',
-            '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
-            '^sh\w*/c$', 'show/configuration', 'show/configuration',
-            '^sh\w*/com', 'dbavail', 'dbavail',
-            '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
-            '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
-            '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
-            '^sh\w*/email', 'dbshow email', 'dbshow',
-            '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
-            '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
-            '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
-            '^sh\w*/tnc', 'who', 'who',
-            '^sh\w*/up', 'show/cluster', 'show/cluster',
-            '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
-            '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
-            '^sp$', 'send', 'send',
-
-      ],
-          't' => [
-            '^ta$', 'talk', 'talk',
-            '^t$', 'talk', 'talk',
-          ],
-          'u' => [
-          ],
-          'v' => [
-          ],
-          'w' => [
-            '^wx/full', 'wx full', 'wx',
-            '^wx/sysop', 'wx sysop', 'wx',
-          ],
-          'x' => [
-          ],
-          'y' => [
-          ],
-          'z' => [
-          ],
-  )
+  The eagle-eyed amongst you will have noticed that in the first
+  section, the new alias command has a '^' at the start and a '$' at the
+  end.  Basically these force a perfect match on the alias.  The '^'
+  says match the beginning exactly and the with similar commands.
 
 
+  I have 3 different types of alias in this file.  At the top is an
+  alias for 'news'.  This is a file I have created in the
+  /spider/packclus/ directory where I can inform users of new
+  developments or points of interest.  In it's initial form a user would
+  have to use the command type news.  The alias allows them to simply
+  type news to get the info.  Second is an alias for the show/qrz
+  command so that those users used to the original show/buck command in
+  AK1A will not get an error, and the rest of the lines are for locally
+  created databases so that a user can type show/hftest instead of
+  having to use the command dbshow hftest which is not as intuitive.
 
 
+  This file is just an example and you should edit it to your own
+  requirements.  Once created, simply issue the command load/alias at
+  the cluster prompt as the sysop user and the aliases should be
+  available.
 
-  You can create aliases for commands at will.  Beware though, these may
-  not always turn out as you think.  Care is needed and you need to test
-  the results once you have set an alias.
 
 
   6.6.  Console.pl
 
 
 
-       load/keps
+  load/keps
 
 
 
   /spider/scripts/startup.  To read more on the startup file, see the
   section on Information, files and useful programs.
 
-
   To unregister a user use unset/register and to show the list of
   registered users, use the command show/register.
 
 
-
   7.2.  Passwords
 
   At the moment, passwords only affect users who login to a DXSpider
   CVS repository and then update your Spider source.  There are several
   steps which are listed below ...
 
+
   First login as the user sysop.  Next you need to connect to the CVS
   repository.  You do this with the command below ...
 
 
 
 
-         info <string>            eg: iota or qsl
-         by <prefixes>            eg: G,M,2
-         origin <prefixes>
-         origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-         origin_itu <numbers>
-         origin_zone <numbers>
-         by_dxcc <numbers>
-         by_itu <numbers>
-         by_zone <numbers>
-         channel <prefixes>
-         wx 1                     filter WX announces
-         dest <prefixes>          eg: 6MUK,WDX      (distros)
+
+
+
+
+
+
+
+
+
+    info <string>            eg: iota or qsl
+    by <prefixes>            eg: G,M,2
+    origin <prefixes>
+    origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+    origin_itu <numbers>
+    origin_zone <numbers>
+    by_dxcc <numbers>
+    by_itu <numbers>
+    by_zone <numbers>
+    channel <prefixes>
+    wx 1                     filter WX announces
+    dest <prefixes>          eg: 6MUK,WDX      (distros)
+
+
 
 
   some examples:-
 
 
 
-
-
   9.3.  accept/route (8)
 
   accept/route <call> [0-9] <pattern> Set an 'accept' filter line for
   more info. Please read this to understand how filters work - it will
   save a lot of grief later on.
 
+
   You can use any of the following things in this line:-
 
 
   passed onto the user. See HELP FILTERS for more info. Please read this
   to understand how filters work - it will save a lot of grief later on.
 
-  You can use any of the following things in this line:-
-
-
-
-
-
-
-
-
-
-
-
 
+  You can use any of the following things in this line:-
 
 
 
-    freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
-    on <range>             same as 'freq'
-    call <prefixes>        eg: G,PA,HB9
-    info <string>          eg: iota or qsl
-    by <prefixes>
-    call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-    call_itu <numbers>
-    call_zone <numbers>
-    by_dxcc <numbers>
-    by_itu <numbers>
-    by_zone <numbers>
-    origin <prefixes>
-    channel <prefixes>
+         freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
+         on <range>             same as 'freq'
+         call <prefixes>        eg: G,PA,HB9
+         info <string>          eg: iota or qsl
+         by <prefixes>
+         call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+         call_itu <numbers>
+         call_zone <numbers>
+         by_dxcc <numbers>
+         by_itu <numbers>
+         by_zone <numbers>
+         origin <prefixes>
+         channel <prefixes>
 
 
 
 
          accept/spot user_default by G,M,2
 
-
-
-
-
   9.6.  accept/wcy (0)
 
   accept/wcy [0-9] <pattern> set an accept WCY filter