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