updated dxoldtonew.pl to be more modern...
[spider.git] / txt / installation_en.txt
index 9363884a362368df93e609297aaa042b9bdb3b67..c552afab5ab2929ff9dfd8e01500615473d06886 100644 (file)
@@ -64,9 +64,9 @@
 
 
 
-  1.  Linux Installation
+  \e[1m1.  Linux Installation\e[0m
 
-  1.1.  Introduction
+  \e[1m1.1.  Introduction\e[0m
 
   This section describes the installation of DX Spider v1.50 on a RedHat
   Linux Distribution.  Wherever possible I will try to include
 
 
   I am assuming a general knowledge of Linux and its commands.  You
-  should know how to use tar and how to edit files using your favourite
+  should know how to use \e[4mtar\e[24m and how to edit files using your favourite
   editor.
 
 
   The crucial ingredient for all of this is Perl.  Earlier versions of
-  Spider required perl 5.004, however it is now STRONGLY recommended
+  Spider required perl 5.004, however it is now \e[4mSTRONGLY\e[24m recommended
   that you use at least version 5.005_03 as this is the version being
   used in the development of Spider.
 
 
   Do not fall into the trap of thinking they're all the same, just
   because they nearly are! Pay particular attention to the instructions
-  of IO, above.
+  of \e[4mIO\e[24m, above.
 
 
 
-  1.2.  Preparation
+  \e[1m1.2.  Preparation\e[0m
 
   I will assume that you have already downloaded the latest tarball of
   the DXSpider software and are ready to install it. I am assuming
   version.
 
 
-  Login as root and create a user to run the cluster under.  UNDER NO
-  CIRCUMSTANCES USE ROOT AS THIS USER!.  I am going to use the name
-  sysop.  You can call it anything you wish.  Depending on your security
+  Login as root and create a user to run the cluster under.  \e[4mUNDER\e[24m \e[4mNO\e[0m
+  \e[4mCIRCUMSTANCES\e[24m \e[4mUSE\e[24m \e[4mROOT\e[24m \e[4mAS\e[24m \e[4mTHIS\e[24m \e[4mUSER!\e[24m.  I am going to use the name
+  \e[4msysop\e[24m.  You can call it anything you wish.  Depending on your security
   requirements you may wish to use an existing user, however this is
   your own choice.
 
 
 
 
-  1.3.  Installing the software
+  \e[1m1.3.  Installing the software\e[0m
 
   Now to unpack the DX Spider distribution, set symbolic links and group
   permissions.  Copy the tarball to /home/sysop and do the following.
 
 
 
-  If you do not have the command groupadd available to you simply add a
+  If you do not have the command \e[4mgroupadd\e[24m available to you simply add a
   line in /etc/group by hand.
 
 
 
 
 
-  This last step allows various users of the group spider to have write
+  This last step allows various users of the group \e[4mspider\e[24m to have write
   access to all the directories.  This is not really needed just yet but
   will be useful when web interfaces start to appear.
 
 
   Finally, you need to fix the permissions on the ax25_call and
-  netrom_call programs.  Check where they are with the locate command
-  and alter the permissions with the chmod command like this ..
+  netrom_call programs.  Check where they are with the \e[4mlocate\e[24m command
+  and alter the permissions with the \e[4mchmod\e[24m command like this ..
 
 
 
 
 
 
-  1.4.  Setting callsigns etc
+  \e[1m1.4.  Setting callsigns etc\e[0m
 
   Now login to your machine as the user you created earlier.  In my case
-  that user is called sysop.  Once logged in, issue the following
+  that user is called \e[4msysop\e[24m.  Once logged in, issue the following
   commands ....
 
 
   This is the sysop user callsign, normally your own.
 
 
-  PLEASE USE CAPITAL LETTERS FOR CALLSIGNS
+  \e[1mPLEASE USE CAPITAL LETTERS FOR CALLSIGNS\e[0m
 
 
   Note that this a perl file which will be parsed and executed as part
 
 
 
-  1.5.  The client program
+  \e[1m1.5.  The client program\e[0m
 
   In earlier versions of Spider, all the processes were Perl scripts.
   This was fine but with a lot of users your computer memory would soon
   be used up.  To combat this a new client was written in "C".  This
-  client only works for incoming connects at the moment.  Before you can
-  use it though it has to be "made".  CD to /spider/src and type make.
+  client only works for \e[4mincoming\e[24m connects at the moment.  Before you can
+  use it though it has to be "made".  CD to /spider/src and type \e[4mmake\e[24m.
   You should see the output on your screen and hopefully now have a
-  small C program called client.  Leave it in this directory.
-  1.6.  Starting up for the first time
+  small C program called \e[4mclient\e[24m.  Leave it in this directory.
+  \e[1m1.6.  Starting up for the first time\e[0m
 
   We can now bring spider up for the first time and see if all is well
   or not!  It should look something like this ...
 
 
 
-  If all is well then login on another term or console as sysop and cd
+  If all is well then login on another term or console as \e[4msysop\e[24m and cd
   to /spider/src.  Now issue the following command ...
 
 
 
 
 
-  2.  Linux quick installation guide
+  \e[1m2.  Linux quick installation guide\e[0m
 
   This section is designed for experienced Spider sysops who want to
   install Spider from scratch.  It is simply a check list of things that
   o  Enter the correct line in /etc/inittab (root)
 
 
-  3.  Setting up the AX25 Utilities
+  \e[1m3.  Setting up the AX25 Utilities\e[0m
 
   The aim of this section is not to fully cover the installation and
   configuration of all the possible ax25 modules.  I will attempt to
   necessarily the best or for that matter, the right way!
 
 
-  3.1.  Getting Started
+  \e[1m3.1.  Getting Started\e[0m
 
   There are 2 things you need to do initially.  You need to get the 3
   files required for the ax25 installation and you need to make some
   o  ax25-apps-0.0.4-9.i386.rpm
 
 
-  3.2.  The kernel
+  \e[1m3.2.  The kernel\e[0m
 
   First you need to add Amateur Radio Support to your kernel.  This is a
   main menu item and should be easily found.  Within this header you
   Now recompile your kernel in the normal way and reboot your system.
 
 
-  3.3.  Installing the RPM's
+  \e[1m3.3.  Installing the RPM's\e[0m
 
   Now install the RPM's you downloaded, libax25 first, then ax25-tools,
   then ax25-apps.
 
 
 
-  3.4.  Configuration
+  \e[1m3.4.  Configuration\e[0m
 
   You will find the configuration files in /etc/ax25.  These consist of
   several files ...
   NOTE:- before we start it is important to realise that every interface
   requires a different SSID.  You should be able to follow this in the
   following examples.
-  3.5.  axports
+  \e[1m3.5.  axports\e[0m
 
   This file sets up the ax25 ports you want to use.  An example is below
   for a standard TNC2 ...
 
 
 
-  3.6.  nrports
+  \e[1m3.6.  nrports\e[0m
 
   This file sets up the netrom ports you want to use.  An example is
   below and includes a port for both cluster and node.  You will see why
 
 
 
-  3.7.  nrbroadcast
+  \e[1m3.7.  nrbroadcast\e[0m
 
   This file sets up the netrom broadcast qualities.  An example is below
   ...
 
 
 
-  3.8.  ax25d.conf
+  \e[1m3.8.  ax25d.conf\e[0m
 
   This file controls any incoming ax25 and NET/ROM connections and
   steers them to the relevant program.  There are lots of configuration
 
 
 
-  3.9.  node.conf
+  \e[1m3.9.  node.conf\e[0m
 
   For those of you that wish to run the node, you need to set up the
   node.conf file.  There are a couple of additional files, node.perms is
   This should be fairly obvious I hope.
 
 
-  3.10.  Getting it all running
+  \e[1m3.10.  Getting it all running\e[0m
 
   Ok, now we have all the relevant files configured, the next step is to
   get it all running.
   stations and receive incoming ax25 and netrom connections.
 
 
-  4.  Configuration
+  \e[1m4.  Configuration\e[0m
 
-  4.1.  Allowing ax25 connects from users
+  \e[1m4.1.  Allowing ax25 connects from users\e[0m
 
   This is dealt with in the previous section
 
 
-  4.2.  Allowing telnet connects from users
+  \e[1m4.2.  Allowing telnet connects from users\e[0m
 
 
   >From version 1.47 there is a new (more efficient) way of doing this
 
 
 
-  Now login as sysop and cd spider/src. You can test that spider is
+  Now login as \e[4msysop\e[24m and cd spider/src. You can test that spider is
   accepting telnet logins by issuing the following command ....
 
 
   You should now get the login prompt and be able to login as before.
 
 
-  4.3.  Setting up telnet connects (from 1.47 onwards)
+  \e[1m4.3.  Setting up telnet connects (from 1.47 onwards)\e[0m
 
   >From version 1.47 you can choose to allow the perl cluster.pl program
   to allow connections directly (i.e. not via the /spider/src/client
   to make the change happen...
 
 
-  Having done that, you need to copy the file /spider/perl/Listeners.pm
-  to /spider/local and then edit it. You will need to uncomment the line
+  Having done that, you need to copy the file \e[4m/spider/perl/Listeners.pm\e[0m
+  to \e[4m/spider/local\e[24m and then edit it. You will need to uncomment the line
   containing "0.0.0.0" and select the correct port to listen on. So that
   it looks like this:-
 
   users.
 
 
-  4.4.  Setting up for AGW Engine (1.47 onwards)
+  \e[1m4.4.  Setting up for AGW Engine (1.47 onwards)\e[0m
 
   AGW Engine is a Windows based ax25 stack. You can connect to an AGW
   engine from Linux as well as Windows based machines.
 
 
   In order to enable access to an AGW Engine you need to copy
-  /spider/perl/AGWConnect.pm to /spider/local and edit it.  Specifically
+  \e[4m/spider/perl/AGWConnect.pm\e[24m to \e[4m/spider/local\e[24m and edit it.  Specifically
   you must:-
 
 
 
 
 
-  4.5.  Setting up node connects
+  \e[1m4.5.  Setting up node connects\e[0m
 
   In order to allow cluster node connections, spider needs to know that
   the connecting callsign is a cluster node.  This is the case whether
 
 
 
-  4.6.  Connection scripts
+  \e[1m4.6.  Connection scripts\e[0m
 
   Because DXSpider operates under Linux, connections can be made using
   just about any protocol;  AX25, NETRom, tcp/ip, ROSE etc are all
 
 
 
-     #  All lines starting with a # are ignored, as are completely blank
+     \e[1m#  \e[22mAll lines starting with a # are ignored, as are completely blank
         lines.
 
 
-     timeout
+     \e[1mtimeout\e[0m
         timeout followed by a number is the number of seconds to wait
         for a command to complete. If there is no timeout specified in
         the script then the default is 60 seconds.
 
 
-     abort
+     \e[1mabort\e[0m
         abort is a regular expression containing one or more strings to
         look for to abort a connection. This is a perl regular
         expression and is executed ignoring case.
 
 
-     connect
+     \e[1mconnect\e[0m
         connect followed by ax25, agw (for Windows users) or telnet and
         some type dependent information. In the case of a telnet
         connection, there can be up to two parameters.  The first is the
         down this route!
 
 
-     '  line in a chat type script. The words/phrases normally come in
-        pairs, either can be empty. Each line reads input from the
-        connection until it sees the string (or perl regular expression)
-        contained in the left hand string. If the left hand string is
-        empty then it doesn't read or wait for anything. The comparison
-        is done ignoring case.  When the left hand string has found what
-        it is looking for (if it is) then the right hand string is sent
-        to the connection.  This process is repeated for every line of
-        chat script.
+     \e[1m'  \e[22m' is the delimiting character for a word or phrase of an
+        expect/send line in a chat type script. The words/phrases
+        normally come in pairs, either can be empty. Each line reads
+        input from the connection until it sees the string (or perl
+        regular expression) contained in the left hand string. If the
+        left hand string is empty then it doesn't read or wait for
+        anything. The comparison is done ignoring case.  When the left
+        hand string has found what it is looking for (if it is) then the
+        right hand string is sent to the connection.  This process is
+        repeated for every line of chat script.
 
 
-     client
+     \e[1mclient\e[0m
         client starts the connection, put the arguments you would want
         here if you were starting the client program manually. You only
         need this if the script has a different name to the callsign you
        # you can leave this out if you call this script 'gb7djk'
        client gb7djk telnet
 
-
   Both these examples assume that everything is set up properly at the
   other end.  You will find other examples in the /spider/examples
   directory.
 
 
-  4.7.  Starting the connection
+  \e[1m4.7.  Starting the connection\e[0m
 
   You start the connection, from within a sysop enabled cluster login,
-  by typing in the word connect followed by a script name like this ....
+  by typing in the word \e[4mconnect\e[24m followed by a script name like this ....
 
 
 
 
 
 
-  This will start a connection using the script called gb7djk-1.  You
+  This will start a connection using the script called \e[4mgb7djk-1\e[24m.  You
   can follow the connection by watching the term or console from where
-  you started cluster.pl.  From version 1.47 onwards, you will need to
+  you started \e[4mcluster.pl\e[24m.  From version 1.47 onwards, you will need to
   set/debug connect first.  You should see something like this ...
 
 
   This tells them when a user or node logs in or out.  If you do not add
   a line to your scripts after the final line (or before the client line
   which should always be last if needed) then the login/logout
-  information will be sent to users before the login actually completes.
+  information will be sent to users \e[4mbefore\e[24m the login actually completes.
   This means if a node is unreachable, it will continue sending logins
   and logouts to users even though it is not actually connecting.  To
   avoid this use the following line ...
 
 
 
-  4.8.  Telnet echo
+  \e[1m4.8.  Telnet echo\e[0m
 
   Cluster links in particular suffer greatly from the presence of telnet
   echo.  This is caused by the telnet negotiation itself and can create
 
 
 
-  4.9.  Autostarting the cluster
+  \e[1m4.9.  Autostarting the cluster\e[0m
 
   Ok, you should now have DXSpider running nicely and allowing connects
   by cluster nodes or users.  However, it has to be shutdown and
   tty you run it on.
 
 
-  As root type the command telinit q.  DXSpider should start up
+  As root type the command \e[4mtelinit\e[24m \e[4mq\e[24m.  DXSpider should start up
   immediately.  You will see the output on tty7 and if you login as
-  sysop you should find everything running nicely.
+  \e[4msysop\e[24m you should find everything running nicely.
 
 
-  5.  Microsoft Windows Installation
+  \e[1m5.  Microsoft Windows Installation\e[0m
 
-  5.1.  Introduction
+  \e[1m5.1.  Introduction\e[0m
 
-  IMPORTANT:
+  \e[1mIMPORTANT:\e[0m
 
   What you'll be left with once you've followed these instructions is
   (hopefully) a working DX Spider v1.50 system that is capable of
   connections.
 
 
-  5.2.  The requirements
+  \e[1m5.2.  The requirements\e[0m
 
   The very first things you're going to need are (in order of
   importance):-
   o  Plenty of good, strong tea
 
 
-  5.3.  The system
+  \e[1m5.3.  The system\e[0m
 
   The platform I used to generate these instructions was a "vanilla"
   Microsoft Windows Me 4.90.3000 system, with a 700MHz AMD Athlon
   zero intention of trying to make them say otherwise.
 
 
-  5.4.  Perl
+  \e[1m5.4.  Perl\e[0m
 
   Install your chosen Perl environment. Unless you have a very good
   reason for not doing so, I strongly suggest that you use ActivePerl
   passed. Assuming it did work, you may now move on.
 
 
-  5.5.  Additional packages
+  \e[1m5.5.  Additional packages\e[0m
 
   Some extensions ("packages") need to be added to the base Perl
   distribution, and we'll do this next. If you're using the Perl I
   because it suits me.
 
 
-  5.6.  Getting Spider
+  \e[1m5.6.  Getting Spider\e[0m
 
   Get the current version of the DX Spider distribution. This needs to
   be v1.50 or later. You've got two ways (currently) of getting this;
 
 
   The only difference between "CVSlatest.tgz" and the latest "official"
-  release version is that it is more up to date. Do not confuse the
-  "CVSlatest.tgz" file with "Downloading from Sourceforge with CVS" -
-  they are two quite different things.  "Downloading from Sourceforge
+  release version is that it is more up to date. \e[1mDo not confuse the\e[0m
+  \e[1m"CVSlatest.tgz" file with "Downloading from Sourceforge with CVS" -\e[0m
+  \e[1mthey are two quite different things.  \e[22m"Downloading from Sourceforge
   with CVS" is explained in a section within the Admin manual.
 
 
   "C:\", for convenience.
 
 
-  6.  Installing the software
+  \e[1m6.  Installing the software\e[0m
 
   At this point you will need to create 2 additional directories under
   "C:\Spider."  Make directories "C:\spider\local" and
   you must write them as "\@" or "\$".
 
 
-  6.1.  Incoming telnets
+  \e[1m6.1.  Incoming telnets\e[0m
 
   If you want to enable inbound "TELNET" connections (or you are running
   Windows 98, NT, 2000 or XP), you've got a little more work to do. From
   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 98, NT,
-  2000 or XP based system
+  \e[1mYou MUST carry out this step if you are running on a Windows 98, NT,\e[0m
+  \e[1m2000 or XP based system\e[0m
 
   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
   up.
 
 
-  If your machine is connected to the internet and you don't want to
+  If your machine is connected to the internet \e[1mand \e[22myou 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).
+  "127.0.0.1" ("0.0.0.0" means \e[1mall \e[22mIP addresses).
 
 
-  6.2.  The AGW packet engine
+  \e[1m6.2.  The AGW packet engine\e[0m
 
   On the assumption that you'll be using the SV2AGW Packet Engine to
   interface your radios to the cluster, it would be a good idea to
   needed for use with DXSpider.
 
 
-  6.3.  Setting up the initial user files
+  \e[1m6.3.  Setting up the initial user files\e[0m
 
   Next you need to create the initial user files, etc. A tool is
   supplied which will do this for you. To run the tool:-
 
 
 
-  On getting the login: prompt, enter your sysop callsign (the one you
+  On getting the \e[1mlogin: \e[22mprompt, enter your sysop callsign (the one you
   put in DXVars.pm as $myalias).
-  I would recommend strongly that you obtain a better telnet client than
+  I would recommend \e[1mstrongly \e[22mthat you obtain a better telnet client than
   that which comes with windows (I use PuTTY).
 
 
   7300). I recommend packages like DXTelnet.
 
 
-  6.4.  Connecting to other clusters
+  \e[1m6.4.  Connecting to other clusters\e[0m
 
   If you want to connect this to another cluster, then you'll want to
   negotiate a link with someone. For experimental purposes, I'm happy to
   me by Email if you want me to set up a connection for you.
 
 
-  7.  General Information
+  \e[1m7.  General Information\e[0m
 
   The following relates to all versions of DXSpider and is not platform
   related.
 
 
-  7.1.  The crontab file
+  \e[1m7.1.  The crontab file\e[0m
 
-  Login as sysop and create a file in /spider/local_cmd called crontab.
+  Login as \e[4msysop\e[24m and create a file in /spider/local_cmd called crontab.
   Edit it with your favourite editor and add a line like this (I have
   included a comment)