html/adminmanual-6.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 Administration Manual v1.48: Information, files and useful programs</TITLE>
   6  <LINK HREF="adminmanual-7.html" REL=next>
   7  <LINK HREF="adminmanual-5.html" REL=previous>
   8  <LINK HREF="adminmanual.html#toc6" REL=contents>
   9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
  10 </HEAD>
  11 <BODY>
  12 <A HREF="adminmanual-7.html">Next</A>
  13 <A HREF="adminmanual-5.html">Previous</A>
  14 <A HREF="adminmanual.html#toc6">Contents</A>
  15 <HR>
  16 <H2><A NAME="s6">6. Information, files and useful programs</A></H2>
  17
  18 <H2><A NAME="ss6.1">6.1 MOTD</A>
  19 </H2>
  20
  21 <P>One of the more important things a cluster sysop needs to do is to get
  22 information to his users.  The simplest way to do this is to have a banner
  23 that is sent to the user on login.  This is know as a "message of the day"
  24 or "motd".  To set this up, simply create a file in /spider/data called motd
  25 and edit it to say whatever you want.  It is purely a text file and will be
  26 sent automatically to anyone logging in to the cluster.
  27 <P>
  28 <H2><A NAME="ss6.2">6.2 MOTD_NOR</A>
  29 </H2>
  30
  31 <P>This message of the day file lives in the same directory as the standard
  32 motd file but is only sent to non-registered users.  Once registered they
  33 will receive the same message as any other user.
  34 <P>
  35 <H2><A NAME="ss6.3">6.3 Downtime message</A>
  36 </H2>
  37
  38 <P>If for any reason the cluster is down, maybe for upgrade or maintenance but
  39 the machine is still running, a message can be sent to the user advising them
  40 of the fact.  This message lives in the /spider/data directory and is called
  41 "offline".  Simply create the file and edit it to say whatever you wish.
  42 This file will be sent to a user attempting to log into the cluster when
  43 DXSpider is not actually running.
  44 <P>
  45 <H2><A NAME="ss6.4">6.4 Other text messages</A>
  46 </H2>
  47
  48 <P>You can set other text messages to be read by the user if they input the file
  49 name.  This could be for news items or maybe information for new users.
  50 To set this up, make a directory under /spider called <EM>packclus</EM>.
  51 Under this directory you can create files called <EM>news</EM> or <EM>newuser</EM>
  52 for example.  In fact you can create files with any names you like.  These can
  53 be listed by the user with the command ....
  54 <P>
  55 <BLOCKQUOTE><CODE>
  56 <PRE>
  57 show/files
  58 </PRE>
  59 </CODE></BLOCKQUOTE>
  60 <P>They can be read by the user by typing the command ....
  61 <P>
  62 <BLOCKQUOTE><CODE>
  63 <PRE>
  64 type news
  65 </PRE>
  66 </CODE></BLOCKQUOTE>
  67 <P>If the file they want to read is called <EM>news</EM>.  You could also set
  68 an alias for this in the Alias file to allow them just to type <EM>news</EM>
  69 <P>
  70 <P>You can also store other information in this directory, either directly or
  71 nested under directories.  One use for this would be to store DX bulletins
  72 such as the OPDX bulletins.  These can be listed and read by the user.
  73 To keep things tidy, make a directory under /spider/packclus called
  74 <EM>bulletin</EM>.  Now copy any OPDX or similar bulletins into it.  These
  75 can be listed by the user in the same way as above using the <EM>show/files</EM>
  76 command with an extension for the bulletin directory you have just created,
  77 like this ....
  78 <P>
  79 <BLOCKQUOTE><CODE>
  80 <PRE>
  81 show/files bulletin
  82 </PRE>
  83 </CODE></BLOCKQUOTE>
  84 <P>
  85 <P>An example would look like this ....
  86 <P>
  87 <BLOCKQUOTE><CODE>
  88 <PRE>
  89 sh/files
  90 bulletin      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
  91 </PRE>
  92 </CODE></BLOCKQUOTE>
  93 <P>You can see that in the files area (basically the packclus directory) there is a
  94 file called <EM>news</EM> and a directory called <EM>bulletin</EM>.  You can
  95 also see that dates they were created.  In the case of the file <EM>news</EM>,
  96 you can also see the time it was last modified, a good clue as to whether the
  97 file has been updated since you last read it.  To read the file called
  98 <EM>news</EM> you would simply issue the command ....
  99 <P>
 100 <BLOCKQUOTE><CODE>
 101 <PRE>
 102 type news
 103 </PRE>
 104 </CODE></BLOCKQUOTE>
 105 <P>To look what is in the bulletin directory you issue the command ....
 106 <P>
 107 <BLOCKQUOTE><CODE>
 108 <PRE>
 109 show/files bulletin
 110 opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
 111 opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z
 112 opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z
 113 opdx394      33429 29-Nov-1999 1621Z opdx394.1     3116 29-Nov-1999 1621Z
 114 opdx395      24319 29-Nov-1999 1621Z opdx396      32647 29-Nov-1999 1621Z
 115 opdx396.1     5537 29-Nov-1999 1621Z opdx396.2     6242 29-Nov-1999 1621Z
 116 opdx397      18433 29-Nov-1999 1621Z opdx398      19961 29-Nov-1999 1621Z
 117 opdx399      17719 29-Nov-1999 1621Z opdx400      19600 29-Nov-1999 1621Z
 118 opdx401      27738 29-Nov-1999 1621Z opdx402      18698 29-Nov-1999 1621Z
 119 opdx403      24994 29-Nov-1999 1621Z opdx404      15685 29-Nov-1999 1621Z
 120 opdx405      13984 29-Nov-1999 1621Z opdx405.1     4166 29-Nov-1999 1621Z
 121 opdx406      28934 29-Nov-1999 1621Z opdx407      24153 29-Nov-1999 1621Z
 122 opdx408      15081 29-Nov-1999 1621Z opdx409      23234 29-Nov-1999 1621Z
 123 Press Enter to continue, A to abort (16 lines) >
 124 </PRE>
 125 </CODE></BLOCKQUOTE>
 126 <P>You can now read any file in this directory using the type command, like this ....
 127 <P>
 128 <BLOCKQUOTE><CODE>
 129 <PRE>
 130 type bulletin/opdx391
 131 Ohio/Penn DX Bulletin No. 391
 132 The Ohio/Penn Dx PacketCluster
 133 DX Bulletin No. 391
 134 BID: $OPDX.391
 135 January 11, 1999
 136 Editor Tedd Mirgliotta, KB8NW
 137 Provided by BARF-80 BBS Cleveland, Ohio
 138 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
 139 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
 140 Association, Ohio/Penn PacketCluster Network, K1XN &amp; Golist, WB2RAJ/WB2YQH
 141 &amp; The 59(9) DXReport, W3UR &amp; The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
 142 Press Enter to continue, A to abort (508 lines) >
 143 </PRE>
 144 </CODE></BLOCKQUOTE>
 145 <P>The page length will of course depend on what you have it set to!
 146 <P>
 147 <H2><A NAME="ss6.5">6.5 The Aliases file</A>
 148 </H2>
 149
 150 <P>You will find a file in /spider/cmd/ called Aliases.  First, copy this file to
 151 /spider/local_cmd/Aliases and edit this file.  You will see something like this ...
 152 <P>
 153 <BLOCKQUOTE><CODE>
 154 <PRE>
 155
 156 #!/usr/bin/perl
 157
 158 # provide some standard aliases for commands for terminally
 159 # helpless ak1a user (helpless in the sense that they never
 160 # read nor understand help files)
 161
 162 # This file is automagically reloaded if its modification time is
 163 # later than the one stored in CmdAlias.pm
 164
 165 # PLEASE make this file consistant with reality! (the patterns MUST
 166 # match the filenames!)
 167
 168 # Don't alter this file, copy it into the local_cmd tree and modify it.
 169 # This file will be replaced everytime I issue a new release.
 170
 171 # You only need to put aliases in here for commands that don't work as
 172 # you desire naturally, e.g sh/dx on its own just works as you expect
 173 # so you need not add it as an alias.
 174
 175
 176
 177 package CmdAlias;
 178
 179 %alias = (
 180     '?' => [
 181           '^\?', 'apropos', 'apropos',
 182         ],
 183     'a' => [
 184           '^ann.*/full', 'announce full', 'announce',
 185           '^ann.*/sysop', 'announce sysop', 'announce',
 186           '^ann.*/(.*)$', 'announce $1', 'announce',
 187         ],
 188         'b' => [
 189         ],
 190         'c' => [
 191         ],
 192         'd' => [
 193           '^del', 'kill', 'kill',
 194           '^del\w*/fu', 'kill full', 'kill',
 195           '^di\w*/a\w*', 'directory all', 'directory',
 196           '^di\w*/b\w*', 'directory bulletins', 'directory',
 197           '^di\w*/n\w*', 'directory new', 'directory',
 198           '^di\w*/o\w*', 'directory own', 'directory',
 199           '^di\w*/s\w*', 'directory subject', 'directory',
 200           '^di\w*/t\w*', 'directory to', 'directory',
 201           '^di\w*/f\w*', 'directory from', 'directory',
 202           '^di\w*/(\d+)', 'directory $1', 'directory',
 203         ],
 204         'e' => [
 205         ],
 206         'f' => [
 207         ],
 208         'g' => [
 209         ],
 210         'h' => [
 211         ],
 212         'i' => [
 213         ],
 214         'j' => [
 215         ],
 216         'k' => [
 217         ],
 218         'l' => [
 219           '^l$', 'directory', 'directory',
 220           '^ll$', 'directory', 'directory',
 221           '^ll/(\d+)', 'directory $1', 'directory',
 222         ],
 223         'm' => [
 224         ],
 225         'n' => [
 226           '^news', 'type news', 'type',
 227         ],
 228         'o' => [
 229         ],
 230         'p' => [
 231         ],
 232         'q' => [
 233           '^q', 'bye', 'bye',
 234         ],
 235         'r' => [
 236           '^r$', 'read', 'read',
 237           '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
 238         ],
 239         's' => [
 240           '^s/p$', 'send', 'send',
 241           '^sb$', 'send noprivate', 'send',
 242           '^set/home$', 'set/homenode', 'set/homenode',
 243           '^set/nobe', 'unset/beep', 'unset/beep',
 244           '^set/nohe', 'unset/here', 'unset/here',
 245           '^set/noan', 'unset/announce', 'unset/announce',
 246           '^set/nodx', 'unset/dx', 'unset/dx',
 247           '^set/nota', 'unset/talk', 'unset/talk',
 248           '^set/noww', 'unset/wwv', 'unset/wwv',
 249           '^set/nowx', 'unset/wx', 'unset/wx',
 250           '^sh$', 'show', 'show',
 251           '^sh\w*/buck', 'dbshow buck', 'dbshow',
 252           '^sh\w*/bu', 'show/files bulletins', 'show/files',
 253           '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
 254           '^sh\w*/c$', 'show/configuration', 'show/configuration',
 255           '^sh\w*/com', 'dbavail', 'dbavail',
 256           '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
 257           '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
 258           '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
 259           '^sh\w*/email', 'dbshow email', 'dbshow',
 260           '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
 261           '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
 262           '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
 263           '^sh\w*/tnc', 'who', 'who',
 264           '^sh\w*/up', 'show/cluster', 'show/cluster',
 265           '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
 266           '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
 267           '^sp$', 'send', 'send',
 268
 269     ],
 270         't' => [
 271           '^ta$', 'talk', 'talk',
 272           '^t$', 'talk', 'talk',
 273         ],
 274         'u' => [
 275         ],
 276         'v' => [
 277         ],
 278         'w' => [
 279           '^wx/full', 'wx full', 'wx',
 280           '^wx/sysop', 'wx sysop', 'wx',
 281         ],
 282         'x' => [
 283         ],
 284         'y' => [
 285         ],
 286         'z' => [
 287         ],
 288 )
 289 </PRE>
 290 </CODE></BLOCKQUOTE>
 291 <P>You can create aliases for commands at will.  Beware though, these may not
 292 always turn out as you think.  Care is needed and you need to test the
 293 results once you have set an alias.
 294 <P>
 295 <H2><A NAME="ss6.6">6.6 Console.pl</A>
 296 </H2>
 297
 298 <P>In later versions of Spider a simple console program is provided for the sysop.
 299 This has a type ahead buffer with line editing facilities and colour for spots,
 300 announces etc.  To use this program, simply use console.pl instead of client.
 301 <P>
 302 <P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the
 303 file with your favourite editor.
 304 <P>
 305 <H2><A NAME="ss6.7">6.7 Updating kepler data</A>
 306 </H2>
 307
 308 <P>Spider has a powerful and flexible show/satellite command.  In order for
 309 this to be accurate, the kepler data has to be updated regularly.  In
 310 general, this data is available as an email or via cluster mail.
 311 Updating it is simple.  First you need to export the mail message as a
 312 file.  You do this with the <EM>export</EM> command from the cluster prompt
 313 as the sysop.  For example ...
 314 <P>
 315 <BLOCKQUOTE><CODE>
 316 <PRE>
 317 export 5467 /spider/perl/keps.in
 318 </PRE>
 319 </CODE></BLOCKQUOTE>
 320 <P>would export message number 5467 as a file called keps.in in the
 321 /spider/perl directory.
 322 <P>Now login to a VT as sysop and cd /spider/perl.  There is a command in
 323 the perl directory called <EM>convkeps.pl</EM>.  All we need to do now is
 324 convert the file like so ...
 325 <P>
 326 <BLOCKQUOTE><CODE>
 327 <PRE>
 328 ./convkeps.pl keps.in
 329 </PRE>
 330 </CODE></BLOCKQUOTE>
 331 <P>Now go back to the cluster and issue the command ...
 332 <P>
 333 <BLOCKQUOTE><CODE>
 334 <PRE>
 335 load/keps
 336 </PRE>
 337 </CODE></BLOCKQUOTE>
 338 <P>That is it!  the kepler data has been updated.
 339 <P>
 340 <H2><A NAME="ss6.8">6.8 The QRZ callbook</A>
 341 </H2>
 342
 343 <P>The command <EM>sh/qrz</EM> will only work once you have followed a few
 344 simple steps.  First you need to get a user ID and password from qrz.com.
 345 Simply go to the site and create one.  Secondly you need to copy the file
 346 /spider/perl/Internet.pm to /spider/local and alter it to match your user
 347 ID and password.  You also at this point need to set $allow=1 to complete
 348 the setup.  Many thanks to Fred Lloyd, the proprieter of
 349 <A HREF="http://www.qrz.com">qrz.com</A> for allowing this access.
 350 <P>
 351 <H2><A NAME="ss6.9">6.9 Scripts</A>
 352 </H2>
 353
 354 <P>The directory /spider/scripts is used for several things.  Firstly it
 355 contains a file called startup that can be used to call in any changes
 356 to the cluster from the default settings on startup.  Examples of this
 357 include how many spots it is possible to get with the sh/dx command,
 358 whether you want registration/passwords to be permanently on etc.  An
 359 example file is shown below and is included in the distribution as
 360 startup.issue.
 361 <P>
 362 <BLOCKQUOTE><CODE>
 363 <PRE>
 364 #
 365 # startup script example
 366 #
 367 # set maximum no of spots allowed to 100
 368 # set/var $Spot::maxspots = 1
 369 #
 370 # Set registration on
 371 # set/var $main::reqreg = 1
 372 #
 373 # Set passwords on
 374 # set/var $main::passwdreq = 1
 375 #
 376 </PRE>
 377 </CODE></BLOCKQUOTE>
 378 <P>Secondly, it is used to store the login scripts for users.  Currently
 379 this can only be done by the sysop but it is envisaged that eventually
 380 users will be able to set their own.  An example is included in the
 381 distibution but here is a further example.
 382 <P>
 383 <BLOCKQUOTE><CODE>
 384 <PRE>
 385 #
 386 # G0FYD
 387 #
 388 blank +
 389 sh/wwv 3
 390 blank +
 391 sh/dx
 392 blank +
 393 t g0jhc You abt?
 394 blank +
 395 </PRE>
 396 </CODE></BLOCKQUOTE>
 397 <P>The lines in between commands can simply insert a blank line or a character
 398 such as a + sign to make the output easier to read.
 399 <P>
 400 <HR>
 401 <A HREF="adminmanual-7.html">Next</A>
 402 <A HREF="adminmanual-5.html">Previous</A>
 403 <A HREF="adminmanual.html#toc6">Contents</A>
 404 </BODY>
 405 </HTML>