Make changes to manuals to (hopefully) improve documentation and to change
[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 Administration Manual v1.49: 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.  This is the file that
151 controls what a user gets when issuing a command.  It is also possible to
152 create your own aliases for databases and files you create locally.
153 <P>
154 <P>You should not alter the original file in /spider/cmd/ but create a new file
155 with the same name in /spider/local_cmd.  This means that any new Aliases files
156 that is downloaded will not overwrite your self created Aliases and also that
157 you do not override any new Aliases with your copy in /spider/local_cmd/.  You
158 must remember that any files you store in /spider/local/ or /spider/local_cmd
159 override the originals if the same lines are used in both files.
160 <P>
161 <P>The best way of dealing with all this then is to only put your own locally
162 created Aliases in the copy in /spider/local_cmd.  The example below is
163 currently in use at GB7MBC.
164 <P>
165 <BLOCKQUOTE><CODE>
166 <PRE>
167
168 #
169 # Local Aliases File
170 #
171
172 package CmdAlias;
173
174 %alias = (
175     'n' => [
176       '^news$', 'type news', 'type',
177     ],
178     's' => [
179       '^sh\w*/buck$', 'show/qrz', 'show',
180       '^sh\w*/hftest$', 'dbshow hftest', 'dbshow',
181       '^sh\w*/qsl$', 'dbshow qsl', 'dbshow',
182       '^sh\w*/vhf$', 'dbshow vhf', 'dbshow',
183       '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow',
184         ],
185 )
186 </PRE>
187 </CODE></BLOCKQUOTE>
188 <P>
189 <P>Each alphabetical section should be preceded by the initial letter and the section
190 should be wrapped in square brackets as you can see.  The syntax is straightforward.
191 The first section on each line is the new command that will be allowed once the
192 alias is included.  The second section is the command it is replacing and the last
193 section is the actual command that is being used.
194 <P>
195 <P>The eagle-eyed amongst you will have noticed that in the first section, the new
196 alias command has a '^' at the start and a '$' at the end.  Basically these force
197 a perfect match on the alias.  The '^' says match the beginning exactly and the
198 '$' says match the end exactly.  This prevents unwanted and unintentional matches
199 with similar commands.
200 <P>
201 <P>I have 3 different types of alias in this file.  At the top is an alias for 'news'.  
202 This is a file I have created in the /spider/packclus/ directory where I can inform 
203 users of new developments or points of interest.  In it's initial form a user would 
204 have to use the command <EM>type news</EM>.  The alias allows them to simply type 
205 <EM>news</EM> to get the info.  Second is an alias for the <EM>show/qrz</EM>
206 command so that those users used to the original <EM>show/buck</EM> command in
207 AK1A will not get an error, and the rest of the lines are for locally created
208 databases so that a user can type <EM>show/hftest</EM> instead of having to use
209 the command <EM>dbshow hftest</EM> which is not as intuitive.
210 <P>
211 <P>This file is just an example and you should edit it to your own requirements.
212 Once created, simply issue the command <EM>load/alias</EM> at the cluster
213 prompt as the sysop user and the aliases should be available.
214 <P>
215 <P>
216 <H2><A NAME="ss6.6">6.6 Console.pl</A>
217 </H2>
218
219 <P>In later versions of Spider a simple console program is provided for the sysop.  
220 This has a type ahead buffer with line editing facilities and colour for spots,
221 announces etc.  To use this program, simply use console.pl instead of client.
222 <P>
223 <P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the 
224 file with your favourite editor.
225 <P>
226 <H2><A NAME="ss6.7">6.7 Updating kepler data</A>
227 </H2>
228
229 <P>Spider has a powerful and flexible show/satellite command.  In order for
230 this to be accurate, the kepler data has to be updated regularly.  In
231 general, this data is available as an email or via cluster mail.
232 Updating it is simple.  First you need to export the mail message as a
233 file.  You do this with the <EM>export</EM> command from the cluster prompt
234 as the sysop.  For example ...
235 <P>
236 <BLOCKQUOTE><CODE>
237 <PRE>
238 export 5467 /spider/perl/keps.in
239 </PRE>
240 </CODE></BLOCKQUOTE>
241 <P>
242 <P>would export message number 5467 as a file called keps.in in the
243 /spider/perl directory.
244 <P>
245 <P>Now login to a VT as sysop and cd /spider/perl.  There is a command in
246 the perl directory called <EM>convkeps.pl</EM>.  All we need to do now is
247 convert the file like so ...
248 <P>
249 <BLOCKQUOTE><CODE>
250 <PRE>
251 ./convkeps.pl keps.in
252 </PRE>
253 </CODE></BLOCKQUOTE>
254 <P>
255 <P>Now go back to the cluster and issue the command ...
256 <P>
257 <BLOCKQUOTE><CODE>
258 <PRE>
259 load/keps
260 </PRE>
261 </CODE></BLOCKQUOTE>
262 <P>
263 <P>That is it!  the kepler data has been updated.
264 <P>
265 <H2><A NAME="ss6.8">6.8 The QRZ callbook</A>
266 </H2>
267
268 <P>The command <EM>sh/qrz</EM> will only work once you have followed a few
269 simple steps.  First you need to get a user ID and password from qrz.com.
270 Simply go to the site and create one.  Secondly you need to copy the file
271 /spider/perl/Internet.pm to /spider/local and alter it to match your user
272 ID and password.  You also at this point need to set $allow=1 to complete
273 the setup.  Many thanks to Fred Lloyd, the proprieter of
274 <A HREF="http://www.qrz.com">qrz.com</A> for allowing this access.
275 <P>
276 <HR>
277 <A HREF="adminmanual-7.html">Next</A>
278 <A HREF="adminmanual-5.html">Previous</A>
279 <A HREF="adminmanual.html#toc6">Contents</A>
280 </BODY>
281 </HTML>