added new version fo the admin manual
[spider.git] / 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 Installation and Administration Manual : 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 </HEAD>
10 <BODY>
11 <A HREF="adminmanual-7.html">Next</A>
12 <A HREF="adminmanual-5.html">Previous</A>
13 <A HREF="adminmanual.html#toc6">Contents</A>
14 <HR>
15 <H2><A NAME="s6">6. Information, files and useful programs</A></H2>
16
17 <H2><A NAME="ss6.1">6.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 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 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 will be sent automatically to anyone logging in to the cluster.
21 <P>
22 <H2><A NAME="ss6.2">6.2 Downtime message</A>
23 </H2>
24
25 <P>If for any reason the cluster is down, maybe for upgrade or maintenance but the machine is still running, a message can be sent to the user advising them of the fact.  This message lives in the /spider/data directory and is called "offline".  Simply 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 when DXSpider is not actually running.
26 <P>
27 <H2><A NAME="ss6.3">6.3 Other text messages</A>
28 </H2>
29
30 <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 information for new users.  To set this up, make a directory under /spider called <EM>packclus</EM>.  Under this directory you can create files called <EM>news</EM> or <EM>newuser</EM> for example.  In fact you can create files with any names you like.  These can be listed by the user with the command ....
31 <P>
32 <BLOCKQUOTE><CODE>
33 <PRE>
34 show/files
35 </PRE>
36 </CODE></BLOCKQUOTE>
37 <P>They can be read by the user by typing the command ....
38 <P>
39 <BLOCKQUOTE><CODE>
40 <PRE>
41 type news
42 </PRE>
43 </CODE></BLOCKQUOTE>
44 <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 just to type <EM>news</EM>
45 <P>
46 <P>You can also store other information in this directory, either directly or nested under directories.  One use for this would 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 directory under /spider/packclus called <EM>bulletins</EM>.  Now copy any OPDX or similar bulletins into it.  These can be listed by the user in the same way as above using the <EM>show/files</EM> command with an extension for the bulletins directory you have just created, like this ....
47 <P>
48 <BLOCKQUOTE><CODE>
49 <PRE>
50 show/files bulletins
51 </PRE>
52 </CODE></BLOCKQUOTE>
53 <P>
54 <P>An example would look like this ....
55 <P>
56 <BLOCKQUOTE><CODE>
57 <PRE>
58 sh/files
59 bulletins      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
60 </PRE>
61 </CODE></BLOCKQUOTE>
62 <P>You can see that in the files area (basically the packclus directory) there is a file called <EM>news</EM> and a directory called <EM>bulletins</EM>.  You can also see that dates they were created.  In the case of the file <EM>news</EM>, you can 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 the file called <EM>news</EM> you would simply issue the command ....
63 <P>
64 <BLOCKQUOTE><CODE>
65 <PRE>
66 type news
67 </PRE>
68 </CODE></BLOCKQUOTE>
69 <P>To look what is in the bulletins directory you issue the command ....
70 <P>
71 <BLOCKQUOTE><CODE>
72 <PRE>
73 show/files bulletins
74 opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
75 opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z  
76 opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z  
77 opdx394      33429 29-Nov-1999 1621Z opdx394.1     3116 29-Nov-1999 1621Z  
78 opdx395      24319 29-Nov-1999 1621Z opdx396      32647 29-Nov-1999 1621Z
79 opdx396.1     5537 29-Nov-1999 1621Z opdx396.2     6242 29-Nov-1999 1621Z
80 opdx397      18433 29-Nov-1999 1621Z opdx398      19961 29-Nov-1999 1621Z  
81 opdx399      17719 29-Nov-1999 1621Z opdx400      19600 29-Nov-1999 1621Z
82 opdx401      27738 29-Nov-1999 1621Z opdx402      18698 29-Nov-1999 1621Z
83 opdx403      24994 29-Nov-1999 1621Z opdx404      15685 29-Nov-1999 1621Z
84 opdx405      13984 29-Nov-1999 1621Z opdx405.1     4166 29-Nov-1999 1621Z
85 opdx406      28934 29-Nov-1999 1621Z opdx407      24153 29-Nov-1999 1621Z
86 opdx408      15081 29-Nov-1999 1621Z opdx409      23234 29-Nov-1999 1621Z
87 Press Enter to continue, A to abort (16 lines) >
88 </PRE>
89 </CODE></BLOCKQUOTE>
90 <P>You can now read any file in this directory using the type command, like this ....
91 <P>
92 <BLOCKQUOTE><CODE>
93 <PRE>
94 type bulletins/opdx391
95 Ohio/Penn DX Bulletin No. 391
96 The Ohio/Penn Dx PacketCluster
97 DX Bulletin No. 391
98 BID: $OPDX.391
99 January 11, 1999
100 Editor Tedd Mirgliotta, KB8NW
101 Provided by BARF-80 BBS Cleveland, Ohio
102 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
103 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
104 Association, Ohio/Penn PacketCluster Network, K1XN &amp; Golist, WB2RAJ/WB2YQH
105 &amp; The 59(9) DXReport, W3UR &amp; The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
106 Press Enter to continue, A to abort (508 lines) >
107 </PRE>
108 </CODE></BLOCKQUOTE>
109 <P>The page length will of course depend on what you have it set to!
110 <P>
111 <H2><A NAME="ss6.4">6.4 The Aliases file</A>
112 </H2>
113
114 <P>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 ...
115 <P>
116 <BLOCKQUOTE><CODE>
117 <PRE>
118
119 #!/usr/bin/perl
120
121 # provide some standard aliases for commands for terminally
122 # helpless ak1a user (helpless in the sense that they never
123 # read nor understand help files)
124
125 # This file is automagically reloaded if its modification time is 
126 # later than the one stored in CmdAlias.pm
127
128 # PLEASE make this file consistant with reality! (the patterns MUST
129 # match the filenames!)
130
131 # Don't alter this file, copy it into the local_cmd tree and modify it.
132 # This file will be replaced everytime I issue a new release.
133
134 # You only need to put aliases in here for commands that don't work as
135 # you desire naturally, e.g sh/dx on its own just works as you expect
136 # so you need not add it as an alias.
137
138
139
140 package CmdAlias;
141
142 %alias = (
143     '?' => [
144           '^\?', 'apropos', 'apropos',
145         ],
146     'a' => [
147           '^ann.*/full', 'announce full', 'announce', 
148           '^ann.*/sysop', 'announce sysop', 'announce',
149           '^ann.*/(.*)$', 'announce $1', 'announce',
150         ],
151         'b' => [
152         ],
153         'c' => [
154         ],
155         'd' => [
156           '^del', 'kill', 'kill',
157           '^del\w*/fu', 'kill full', 'kill',
158           '^di\w*/a\w*', 'directory all', 'directory',
159           '^di\w*/b\w*', 'directory bulletins', 'directory',
160           '^di\w*/n\w*', 'directory new', 'directory',
161           '^di\w*/o\w*', 'directory own', 'directory',
162           '^di\w*/s\w*', 'directory subject', 'directory',
163           '^di\w*/t\w*', 'directory to', 'directory',
164           '^di\w*/f\w*', 'directory from', 'directory',
165           '^di\w*/(\d+)', 'directory $1', 'directory',
166         ],
167         'e' => [
168         ],
169         'f' => [
170         ],
171         'g' => [
172         ],
173         'h' => [
174         ],
175         'i' => [
176         ],
177         'j' => [
178         ],
179         'k' => [
180         ],
181         'l' => [
182           '^l$', 'directory', 'directory',
183           '^ll$', 'directory', 'directory',
184           '^ll/(\d+)', 'directory $1', 'directory',
185         ],
186         'm' => [
187         ],
188         'n' => [
189           '^news', 'type news', 'type',
190         ],
191         'o' => [
192         ],
193         'p' => [
194         ],
195         'q' => [
196           '^q', 'bye', 'bye',
197         ],
198         'r' => [        
199           '^r$', 'read', 'read',
200           '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
201         ],
202         's' => [
203           '^s/p$', 'send', 'send',
204           '^sb$', 'send noprivate', 'send',
205           '^set/home$', 'set/homenode', 'set/homenode',
206           '^set/nobe', 'unset/beep', 'unset/beep',
207           '^set/nohe', 'unset/here', 'unset/here',
208           '^set/noan', 'unset/announce', 'unset/announce',
209           '^set/nodx', 'unset/dx', 'unset/dx',
210           '^set/nota', 'unset/talk', 'unset/talk',
211           '^set/noww', 'unset/wwv', 'unset/wwv',
212           '^set/nowx', 'unset/wx', 'unset/wx',
213           '^sh$', 'show', 'show',
214           '^sh\w*/buck', 'dbshow buck', 'dbshow',
215           '^sh\w*/bu', 'show/files bulletins', 'show/files',
216           '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
217           '^sh\w*/c$', 'show/configuration', 'show/configuration',
218           '^sh\w*/com', 'dbavail', 'dbavail',
219           '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
220           '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
221           '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
222           '^sh\w*/email', 'dbshow email', 'dbshow',
223           '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
224           '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
225           '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
226           '^sh\w*/tnc', 'who', 'who',
227       '^sh\w*/up', 'show/cluster', 'show/cluster',
228           '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
229           '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
230           '^sp$', 'send', 'send',
231         
232     ],
233         't' => [
234           '^ta$', 'talk', 'talk',
235           '^t$', 'talk', 'talk',
236         ],
237         'u' => [
238         ],
239         'v' => [
240         ],
241         'w' => [
242           '^wx/full', 'wx full', 'wx',
243           '^wx/sysop', 'wx sysop', 'wx',
244         ],
245         'x' => [
246         ],
247         'y' => [
248         ],
249         'z' => [
250         ],
251 )
252 </PRE>
253 </CODE></BLOCKQUOTE>
254 <P>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.
255 <P>
256 <H2><A NAME="ss6.5">6.5 Console.pl</A>
257 </H2>
258
259 <P>In later versions of Spider a simple console program is provided for the sysop.  This has a type ahead buffer with line editing facilities and colour for spots, announces etc.
260 To use this program, simply use console.pl instead of client.pl.
261 <P>
262 <P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the file with your favourite editor.
263 <P>
264 <HR>
265 <A HREF="adminmanual-7.html">Next</A>
266 <A HREF="adminmanual-5.html">Previous</A>
267 <A HREF="adminmanual.html#toc6">Contents</A>
268 </BODY>
269 </HTML>