html/client.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   2 <html>
   3   <head>
   4     <title>The Standard Client</title>
   5     <title>Connecting to other Clusters</title>
   6         <meta name="Keywords" content="DX Cluster, DXSpider, Spider, Packet Cluster, DXCluster, Pavillion Software, AK1A, AX25, AX.25, WWV, Packet Radio, Amateur Radio, Propagation, DX, DXing, G1TLH, GB7TLH, Dirk Koopman, Mailing list, Linux, RedHat, PERL">
   7         <meta name="Description" content="Software and systems for realtime digital communications between amateur radio stations for the provision of information on propagation conditions and stations operating">
   8         <meta name="Author" content="Dirk Koopman G1TLH">
   9   </head>
  10
  11   <body TEXT="#000000" LINK="#0000ff" VLINK="#800080" BGCOLOR="#FFFFFF">
  12         <FONT COLOR="#606060">
  13           <hr>
  14           <h2>The Standard Client</h2>
  15           <hr>
  16         </font>
  17
  18
  19         <address><a href="mailto:djk@tobit.co.uk">Dirk Koopman G1TLH</a></address>
  20         <p>
  21           <!-- Created: Sun Dec 13 20:25:14 GMT 1998 -->
  22           <!-- hhmts start -->
  23 Last modified: Mon Dec 21 12:26:18 GMT 1998
  24 <!-- hhmts end -->
  25
  26         <h4>Introduction</h4>
  27
  28         The standard client program is written in perl and lives in <tt>/spider/perl/client.pl</tt>.
  29         It performs the interface function
  30         between the cluster daemon (<tt>/spider/perl/cluster.pl</tt>) and
  31         AX25 or Telnet connections, both incoming and outgoing.
  32
  33         <h4>client.pl</h4>
  34
  35         The client itself is a rather rudimentary program which really only deals with
  36         things like line end conventions and noticing when a connection goes away. It is
  37         envisaged that at some time in the nearish future this program will be written in
  38         C and thus become considerably smaller. But, for the moment and whilst this area
  39         is under some development, it will remain in perl for ease of change.
  40
  41         <P>The client can take up two arguments: a "callsign" and a connection type.
  42
  43         <p>The "callsign" can have the following values:-
  44         <ol>
  45                 <p><li>A real callsign (!).
  46
  47                 <P>For incoming connections it is important to make sure that
  48                 the callsign passed <b>DOES NOT</b> have an SSID (use the %u
  49                 or %U in <tt>ax25d.conf</tt>). The DXSpider system largely
  50                 ignores what it regards as 'duplicate' callsigns (and that
  51                 includes those with SSIDs) except in certain <a
  52                 href="#special">special</a> cases.
  53
  54                 <P><li>The name of a <a href="connect.html">connect</a> script.
  55
  56                 <p><li><b>login</b> This will cause a unix like <tt>login:</tt> and
  57                 <tt>password:</tt> phase to be run. With version 1.13 the password isn't
  58                 checked unless there is a password recorded in the user file - but you have
  59                 no means of recording a password! (unless you have created a local <tt>set/password</tt>
  60                 command - please donate a copy it you have)
  61
  62                 <p>Also in 1.13 only existing users can enter via this means. This will probably
  63                   change, but please discuss this in the <a href="../lists/dxspider-support/index.html">support</a>
  64                   mailing list.
  65
  66         </ol>
  67
  68         <p>The connection type can be:-
  69         <ol>
  70                 <p><li><b>ax25</b> This tells the client to use ax25 line conventions.
  71
  72                 <p><li><b>telnet</b> This tells the client to use normal unix line conventions.
  73
  74                 <p><li><b>connect</b> Start an outgoing <a href="connect.html">connect</a> script.
  75                 Use the line conventions in that script.
  76         </ol>
  77
  78         <p>The connection type can be missing in which case the default is unix line conventions.
  79
  80         <p>If both the callsign and the connection are missing then it is
  81         assumed that the client is the sysop and uses the callsign set in
  82         your local copy of <a href="install.html#dxvar">DXVars.pm</a>.
  83
  84         <h4>Considerations</h4>
  85
  86         <a name="special"></a>As mentioned earlier, SSIDs are generally stripped from
  87           callsigns except in two cases:
  88         <ol>
  89                 <p><li>For Cluster node callsigns. Although here in the UK we are issued with
  90                 special callsigns to run cluster nodes and BBSs, this is not universal. Therefore
  91                 by marking a callsign as a node you disable SSID checking. You will have to treat
  92                 incoming cluster callsigns specially in <tt>ax25d.conf</tt> to use this feature (i.e
  93                 you will have to set up a line specially for that callsign with a %s or %S for the
  94                 callsign substitution [better just put the callsign you want!]).
  95
  96                 <p><li>The sysop callsign set up in your local copy of
  97                 <a href="install.html#dxvar">DXVars.pm</a>. You must call <tt>client.pl</tt> with
  98                 no parameters for this to work.
  99         </ol>
 100
 101         <h4>Files</h4>
 102
 103         The client only uses files when in the <b>login</b> phase.  It
 104         prints the <tt>/spider/data/issue</tt> file, if it is present, to
 105         the user before issuing the <tt>login:</tt> prompt. After a callsign
 106         and password is entered it uses
 107         the standard cluster user file to check them.
 108
 109
 110 <!-- Standard Footer!! -->
 111         <p>&nbsp;</p>
 112         <p>
 113           <FONT COLOR="#606060"><hr></font>
 114         <font color="#FF0000" size=-2>
 115           Copyright &copy; 1998 by Dirk Koopman G1TLH. All Rights Reserved<br>
 116         </font>
 117         <font color="#000000" size=-2>$Id$</font>
 118   </body>
 119 </html>