]> www.dxcluster.org Git - spider.git/blob - html/client.html
rbn collect qra info ftom FTx spots
[spider.git] / html / client.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2 <html>
3   <head>
4     <title>The Standard Client</title>
5         <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">
6         <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">
7         <meta name="Author" content="Dirk Koopman G1TLH">
8     <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
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: Sun Apr  1 18:18:19 BST 2001
24 <!-- hhmts end -->
25
26         <h4>Introduction</h4>
27
28         The standard client program is written in C and lives in <tt>/spider/src</tt>.
29         It performs the interface function
30         between the cluster daemon (<tt>/spider/perl/cluster.pl</tt>) and 
31         AX25 or Telnet connections for incoming connections.
32         
33         <p>There is a related program called <tt>/spider/perl/console.pl</tt> which,
34         as of version 1.30, is the standard sysop or full duplex telnet user
35         connected interface program. This is a simple screen oriented program
36         that has a bash or shell like command history editing facility as well
37         as a scrolling cluster window with colouration of particular lines of
38         interest (such as DX spots, Announces etc).
39
40
41         <h4>client</h4>
42
43         The client itself is a rather rudimentary program which really
44         only deals with things like line end conventions and noticing when
45         a connection goes away. It is written in C and thus become
46         considerably smaller.
47
48         <P>The client can take up two arguments: a "callsign" and a connection type. 
49
50         <p>The "callsign" can have the following values:-
51         <ol>
52                 <p><li>A real callsign (!).
53
54                 <P>For normal incoming ax25 connections it is important to make sure that
55                 the callsign passed <b>DOES NOT</b> have an SSID (use the %u
56                 or %U in <tt>ax25d.conf</tt>). The DXSpider system largely
57                 ignores what it regards as 'duplicate' callsigns (and that
58                 includes those with SSIDs) except in certain <a
59                 href="#special">special</a> cases. 
60
61                 <p><li><b>login</b> This will cause a unix like
62                 <tt>login:</tt> phase to be run. 
63                 
64         </ol>
65
66         <p>The connection type can be:-
67         <ol>
68                 <p><li><b>ax25</b> This tells the client to use ax25 line conventions.
69
70                 <p><li><b>telnet</b> This tells the client to use normal unix line conventions.
71         </ol>
72
73         <p>The connection type can be missing in which case the default is unix line conventions.
74
75         <p>If both the callsign and the connection are missing then it is
76         assumed that the client is the sysop and uses the callsign set in
77         your local copy of <a href="install.html#dxvar">DXVars.pm</a>.
78
79         <h4>Considerations</h4>
80
81         <a name="special"></a>As mentioned earlier, SSIDs are generally stripped from
82           callsigns except in two cases:
83         <ol>
84                 <p><li>For Cluster node callsigns. Although here in the UK we are issued with
85                 special callsigns to run cluster nodes and BBSs, this is not universal. Therefore
86                 by marking a callsign as a node you disable SSID checking. You will have to treat
87                 incoming cluster callsigns specially in <tt>ax25d.conf</tt> to use this feature (i.e
88                 you will have to set up a line specially for that callsign with a %s or %S for the
89                 callsign substitution [better just put the callsign you want!]).
90
91                 <p><li>The sysop callsign set up in your local copy of 
92                 <a href="install.html#dxvar">DXVars.pm</a>. You must call <tt>client.pl</tt> with
93                 no parameters for this to work.
94         </ol>
95
96         <h4>Files</h4>
97
98         The client only uses files when in the <b>login</b> phase.  It
99         prints the <tt>/spider/data/issue</tt> file, if it is present, to
100         the user before issuing the <tt>login:</tt> prompt. After a callsign
101         is entered it uses
102         the standard cluster user file to check it.
103
104         <p>Having said all of that the client <em>appears</em> to use the following files and
105           sends them to the user if they are present:-
106         <ul>
107           <li><b>/spider/data/issue</b> which is sent before a login prompt.
108           <li><b>/spider/data/connect</b> which is sent immediately after a successful login.
109           <li><b>/spider/data/motd</b> which is sent to the user on normal user startup.
110           <li><b>/spider/data/logout</b> which is sent to user on disconnection.
111           <li><b>/spider/data/offline</b> which is sent to the user if the cluster daemon 
112                 isn't running.
113         </ul>
114
115 <!-- Standard Footer!! -->
116         <p>&nbsp;</p>
117         <p>
118           <FONT COLOR="#606060"><hr></font>
119         <font color="#FF0000" size=-2>
120           Copyright &copy; 1998 by Dirk Koopman G1TLH. All Rights Reserved<br>
121         </font>
122         <font color="#000000" size=-2>$Id$</font>
123   </body>
124 </html>