move usdb init as per k1xx's bug
[spider.git] / html / adminmanual-4.html
index a54fa8ceb29de474306fad4952140af5aedcee30..f74b9e43dddbff1bf9cbc1b612a1b8483bb4c400 100644 (file)
@@ -1,8 +1,8 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <HTML>
 <HEAD>
- <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Administration Manual v1.48: Scripts</TITLE>
+ <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.16">
+ <TITLE>The DXSpider Administration Manual v1.50: Scripts</TITLE>
  <LINK HREF="adminmanual-5.html" REL=next>
  <LINK HREF="adminmanual-3.html" REL=previous>
  <LINK HREF="adminmanual.html#toc4" REL=contents>
 <A HREF="adminmanual-3.html">Previous</A>
 <A HREF="adminmanual.html#toc4">Contents</A>
 <HR>
-<H2><A NAME="s4">4. Scripts</A></H2>
+<H2><A NAME="s4">4.</A> <A HREF="adminmanual.html#toc4">Scripts</A></H2>
 
 <P>From 1.48 onwards it will become increasingly possible to control DXSpider's
-operation with scripts of various kinds.
-<P>
-<P>In the first instance, in 1.48, the sysop can create, with their favorite 
-text editor, files in the directory <EM>/spider/scripts</EM> which contain
-any legal command for a callsign or class of connection which will be executed
-at logon.
-<P>
-<P> 
-The filename is the callsign of the connection that you want the script to 
-operate on, eg: <EM>/spider/scripts/g1tlh</EM>. The filenames are always in 
-lower case on those architectures where this makes a difference.
-<P>
-<P>In addition to the callsign specific scripts there are three others:-
+operation with scripts of various kinds.</P>
+
+<P>The directory /spider/scripts is where it all happens and is used for several 
+things.  Firstly it contains a file called startup that can be used to call 
+in any changes to the cluster from the default settings on startup.  This
+script is executed immediately after all initialisation of the node is done
+but before any connections are possible.  Examples of this include how many 
+spots it is possible to get with the sh/dx command, whether you want 
+registration/passwords to be permanently on etc.  An example file is shown 
+below and is included in the distribution as startup.issue.</P>
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-startup
-user_default
-node_default
+#
+# startup script example
+#
+# set maximum no of spots allowed to 100
+# set/var $Spot::maxspots = 100
+#
+# Set registration on
+# set/var $main::reqreg = 1
+#
+# Set passwords on
+# set/var $main::passwdreq = 1
+#
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>The <EM>startup</EM> script is executed immediately after all
-initialisation of the node is done, but before any connections are
-possible.
-<P>
-<P>The <EM>user_default</EM> script is executed for every user that does
-<B>NOT</B> already have a specific script.
-<P>
-<P>The <EM>node_default</EM> script is executed for every node that doesn't
-have a specific script.
-<P>
-<P>There are a couple of examples in the <EM>/spider/scripts</EM> directory.
+</P>
+
+<P>As usual, any text behind a # is treated as a comment and not read.  To use
+this file, simply rename it from startup.issue to startup.  In our example
+above there are three options.  The first option is the amount of spots that
+a user can request with the <EM>sh/dx</EM> command.  Normally the default is
+to give 10 spots unless the user specifies more.  Without this line enabled,
+the maximum a user can request is 100 spots.  Depending on your link quality
+you may wish to enable more or less by specifying the number.</P>
+
+<P>The other 2 options are dealt with more fully in the security section.</P>
+
+<P>Secondly, it is used to store the login scripts for users and nodes.  Currently
+this can only be done by the sysop but it is envisaged that eventually users will 
+be able to set their own.  An example is included in the distibution but here is 
+a further example.</P>
 <P>
+<BLOCKQUOTE><CODE>
+<PRE>
+#
+# G0FYD
+#
+blank +
+sh/wwv 3
+blank +
+sh/dx 
+blank +
+t g0jhc You abt?
+blank +
+</PRE>
+</CODE></BLOCKQUOTE>
+</P>
+<P>The lines in between commands can simply insert a blank line or a character
+such as a + sign to make the output easier to read.  Simply create this script
+with your favourite editor and save it with the callsign of the user as the
+filename.  Filenames should always be in lower case.</P>
+
+<P>Commands can be inserted in the same way for nodes.  A node may wish a series
+of commands to be issued on login, such as a merge command for example.</P>
+
+<P>Thirdly, there are 2 default scripts for users and nodes who do not have a
+specifically defined script.  These are <EM>user_default</EM> and
+<EM>node_default</EM></P>
+
 <HR>
 <A HREF="adminmanual-5.html">Next</A>
 <A HREF="adminmanual-3.html">Previous</A>