Information for Netatalk 1.5 Developers
=======================================

For basic installation instructions, see the INSTALL file.


netatalk is an implementation of the AppleTalk Protocol Suite.  The
current release contains support for EtherTalk Phase I and II, DDP,
RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, and AFP.  The complete stack looks
like this on a BSD-derived system:

    AFP
     |
    ASP    PAP
      \   /
       ATP RTMP NBP ZIP AEP
	|    |   |   |   |
   -+---------------------------------------------------+- (kernel boundary)
    |                    Socket                         |
    +-----------------------+------------+--------------+
    |                       |     TCP    |    UDP       |
    |          DDP          +------------+--------------+
    |                       |           IP              |
    +-----------------------+---------------------------+
    |                Network-Interface                  |
    +---------------------------------------------------+

DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
is the AppleTalk equivalent of Unix "routed".  There is also a
client-stub library for NBP.  ATP and ASP are implemented as
libraries.  "papd" allows Macs to spool to "lpd", and "pap" allows Unix
machines to print to AppleTalk connected printers.  "psf" is a
PostScript printer filter for "lpd", designed to use "pap".  "psorder"
is a PostScript reverser, called by "psf" to reverse pages printed to
face-up stacking printers.  "afpd" provides Macs with an interface to
the Unix file system.  Refer to the appropriate man pages for
operational information.


Compilation
===========
   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.


Tools for Developers
====================
1. Libtool
Libtool encapsulates the platform specific dependencies for the
creation of libraries. It determines if the local platform can support
shared libraries or if it only supports static libraries.

Netatalk currently requires libtool 1.4 or higher (1.4b for OpenBSD).
If you are using Tru64 you must apply the following patch to the file
acinclude.m4 (normally found in /usr/share/libtool/libltdl).

--- acinclude.m4.old	Tue Nov 20 15:30:23 2001
+++ acinclude.m4	Tue Nov 20 15:31:54 2001
@@ -2226,6 +2226,7 @@
 
 osf3* | osf4* | osf5*)
   version_type=osf
+  need_lib_prefix=no
   need_version=no
   soname_spec='${libname}${release}.so'
   library_names_spec='${libname}${release}.so$versuffix ${libname}${release}.so $libname.so'

Documentation: http://www.gnu.org/software/libtool/
Program: (see the GNU mirrors) /gnu/libtool/libtool-1.4.tar.gz

2. GNU m4
GNU m4 is an implementation of the Unix macro processor. It reads
stdin and copies to stdout expanding defined macros as it processes
the text.

Documentation: http://www.gnu.org/software/m4/
Program: (see the GNU mirrors) /gnu/m4/m4-1.4.tar.gz

3. Autoconf
Autoconf is a package of m4 macros that produce shell scripts to
configure source code packages.

Documentation: http://www.gnu.org/software/autoconf/
Program: (see the GNU mirrors) /gnu/autoconf/autoconf-2.52.tar.gz

4. Automake
Automake is a tool that generates  'Makefile.in' files.

Documentation: http://www.gnu.org/software/automake/
Program: (see the GNU mirrors) /gnu/automake/automake-1.5.tar.gz

Optional
========
5. OpenSSL
The OpenSSL Project is a collaborative effort to develop a robust,
commercial-grade, full-featured, and Open Source toolkit implementing
the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS
v1) protocols as well as a full-strength general purpose cryptography
library.
This is required to enable DHX login support.

Get everything at http://www.openssl.org/ 

6. TCP Wrappers 
Wietse Venema's network logger, also known as TCPD or LOG_TCP. These
programs log the client host name of incoming telnet, ftp, rsh,
rlogin, finger etc. requests. Security options are: access control per
host, domain and/or service; detection of host name spoofing or host
address spoofing; booby traps to implement an early-warning system.
TCP Wrappers can be gotten at ftp://ftp.porcupine.org/pub/security/
Netatalk uses TCP Wrappers to authorize host access when using
afpovertcp. It should be noted that if DDP is in use, the connection
will still be allowed as TCP Wrappers do not impact DDP connections.

7. PAM (Pluggable Authentication Modules) 
PAM provides a flexible mechanism for authenticating
users. PAM was invented by SUN Microsystems.

Author: Andrew Morgan <morgan@linux.kernel.org>

Linux-PAM is a suite of shared libraries that enable the local system
administrator to choose how applications authenticate users.

You can get the Linux PAM documentation and sources from
http://www.kernel.org/pub/linux/libs/pam/

Netatalk also supports other standard PAM implementations such as OpenPAM.

8 Berkeley DB
Berkeley DB is a programmatic toolkit that provides fast, reliable,
scalable, and mission-critical database support to software
developers. BDB can downloaded from
http://www.sleepycat.com/download.html
Netatalk's CNID database uses the library and header files from BDB.
Currently, Netatalk supports BDB 4.1.25 and 4.2.52.
The recommended version is 4.2.52 as that is the version on which most
testing has been done.
