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