~ubuntu-branches/ubuntu/warty/dnprogs/warty

« back to all changes in this revision

Viewing changes to BUILD/README

  • Committer: Bazaar Package Importer
  • Author(s): Patrick Caulfield
  • Date: 2004-05-30 10:13:57 UTC
  • Revision ID: james.westby@ubuntu.com-20040530101357-1geqhhh0teccu0cm
Tags: 2.27
* Fix signal handling in sethost so it doesn't die with an embarrassing
  "Alarm clock" message.
* Add dependancy on modutils. Closes: #251508

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
This is dnprogs, the user programs for the Linux DECnet socket layer.
 
2
 
 
3
This collection comprises all the programs and libraries you will need
 
4
to get DECnet for Linux working. It assumes you already have the
 
5
kernel patch installed and built.
 
6
 
 
7
You MUST be running the latest Eduardo kernel patch (version number 0.0.11 or 
 
8
later) or Steve Whitehouse's patch to use these programs. If you are not
 
9
then several things (particularly dnetd) will NOT work. You will be warned
 
10
if you try to compile on old kernel versions.
 
11
 
 
12
 
 
13
INSTALLATION
 
14
------------
 
15
 
 
16
First, compile and install the programs:
 
17
 
 
18
   make ; make install
 
19
 
 
20
This should put all the user-level programs in /usr/local/bin, all the
 
21
system programs in /usr/local/sbin and the man pages under /usr/local/man.
 
22
 
 
23
Libraries will be installed in /usr/lib. If you would prefer them to be in
 
24
/usr/local/lib then edit Makefile.common and change libprefix.
 
25
If you do this you need to ensure that the libraries will be found by either
 
26
adding /usr/local/bin to the file /etc/ld.so.conf or by setting the 
 
27
environment variable LD_LIBRARY_PATH. See the man page for ld.so for more
 
28
information.
 
29
 
 
30
[Please don't send me mail about compiler warnings on libc5 based systems, I 
 
31
know. It compiles fine on libc6 systems (I can recommend Debian 2) because the
 
32
header files are more POSIX compliant.]
 
33
 
 
34
It will also install a startup script appropriate to your distribution. You
 
35
will need to set up your system so that this script is run at system startup
 
36
time. 
 
37
 
 
38
Debian 
 
39
------
 
40
The startup script is "/etc/init.d/decnet.sh"
 
41
Then run the command:
 
42
 
 
43
# update-rc.d start 39 S .  stop 11 1 .
 
44
 
 
45
Redhat
 
46
------
 
47
The startup script is "/etc/rc.d/init.d/decnet"
 
48
It should be linked to "/etc/rc.d/rc3.d/S09decnet"
 
49
You can use control-panel or tksysv to do this.
 
50
 
 
51
Caldera
 
52
-------
 
53
The startup script is "/etc/rc.d/init.d/decnet"
 
54
It should be linked to "/etc/rc.d/rc5.d/S01decnet"
 
55
 
 
56
You should also add the -f switch to the startnet command.
 
57
See the comments in the file for more detail.
 
58
 
 
59
Slackware   
 
60
---------
 
61
The startup script is "/etc/rc.decnet"
 
62
Put a call to this very near the start of your /etc/rc.d/rc.inet1 file.
 
63
 
 
64
SuSE
 
65
----
 
66
The startup script is "/sbin/init.d/decnet"
 
67
It should be linked to "/sbin/init.d/rc2.d/S05decnet"
 
68
 
 
69
 
 
70
NOTE: Wherever you put call the startup script from it *MUST* be run before 
 
71
the TCP/IP initialisation because it needs to set the MAC address of the
 
72
ethernet card.
 
73
 
 
74
You will also now have an example configuration file (called 
 
75
/etc/decnet.conf.sample). You should copy this to /etc/decnet.conf and edit it
 
76
to contain the details for your Linux machine (the executor) and all DECnet
 
77
nodes with which you want to communicate - see the man page for more details.
 
78
 
 
79
Alternatively you can use the script in scripts/setup.sh to aid in setting
 
80
up your DECnet configuration. This will prompt you for the necessary 
 
81
information and create an /etc/decnet.conf file for you. This script is run 
 
82
automatically when you first install a binary distribution.
 
83
 
 
84
You may also want to configure a DECnet proxies file. See the FAL 
 
85
documentation and the decnet.proxy(5) man page for more information.
 
86
 
 
87
UPGRADING FROM 1.x
 
88
------------------
 
89
All the libraries in the distribution carry the version number of the 
 
90
distribution itself rather than an ABI-type number. This is purely for
 
91
my convenience and there are many people who will tell me that this is just
 
92
plain wrong. Well so be it. The V2 libraries are all backward compatible
 
93
with the V1 libraries - the reverse is most certainly not true. If you build
 
94
any programs against libdnet.so.1 then they will still work against libdnet.so.2
 
95
so you can safely symlink here. The binary distributions contain these symlinks
 
96
so nothing should break.
 
97
 
 
98
The programs are all (externally) compatible with the older versions - some
 
99
programs have new switches.
 
100
 
 
101
 
 
102
DOCUMENTATION
 
103
-------------
 
104
man pages are provided for all the programs and also the routines in libdnet.
 
105
Also you will find some documentation in the Documentation directory of this
 
106
distribution.
 
107
 
 
108
If you have any problems then please consult the FAQ at 
 
109
http://linux-decnet.sourceforge.net/faq.html before emailing the list with 
 
110
questions.
 
111
 
 
112
 
 
113
PROGRAMS
 
114
--------
 
115
 
 
116
User programs in /usr/local/bin:
 
117
--------------------------------
 
118
dncopy      -  copy files between VMS and Linux
 
119
dntype      -  view VMS files
 
120
dndir       -  show VMS directories
 
121
dndel       -  delete VMS files
 
122
sethost     -  connect a terminal session to VMS
 
123
dnping      -  "ping" (NCP LOOP NODE) a VMS machine
 
124
dnsubmit    -  submit batch jobs to a VMS queue
 
125
dnprint     -  print files on a VMS printer
 
126
phone       -  phone client
 
127
 
 
128
Administrator programs and daemons in /usr/local/sbin:
 
129
------------------------------------------------------
 
130
startnet    -  needed to start the DECnet socket layer
 
131
ctermd      -  SET HOST server
 
132
rmtermd     -  DTERM server for older machines
 
133
fal         -  file access listener
 
134
vmsmaild    -  daemon to collect mail from VMSmail
 
135
sendvmsmail -  mail delivery filter to send mail from Linux to VMS
 
136
phoned      -  phone server (needed for any phone functionality)
 
137
dnetd       -  DECnet super server
 
138
decnetconf  -  Shell script to help in setting up /etc/decnet.conf
 
139
dnmount     -  mount a VMS filesystem (still beta - requires dapfs)
 
140
 
 
141
Libraries in /usr/lib
 
142
---------------------
 
143
libdnet         -  DECnet database functions
 
144
libdnet_daemon  -  Common routines for DECnet daemons
 
145
libdap          -  DAP protocol
 
146
librms          -  Routines for user programs to access RMS files
 
147
 
 
148
 
 
149
PHONE
 
150
-----
 
151
An excuse.
 
152
 
 
153
Phone uses GTK+ V1.2 for its X-Windows interface. If you do not have GTK+ 1.2
 
154
installed then you will only get the ncurses interface. I do apologise for this
 
155
but I am a newcomer to GTK+ and don't (yet, perhaps) have the knowledge to
 
156
produce code that is more portable; a lot of the widget creation code was
 
157
produced using the UI builder GLADE. I am an experienced X-Windows programmer
 
158
but that experience is with Xt and Motif because it was gained in a commercial
 
159
environment (using VMS rather than Unix since you asked!). I believe that GTK+
 
160
is the future of - free - software development and Motif, despite the 
 
161
excellent efforts of the Lesstif team, is merely a legacy toolkit.
 
162
 
 
163
 
 
164
Writing DECnet programs
 
165
-----------------------
 
166
The DECnet programs all use the BSD socket API, so if you are familiar
 
167
with that then you are nearly there, particularly for clients.
 
168
If you want to write a server then I recommend you read the man page for
 
169
dnet_daemon - this includes a description of the DECnet daemon toolkit and
 
170
a complete, working example of a daemon that will run standalone or from
 
171
dnetd.
 
172
 
 
173
It's also worth visiting Steve Whitehouse's web site for information on
 
174
the more advanced calls. http://www.chygwyn.com/DECnet/
 
175
 
 
176
Plus...You have the source to many client and server programs in this very
 
177
package so peruse them and learn!
 
178
 
 
179
If all you want to do is access RMS files from Linux then librms is a much
 
180
easier way of achieving this because it contains open/read/write/close calls
 
181
that you will be more familiar with. See the librms directory for more 
 
182
information.
 
183
 
 
184
 
 
185
ALSO INCLUDED
 
186
-------------
 
187
This distribution also contains uulib from the uudeview suite by Frank Pilhofer
 
188
(fp@informatik.uni-frankfurt.de). 
 
189
 
 
190
I have supplied it here pre-configured for Linux and it seems OK for me on
 
191
libc5 and 6 systems, Intel, SPARC and Alpha.
 
192
 
 
193
If you have problems or you want the rest of the uudeview distribution or want
 
194
to try a later version of uulib you can download it from
 
195
http://www.informatik.uni-frankfurt.de/~fp/uudeview.
 
196
 
 
197
Thanks to Frank for a great set of encoders/decoders - I use them a lot.
 
198
 
 
199
 
 
200
LICENCES
 
201
--------
 
202
All the programs are released under the GNU General Public licence. See the
 
203
file COPYING.programs for the full text.
 
204
 
 
205
The libraries (libdnet, libdap, libdnet_daemon and librms) are released under
 
206
the GNU Lesser (or Library) Public licence. See the file COPYING.libraries
 
207
for the full text.
 
208
 
 
209
Please note that uulib is released under the GPL (*not* LGPL). Contact Frank
 
210
if you want to discuss this.
 
211
 
 
212
CONTRIBUTORS
 
213
------------
 
214
Most of the programs in the apps directory and most of libdnet were written
 
215
by Eduardo Serrat. Bits of libdnet are also by Steve Whitehouse. Nearly all
 
216
the rest of the stuff was written by me (Patrick Caulfield) and the
 
217
whole package is maintained by me, I've had my fingers in all their bits too.
 
218
 
 
219
I am grateful to several people for providing patches and programs:
 
220
Paul Koning (rmtermd & patches for sethost, dndir)
 
221
Rob Davies & David North (patches for dnping)
 
222
Kenn Humborg (patch for dntask)
 
223
Maciej Rozycki (patch for Makefiles)
 
224
Frank Pilhofer (for uulib) see above.
 
225
And to everyone who has submitted bug reports - please don't stop.
 
226
 
 
227
 
 
228
SUPPORT
 
229
-------
 
230
These programs have been tested on Linux 2.0, 2.1, 2.2, 2.3 & 2.4 on Intel, 
 
231
Alpha and SPARC machines (though not necessarily all combinations!)
 
232
 
 
233
I encourage all users to join the linux-decnet mailing list by visiting the
 
234
mailing list web site at 
 
235
http://lists.sourceforge.net/lists/listinfo/linux-decnet-user
 
236
 
 
237
The list is archived at http://www.geocrawler.com/lists/3/SourceForge/3243/0/
 
238
 
 
239
If you need help with the software, think you have found a bug or would 
 
240
like to request a feature then please send your messages to this mailing list.
 
241
 
 
242
Note that while I cannot guarantee you will get support for these programs,
 
243
we on the list will endeavour to help where possible.
 
244
 
 
245
If you send me or the mailing list a message that is answered in this file or 
 
246
the online FAQ (at http://linux-decnet.sourceforge.net/faq.html) then it
 
247
will probably be ignored. I have a life to lead and a job to hold down.
 
248
 
 
249