html/adminmanual-8.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
   2 <HTML>
   3 <HEAD>
   4  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
   5  <TITLE>The DXSpider Installation and Administration Manual : Information, files and useful programs</TITLE>
   6  <LINK HREF="adminmanual-9.html" REL=next>
   7  <LINK HREF="adminmanual-7.html" REL=previous>
   8  <LINK HREF="adminmanual.html#toc8" REL=contents>
   9 </HEAD>
  10 <BODY>
  11 <A HREF="adminmanual-9.html">Next</A>
  12 <A HREF="adminmanual-7.html">Previous</A>
  13 <A HREF="adminmanual.html#toc8">Contents</A>
  14 <HR>
  15 <H2><A NAME="s8">8. Information, files and useful programs</A></H2>
  16
  17 <H2><A NAME="ss8.1">8.1 MOTD</A>
  18 </H2>
  19
  20 <P>One of the more important things a cluster sysop needs to do is to get information to his users.  The simplest way to do
  21 this is to have a banner that is sent to the user on login.  This is know as a "message of the day" or "motd".  To set this
  22 up, simply create a file in /spider/data called motd and edit it to say whatever you want.  It is purely a text file and
  23 will be sent automatically to anyone logging in to the cluster.
  24 <P>
  25 <H2><A NAME="ss8.2">8.2 Downtime message</A>
  26 </H2>
  27
  28 <P>If for any reason the cluster is down, maybe for upgrade or maintenance but the machine is still running, a message can be
  29 sent to the user advising them of the fact.  This message lives in the /spider/data directory and is called "offline".  Simply
  30 create the file and edit it to say whatever you wish.  This file will be sent to a user attempting to log into the cluster
  31 when DXSpider is not actually running.
  32 <P>
  33 <H2><A NAME="ss8.3">8.3 Other text messages</A>
  34 </H2>
  35
  36 <P>You can set other text messages to be read by the user if they input the file name.  This could be for news items or maybe
  37 information for new users.  To set this up, make a directory under /spider called <EM>packclus</EM>.  Under this directory you
  38 can create files called <EM>news</EM> or <EM>newuser</EM> for example.  In fact you can create files with any names you like.
  39 These can be listed by the user with the command ....
  40 <P>
  41 <BLOCKQUOTE><CODE>
  42 <PRE>
  43 show/files
  44 </PRE>
  45 </CODE></BLOCKQUOTE>
  46 <P>They can be read by the user by typing the command ....
  47 <P>
  48 <BLOCKQUOTE><CODE>
  49 <PRE>
  50 type news
  51 </PRE>
  52 </CODE></BLOCKQUOTE>
  53 <P>If the file they want to read is called <EM>news</EM>.  You could also set an alias for this in the Alias file to allow them
  54 just to type <EM>news</EM>
  55 <P>
  56 <P>You can also store other information in this directory, either directly or nested under directories.  One use for this would
  57 be to store DX bulletins such as the OPDX bulletins.  These can be listed and read by the user.  To keep things tidy, make a
  58 directory under /spider/packclus called <EM>bulletins</EM>.  Now copy any OPDX or similar bulletins into it.  These can be
  59 listed by the user in the same way as above using the <EM>show/files</EM> command with an extension for the bulletins
  60 directory you have just created, like this ....
  61 <P>
  62 <BLOCKQUOTE><CODE>
  63 <PRE>
  64 show/files bulletins
  65 </PRE>
  66 </CODE></BLOCKQUOTE>
  67 <P>
  68 <P>An example would look like this ....
  69 <P>
  70 <BLOCKQUOTE><CODE>
  71 <PRE>
  72 sh/files
  73 bulletins      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
  74 </PRE>
  75 </CODE></BLOCKQUOTE>
  76 <P>You can see that in the files area (basically the packclus directory) there is a file called <EM>news</EM> and a directory
  77 called <EM>bulletins</EM>.  You can also see that dates they were created.  In the case of the file <EM>news</EM>, you can
  78 also see the time it was last modified, a good clue as to whether the file has been updated since you last read it.  To read
  79 the file called <EM>news</EM> you would simply issue the command ....
  80 <P>
  81 <BLOCKQUOTE><CODE>
  82 <PRE>
  83 type news
  84 </PRE>
  85 </CODE></BLOCKQUOTE>
  86 <P>To look what is in the bulletins directory you issue the command ....
  87 <P>
  88 <BLOCKQUOTE><CODE>
  89 <PRE>
  90 show/files bulletins
  91 opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
  92 opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z
  93 opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z
  94 opdx394      33429 29-Nov-1999 1621Z opdx394.1     3116 29-Nov-1999 1621Z
  95 opdx395      24319 29-Nov-1999 1621Z opdx396      32647 29-Nov-1999 1621Z
  96 opdx396.1     5537 29-Nov-1999 1621Z opdx396.2     6242 29-Nov-1999 1621Z
  97 opdx397      18433 29-Nov-1999 1621Z opdx398      19961 29-Nov-1999 1621Z
  98 opdx399      17719 29-Nov-1999 1621Z opdx400      19600 29-Nov-1999 1621Z
  99 opdx401      27738 29-Nov-1999 1621Z opdx402      18698 29-Nov-1999 1621Z
 100 opdx403      24994 29-Nov-1999 1621Z opdx404      15685 29-Nov-1999 1621Z
 101 opdx405      13984 29-Nov-1999 1621Z opdx405.1     4166 29-Nov-1999 1621Z
 102 opdx406      28934 29-Nov-1999 1621Z opdx407      24153 29-Nov-1999 1621Z
 103 opdx408      15081 29-Nov-1999 1621Z opdx409      23234 29-Nov-1999 1621Z
 104 Press Enter to continue, A to abort (16 lines) >
 105 </PRE>
 106 </CODE></BLOCKQUOTE>
 107 <P>You can now read any file in this directory using the type command, like this ....
 108 <P>
 109 <BLOCKQUOTE><CODE>
 110 <PRE>
 111 type bulletins/opdx391
 112 Ohio/Penn DX Bulletin No. 391
 113 The Ohio/Penn Dx PacketCluster
 114 DX Bulletin No. 391
 115 BID: $OPDX.391
 116 January 11, 1999
 117 Editor Tedd Mirgliotta, KB8NW
 118 Provided by BARF-80 BBS Cleveland, Ohio
 119 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
 120 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
 121 Association, Ohio/Penn PacketCluster Network, K1XN &amp; Golist, WB2RAJ/WB2YQH
 122 &amp; The 59(9) DXReport, W3UR &amp; The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
 123 Press Enter to continue, A to abort (508 lines) >
 124 </PRE>
 125 </CODE></BLOCKQUOTE>
 126 <P>The page length will of course depend on what you have it set to!
 127 <P>
 128 <H2><A NAME="ss8.4">8.4 The Aliases file</A>
 129 </H2>
 130
 131 <P>You will find a file in /spider/cmd/ called Aliases.  First, copy this file to /spider/local_cmd/Aliases and edit this file.
 132 You will see something like this ...
 133 <P>
 134 <BLOCKQUOTE><CODE>
 135 <PRE>
 136
 137 #!/usr/bin/perl
 138
 139 # provide some standard aliases for commands for terminally
 140 # helpless ak1a user (helpless in the sense that they never
 141 # read nor understand help files)
 142
 143 # This file is automagically reloaded if its modification time is
 144 # later than the one stored in CmdAlias.pm
 145
 146 # PLEASE make this file consistant with reality! (the patterns MUST
 147 # match the filenames!)
 148
 149 # Don't alter this file, copy it into the local_cmd tree and modify it.
 150 # This file will be replaced everytime I issue a new release.
 151
 152 # You only need to put aliases in here for commands that don't work as
 153 # you desire naturally, e.g sh/dx on its own just works as you expect
 154 # so you need not add it as an alias.
 155
 156
 157
 158 package CmdAlias;
 159
 160 %alias = (
 161     '?' => [
 162           '^\?', 'apropos', 'apropos',
 163         ],
 164     'a' => [
 165           '^ann.*/full', 'announce full', 'announce',
 166           '^ann.*/sysop', 'announce sysop', 'announce',
 167           '^ann.*/(.*)$', 'announce $1', 'announce',
 168         ],
 169         'b' => [
 170         ],
 171         'c' => [
 172         ],
 173         'd' => [
 174           '^del', 'kill', 'kill',
 175           '^del\w*/fu', 'kill full', 'kill',
 176           '^di\w*/a\w*', 'directory all', 'directory',
 177           '^di\w*/b\w*', 'directory bulletins', 'directory',
 178           '^di\w*/n\w*', 'directory new', 'directory',
 179           '^di\w*/o\w*', 'directory own', 'directory',
 180           '^di\w*/s\w*', 'directory subject', 'directory',
 181           '^di\w*/t\w*', 'directory to', 'directory',
 182           '^di\w*/f\w*', 'directory from', 'directory',
 183           '^di\w*/(\d+)', 'directory $1', 'directory',
 184         ],
 185         'e' => [
 186         ],
 187         'f' => [
 188         ],
 189         'g' => [
 190         ],
 191         'h' => [
 192         ],
 193         'i' => [
 194         ],
 195         'j' => [
 196         ],
 197         'k' => [
 198         ],
 199         'l' => [
 200           '^l$', 'directory', 'directory',
 201           '^ll$', 'directory', 'directory',
 202           '^ll/(\d+)', 'directory $1', 'directory',
 203         ],
 204         'm' => [
 205         ],
 206         'n' => [
 207           '^news', 'type news', 'type',
 208         ],
 209         'o' => [
 210         ],
 211         'p' => [
 212         ],
 213         'q' => [
 214           '^q', 'bye', 'bye',
 215         ],
 216         'r' => [
 217           '^r$', 'read', 'read',
 218           '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
 219         ],
 220         's' => [
 221           '^s/p$', 'send', 'send',
 222           '^sb$', 'send noprivate', 'send',
 223           '^set/home$', 'set/homenode', 'set/homenode',
 224           '^set/nobe', 'unset/beep', 'unset/beep',
 225           '^set/nohe', 'unset/here', 'unset/here',
 226           '^set/noan', 'unset/announce', 'unset/announce',
 227           '^set/nodx', 'unset/dx', 'unset/dx',
 228           '^set/nota', 'unset/talk', 'unset/talk',
 229           '^set/noww', 'unset/wwv', 'unset/wwv',
 230           '^set/nowx', 'unset/wx', 'unset/wx',
 231           '^sh$', 'show', 'show',
 232           '^sh\w*/buck', 'dbshow buck', 'dbshow',
 233           '^sh\w*/bu', 'show/files bulletins', 'show/files',
 234           '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
 235           '^sh\w*/c$', 'show/configuration', 'show/configuration',
 236           '^sh\w*/com', 'dbavail', 'dbavail',
 237           '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
 238           '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
 239           '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
 240           '^sh\w*/email', 'dbshow email', 'dbshow',
 241           '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
 242           '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
 243           '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
 244           '^sh\w*/tnc', 'who', 'who',
 245           '^sh\w*/up', 'show/cluster', 'show/cluster',
 246           '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
 247           '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
 248           '^sp$', 'send', 'send',
 249
 250     ],
 251         't' => [
 252           '^ta$', 'talk', 'talk',
 253           '^t$', 'talk', 'talk',
 254         ],
 255         'u' => [
 256         ],
 257         'v' => [
 258         ],
 259         'w' => [
 260           '^wx/full', 'wx full', 'wx',
 261           '^wx/sysop', 'wx sysop', 'wx',
 262         ],
 263         'x' => [
 264         ],
 265         'y' => [
 266         ],
 267         'z' => [
 268         ],
 269 )
 270 </PRE>
 271 </CODE></BLOCKQUOTE>
 272 <P>You can create aliases for commands at will.  Beware though, these may not always turn out as you think.  Care is needed
 273 and you need to test the results once you have set an alias.
 274 <P>
 275 <H2><A NAME="ss8.5">8.5 Forward.pl</A>
 276 </H2>
 277
 278 <P>DXSpider receives all and any mail sent to it without any alterations needed
 279 in files.  Because personal and bulletin mail are treated differently, there
 280 is no need for a list of accepted bulletin addresses.  It is necessary, however,
 281 to tell the program which links accept which bulletins.  For example, it is
 282 pointless sending bulletins addresses to "UK" to any links other than UK
 283 ones.  The file that does this is called forward.pl and lives in /spider/msg.
 284 At default, like other spider files it is named forward.pl.issue.  Rename it
 285 to forward.pl and edit the file to match your requirements.
 286 The format is below ...
 287 <P>
 288 <BLOCKQUOTE><CODE>
 289 <PRE>
 290 #
 291 # this is an example message forwarding file for the system
 292 #
 293 # The format of each line is as follows
 294 #
 295 #     type    to/from/at pattern action  destinations
 296 #     P/B/F     T/F/A     regex   I/F    [ call [, call ...] ]
 297 #
 298 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
 299 # to/from/at: T - to field, F - from field, A - home bbs, O - origin
 300 # pattern: a perl regex on the field requested
 301 # action: I - ignore, F - forward
 302 # destinations: a reference to an array containing node callsigns
 303 #
 304 # if it is non-private and isn't in here then it won't get forwarded
 305 #
 306 # Currently only type B msgs are affected by this code.
 307 #
 308 # The list is read from the top down, the first pattern that matches
 309 # causes the action to be taken.
 310 #
 311 # The pattern can be undef or 0 in which case it will always be selected
 312 # for the action specified
 313 #
 314 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
 315 # pattern) then it will always be forwarded to every node that doesn't have
 316 # it (I strongly recommend you don't use this unless you REALLY mean it, if
 317 # you allow a new link with this on EVERY bull will be forwarded immediately
 318 # on first connection)
 319 #
 320
 321 package DXMsg;
 322
 323 @forward = (
 324 'B',    'T',    'LOCAL',        'F',    [ qw(GB7MBC) ],
 325 'B',    'T',    'ALL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 326 'B',    'T',    'UK',           'F',    [ qw(GB7BAA GB7ADX) ],
 327 'B',    'T',    'QSL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 328 'B',    'T',    'QSLINF',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 329 'B',    'T',    'DX',           'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 330 'B',    'T',    'DXINFO',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 331 'B',    'T',    'DXNEWS',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 332 'B',    'T',    'DXQSL',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 333 'B',    'T',    'SYSOP',        'F',    [ qw(GB7BAA GB7ADX) ],
 334 'B',    'T',    '50MHZ',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
 335 );
 336 </PRE>
 337 </CODE></BLOCKQUOTE>
 338 <P>Simply insert a bulletin address and state in the brackets where you wish
 339 that mail to go.  For example, you can see here that mail sent to "UK" will
 340 only be sent to the UK links and not to PA4AB-14.
 341 <P>
 342 <P>To force the cluster to reread the file use load/forward
 343 <P>
 344 <H2><A NAME="ss8.6">8.6 Distribution lists</A>
 345 </H2>
 346
 347 <P>Distribution lists are simply a list of users to send certain types of
 348 mail to.  An example of this is mail you only wish to send to other
 349 sysops.  In /spider/msg there is a directory called <EM>distro</EM>.  You
 350 put any distibution lists in here.  For example, here is a file called
 351 SYSOP.pl that caters for the UK sysops.
 352 <P>
 353 <BLOCKQUOTE><CODE>
 354 <PRE>
 355 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
 356    GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH
 357    GB7DXK GB7DXI GB7DXS)
 358 </PRE>
 359 </CODE></BLOCKQUOTE>
 360 <P>Any mail sent to "sysop" would only be sent to the callsigns in this list.
 361 <P>
 362 <H2><A NAME="ss8.7">8.7 Console.pl</A>
 363 </H2>
 364
 365 <P>In later versions of Spider a simple console program is provided for the sysop.  This has a type ahead buffer with line
 366 editing facilities and colour for spots, announces etc.
 367 To use this program, simply use console.pl instead of client.pl.
 368 <P>
 369 <P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the file with your favourite editor.
 370 <P>
 371 <HR>
 372 <A HREF="adminmanual-9.html">Next</A>
 373 <A HREF="adminmanual-7.html">Previous</A>
 374 <A HREF="adminmanual.html#toc8">Contents</A>
 375 </BODY>
 376 </HTML>