Update manuals for CVS and new commands
[spider.git] / html / adminmanual_en-4.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20">
5  <TITLE>The DXSpider Administration Manual v1.51: Scripts</TITLE>
6  <LINK HREF="adminmanual_en-5.html" REL=next>
7  <LINK HREF="adminmanual_en-3.html" REL=previous>
8  <LINK HREF="adminmanual_en.html#toc4" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual_en-5.html">Next</A>
13 <A HREF="adminmanual_en-3.html">Previous</A>
14 <A HREF="adminmanual_en.html#toc4">Contents</A>
15 <HR>
16 <H2><A NAME="s4">4.</A> <A HREF="adminmanual_en.html#toc4">Scripts</A></H2>
17
18 <P>From 1.48 onwards it will become increasingly possible to control DXSpider's
19 operation with scripts of various kinds.</P>
20
21 <P>The directory /spider/scripts is where it all happens and is used for several 
22 things.  Firstly it contains a file called startup that can be used to call 
23 in any changes to the cluster from the default settings on startup.  This
24 script is executed immediately after all initialisation of the node is done
25 but before any connections are possible.  Examples of this include how many 
26 spots it is possible to get with the sh/dx command, whether you want 
27 registration/passwords to be permanently on etc.  An example file is shown 
28 below and is included in the distribution as startup.issue.</P>
29 <P>
30 <BLOCKQUOTE><CODE>
31 <PRE>
32 #
33 # startup script example
34 #
35 # set maximum no of spots allowed to 100
36 # set/var $Spot::maxspots = 100
37 #
38 # Set registration on
39 # set/var $main::reqreg = 1
40 #
41 # Set passwords on
42 # set/var $main::passwdreq = 1
43 #
44 </PRE>
45 </CODE></BLOCKQUOTE>
46 </P>
47
48 <P>As usual, any text behind a # is treated as a comment and not read.  To use
49 this file, simply rename it from startup.issue to startup.  In our example
50 above there are three options.  The first option is the amount of spots that
51 a user can request with the <EM>sh/dx</EM> command.  Normally the default is
52 to give 10 spots unless the user specifies more.  Without this line enabled,
53 the maximum a user can request is 100 spots.  Depending on your link quality
54 you may wish to enable more or less by specifying the number.</P>
55
56 <P>The other 2 options are dealt with more fully in the security section.</P>
57
58 <P>Secondly, it is used to store the login scripts for users and nodes.  Currently
59 this can only be done by the sysop but it is envisaged that eventually users will 
60 be able to set their own.  An example is included in the distibution but here is 
61 a further example.</P>
62 <P>
63 <BLOCKQUOTE><CODE>
64 <PRE>
65 #
66 # G0FYD
67 #
68 blank +
69 sh/wwv 3
70 blank +
71 sh/dx 
72 blank +
73 t g0jhc You abt?
74 blank +
75 </PRE>
76 </CODE></BLOCKQUOTE>
77 </P>
78 <P>The lines in between commands can simply insert a blank line or a character
79 such as a + sign to make the output easier to read.  Simply create this script
80 with your favourite editor and save it with the callsign of the user as the
81 filename.  Filenames should always be in lower case.</P>
82
83 <P>Commands can be inserted in the same way for nodes.  A node may wish a series
84 of commands to be issued on login, such as a merge command for example.</P>
85
86 <P>Thirdly, there are 2 default scripts for users and nodes who do not have a
87 specifically defined script.  These are <EM>user_default</EM> and
88 <EM>node_default</EM></P>
89
90 <HR>
91 <A HREF="adminmanual_en-5.html">Next</A>
92 <A HREF="adminmanual_en-3.html">Previous</A>
93 <A HREF="adminmanual_en.html#toc4">Contents</A>
94 </BODY>
95 </HTML>