updated documentation a bit
[spider.git] / html / adminmanual-4.html
index 9faec43772389c921bd621159da7e775fe48fa0e..37ff648b53ad8efaf2a2bd64c8a4b50cff9364ab 100644 (file)
@@ -2,7 +2,7 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Administration Manual v1.48: Databases</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: 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. Databases</A></H2>
+<H2><A NAME="s4">4. Scripts</A></H2>
 
-<P>Spider allows the creation of local or remote databases.  It supports
-chained databases, allowing several different databases to be scanned
-with one simple command.  Importing of databases is limited at present
-to the standard AK1A databases such as OBLAST and the DB0SDX QSL 
-database but will expand with time.
+<P>From 1.48 onwards it will become increasingly possible to control DXSpider's
+operation with scripts of various kinds.
 <P>
-<H2><A NAME="ss4.1">4.1 Creating databases</A>
-</H2>
-
-<P>Creating a database could not be more simple.  All the commands are
-sent from the cluster prompt as the <EM>sysop</EM> user.
-<P>To create a database you use the command <EM>dbcreate</EM>.  It can
-be used in 3 different ways like so ..
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbcreate &lt;name>
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>To simply create a database locally, you just tell the command the
-name of the database.  This does not create the actual database, it
-simply defines it to say that it exists.
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbcreate &lt;name> chain &lt;name> [&lt;name>...]
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>This creates a chained database entry.  The first database will be
-scanned, then the second, the third etc...
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbcreate &lt;name> remote &lt;name>
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>This creates a remote entry.  the first name field is the database
-name at the remote node, then the remote switch, then the actual
-node_call of the remote node, for example...
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbcreate buckmaster remote gb7dxc
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>Remote databases cannot be chained, however, the last database in a
-chain can be a remote database.
-<P>
-<H2><A NAME="ss4.2">4.2 Importing databases</A>
-</H2>
-
-<P>The only databases that Spider can currently import are the standard
-AK1A databases such as OBLAST or the DB0SDX qsl and address database.
-This will be added to with time.
-<P>To import such a database, first put the file somewhere useful like /tmp
-and then issue the following command ...
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbimport oblast /tmp/OBLAST.FUL
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>This will update the existing local oblast database or create it if
-it does not exist.
+<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>
-<H2><A NAME="ss4.3">4.3 Checking available databases</A>
-</H2>
-
-<P>Once a database is created, you will want to check that it has been
-added.  To do this use the <EM>dbavail</EM> command.  This will
-output the available databases.  For example ...
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbavail
-DB Name          Location   Chain
-qsl              Local
-buck             GB7ADX
-hftest           GB7DXM
-G0VGS de GB7MBC  3-Feb-2001 1925Z >
-</PRE>
-</CODE></BLOCKQUOTE>
+<P> 
+The filename are 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>
-<H2><A NAME="ss4.4">4.4 Looking up databases</A>
-</H2>
-
-<P>To look for information in a defined database, simply use the <EM>dbshow</EM>
-command, for example ...
+<P>In addition to the callsign specific scripts there are three others:-
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-dbshow buckmaster G0YLM
+startup
+user_default
+node_default
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>will show the information for the callsign G0YLM from the buckmaster
-database if it exists.  To make things more standard for the users
-you can add an entry in the Aliases file so that it looks like a standard 
-<EM>show</EM> command like this ...
+<P>The <EM>startup</EM> script is executed immediately after all
+initialisation of the node is done, but before any connections are
+possible.
 <P>
-<BLOCKQUOTE><CODE>
-<PRE>
-'^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>Now you can simply use show/buckmaster or an abreviation.
+<P>The <EM>user_default</EM> script is executed for every user that does
+<B>NOT</B> already have a specific script.
 <P>
-<H2><A NAME="ss4.5">4.5 Removing databases</A>
-</H2>
-
-<P>To delete an existing database you use the <EM>dbremove</EM> command.
-For example ...
+<P>The <EM>node_default</EM> script is executed for every node that doesn't
+have a specific script.
 <P>
-<BLOCKQUOTE><CODE>
-<PRE>
-dbremove oblast
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>would remove the oblast database and its associated datafile from the
-system.  There are no warnings or recovery possible from this command.
-If you remove a database it ceases to exist and would have to be created
-from scratch if you still required it.
+<P>There are a couple of examples in the <EM>/spider/scripts</EM> directory.
 <P>
 <HR>
 <A HREF="adminmanual-5.html">Next</A>