update copyright
[spider.git] / txt / installation.txt
index a555718bac3803d3248b10d4768c595a42a39086..ef441bbeaecad0ae3a1e44e741f6540ca0e8d3e6 100644 (file)
@@ -43,9 +43,9 @@
 
   5. Installing the software
 
-     5.1 The AGW packet engine
-     5.2 Setting up the initial user files
-     5.3 Incoming telnets
+     5.1 Incoming telnets
+     5.2 The AGW packet engine
+     5.3 Setting up the initial user files
      5.4 Connecting to other clusters
 
   6. General Information
   Get the current version of the DX Spider distribution. This needs to
   be v1.47 or later. You've got two ways (currently) of getting this;
   either get a CVS update from sourceforge (if you don't know what this
-  is, then it isn't for you) or get my package from:-
+  is, then it isn't for you) or get the latest "official" release from:-
 
-  http://www.dcc.rsgb.org/WinSpider.zip
+  http://www.dxcluster.org/download/index.html
 
-  or if you want the lastest CVS version (which is produced every night)
+  or if you want the lastest snapshot of CVS version (which is produced
+  every night):-
 
   http://www.dxcluster.org/download/CVSlatest.tgz
 
-  If you went down the CVS route, then everything will be nicely set out
-  on your local disk. If you got the ZIP file, unpack it to somewhere
+  This is generally the best one to go for as it is completely up to
+  date. However, there is always the very slight chance that it might
+  unstable. Generally, there will be a note on the website if this is
+  the case.
+
+
+  The only difference between "CVSlatest.tgz" and the latest "official"
+  release version is that it is more up to date. Don't confuse this TGZ
+  file with "Downloading from Sourceforge with CVS" - they are two quite
+  different things.
+
+
+  If you went down the CVS route (ie installed wincvs and downloaded
+  from sourceforge), then everything will be nicely set out on your
+  local disk. If you got the TGZ file, unpack it to somewhere
   convenient. The following examples assume that you put it on drive
   "C:\", for convenience.
 
-  NOTE: This distribution method will go away as soon as the first v1.47
-  tarball is released. You can use WinZip to unpack that, and my life
-  will be made easier by not needing to keep this .ZIP file updated.
+
+  You will need winzip to manipulate the TGZ files (they are bit like
+  ZIP files) if you are not using CVS.
 
 
   5.  Installing the software
 
-  Ensure that your CVS session or your unZIPped file have left you with
-  a directory "C:\spider\local"; if not, go to "C:\spider\" and create
-  one. If "C:\spider" is missing, go back and figure out why, because it
-  shouldn't be.
+  Ensure that your CVS session or your WINunZIPped file have left you
+  with a directory "C:\spider\local" and C:\spider\local_cmd"; if not,
+  go to "C:\spider\" and create them. If "C:\spider" is missing, go back
+  and figure out why, because it shouldn't be.
+
 
   Now create your own local copy of the DXVars.pm file by:-
 
 
 
 
-  cd \spider\local
+       cd \spider\local
 
 
 
 
   o  $myalias - the SysOp's callsign. Cannot be the same as $mycall!
 
-  You really also ought to update the $mylatitude, $mylongitude, $myqth
-  and $myemail variables. And unless you are absolutely certain you know
-  what you're doing, you should change nothing else in this file.
+  o  $myqth - The station's geographical location (QTH).
+
+  o  $mylatitude - The station latitude in degrees and decimal fractions
+
+  o  $mylongitude - The station longitude in degrees and decimal
+     fractions
+
+  o  $mylocator - The Maidenhead (or QRA) locator of the station
+
+  You really also ought to update the $myqth and $myemail variables. And
+  unless you are absolutely certain you know what you're doing, you
+  should change nothing else in this file. Note that if you use an "@"
+  or a "$" character in one of the above strings (typically in $myemail)
+  you must write them as "\@" or "\$".
+
+
+
+  5.1.  Incoming telnets
+
+  If you want to enable inbound "TELNET" connections (or you are running
+  Windows NT, 2000 or XP), you've got a little more work to do. From a
+  handy "DOS box" that's not doing anything else, do the following:-
+
+
+
+
+
+  copy \spider\perl\Listeners.pm \spider\local
+  cd \spider\local
+  notepad listeners.pm
+
+
+
+
+  The following lines need attention:-
+
+
+
+       ["0.0.0.0", 7300],
+
+
 
 
-  5.1.  The AGW packet engine
+  On my machine, I've simply uncommented the "0.0.0.0" entry by removing
+  the '#' from the front of the line.
+
+  You MUST carry out this step if you are running on a Windows NT, 2000
+  or XP based system
+
+  If you don't have a static hostname for your machine, and you intend
+  to allow folk to connect to your machine across the internet, then I'd
+  suggest you pay a visit to www.dyndns.org and create one for yourself.
+  While it's free, it will take a modest an amount of effort on your
+  part to read, understand and implement what needs to be done to set
+  this up.
+
+
+  If your machine is connected to the internet and you don't want to
+  allow your machine to be visible to the outside world you should
+  change the "0.0.0.0" to "127.0.0.1" [which is "localhost"]. This will
+  then only allow connections from inside your machine. As was said
+  earlier: if you aren't running Win9x (or you want to use DXTelnet or
+  somesuch), then you need to have the machine listening at least to
+  "127.0.0.1" ("0.0.0.0" means all IP addresses).
+
+
+  5.2.  The AGW packet engine
 
   On the assumption that you'll be using the SV2AGW Packet Engine to
   interface your radios to the cluster, you should now create your own
   o  $passwd - password that matches $login
 
 
-
-
-  5.2.  Setting up the initial user files
+  5.3.  Setting up the initial user files
 
   Next you need to create the initial user files, etc. A tool is
   supplied which will do this for you. To run the tool:-
 
 
 
+
   Now, if that's what you've got, you are very nearly home and dry (in
   as far as these particular experiments are concerned, anyhow)
 
-  To access your new cluster (from the local machine) find yourself
-  another "DOS box" and do the following:-
-
-
-
-
-  cd \spider\perl
-  perl winclient.pl
-
+  If you are running Windows 9x you can access your new cluster (from
+  the local machine) by finding yourself another "DOS box" and doing the
+  following:-
 
 
 
-  If you are rewarded with a display which looks something like:-
+       cd \spider\perl
+       perl winclient.pl
 
 
 
-       Hello Iain, this is GB7SJP in Amersham, Bucks running DXSpider V1.47
-       Cluster: 1 nodes, 1 local / 1 total users Max users 2 Uptime 0 00:00
-       M0ADI de GB7SJP 4-Mar-2001 1511Z >
 
+  If you are running Windows NT, 2000 or XP then winclient.pl does not
+  work. We don't know why other than this seems to be some kind of
+  incomaptibility in perl. You can achieve the same thing by telnetting
+  to the port you defined in Listeners.pm (7300 as default), thus:-
 
 
 
-  You've arrived. Try some commands, and see how they feel. (In case you
-  were wondering, "Iain", "M0ADI" and "GB7SJP" all came from the version
-  of DXVars.pm that was on the machine when I started the winclient.pl)
+       Menu->Start->Run
+       telnet localhost 7300
 
 
-  5.3.  Incoming telnets
 
-  If you want to enable inbound "TELNET" connections, you've got a
-  little more work to do. From a handy "DOS box" that's not doing
-  anything else, do the following:-
 
+  On getting the login: prompt, enter your sysop callsign (the one you
+  put in DXVars.pm as $myalias).
 
 
-       copy \spider\perl\listeners.pm \spider\local
-       cd \spider\local
-       notepad listeners.pm
+  I would recommend strongly that you obtain a better telnet client than
+  that which comes with windows (I use PuTTY).
 
 
+  Anyway, if you are rewarded with a display which looks something
+  like:-
 
 
-  The following lines need attention:-
-
 
+       Hello Iain, this is GB7SJP in Amersham, Bucks running DXSpider V1.47
+       Cluster: 1 nodes, 1 local / 1 total users Max users 2 Uptime 0 00:00
+       M0ADI de GB7SJP 4-Mar-2001 1511Z >
 
-       ["0.0.0.0", 7300],
 
 
 
+  You've arrived. Try some commands, and see how they feel. (In case you
+  were wondering, "Iain", "M0ADI" and "GB7SJP" all came from the version
+  of DXVars.pm that was on the machine when I started the winclient.pl)
 
-  On my machine, I've simply uncommented the "0.0.0.0" entry by removing
-  the '#' from the front of the line.
 
-  If you don't have a static hostname for your machine, and you intend
-  to allow folk to connect to your machine across the internet, then I'd
-  suggest you pay a visit to www.dyndns.org and create one for yourself.
-  While it's free, it will take a modest an amount of effort on your
-  part to read, understand and implement what needs to be done to set
-  this up.
+  The interface is very basic. It is a simple command line. There are
+  better looking interfaces. Most of the "standard" logging and DX
+  Cluster access programs that are capable of connecting via a TCP or
+  telnet connection will work as a "Sysop Console" client. You connect
+  to "localhost" on the port that you defined in Listeners.pm (usually
+  7300). I recommend packages like DXTelnet.
 
 
   5.4.  Connecting to other clusters
   connected to anything particularly useful at any given moment. Contact
   me by Email if you want me to set up a connection for you.
 
+
   6.  General Information
 
   The following relates to all versions of DXSpider and is not platform
 
 
 
-
-
-
-
-