README

   1 $Id: README,v 1.4 2001-02-27 14:23:24 rufustfirefly Exp $
   2
   3 This is the README file for netatalk.
   4
   5 Contents:
   6             o A Brief Description
   7             o Building & Installing
   8             o Getting Help
   9
  10 netatalk is an implementation of the AppleTalk Protocol Suite.  The
  11 current release contains support for EtherTalk Phase I and II, DDP,
  12 RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, and AFP.  The complete stack looks
  13 like this on a BSD-derived system:
  14
  15     AFP
  16      |
  17     ASP    PAP
  18       \   /
  19        ATP RTMP NBP ZIP AEP
  20         |    |   |   |   |
  21    -+---------------------------------------------------+- (kernel boundary)
  22     |                    Socket                         |
  23     +-----------------------+------------+--------------+
  24     |                       |     TCP    |    UDP       |
  25     |          DDP          +------------+--------------+
  26     |                       |           IP              |
  27     +-----------------------+---------------------------+
  28     |                Network-Interface                  |
  29     +---------------------------------------------------+
  30
  31 DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
  32 is the AppleTalk equivalent of Unix "routed".  There is also a
  33 client-stub library for NBP.  ATP and ASP are implemented as
  34 libraries.  "papd" allows Macs to spool to "lpd", and "pap" allows Unix
  35 machines to print to AppleTalk connected printers.  "psf" is a
  36 PostScript printer filter for "lpd", designed to use "pap".  "psorder"
  37 is a PostScript reverser, called by "psf" to reverse pages printed to
  38 face-up stacking printers.  "afpd" provides Macs with an interface to
  39 the Unix file system.  Refer to the appropriate man pages for
  40 operational information.
  41
  42 netatalk runs on five operating systems:
  43
  44         OS      Versions        Hardware        Notes
  45         --      --------        --------        -----
  46         Solaris 2.5             Sparc
  47         Linux   1.3.x,2.x       PC
  48         FreeBSD 2.2-current     PC              after 12 Sept 96
  49         SunOS   4.1+            Sparc           kernel must have VDDRV
  50                                                 option installed
  51         Ultrix  4.[1-4]         3100,5000
  52
  53 Instructions for installing the kernel portions of netatalk and system
  54 dependent FAQs are in the README file for your system, e.g.
  55 INSTALL/README.SUNOS, INSTALL/README.ULTRIX.
  56
  57 Building netatalk (versions up to 1.4b2+asun2.1.4):
  58
  59 0.  To build afpd for use with an AFS filesystem, first follow the
  60     instructions in INSTALL/README.AFS, then complete these
  61     instructions.
  62
  63 1.  Set DESTDIR in the root Makefile.  DESTDIR is the directory below
  64     which all binaries will be installed.  Setting it causes all
  65     installation-relative pathnames to be set correctly.  You may also
  66     wish to set MANDIR.  (If you do not want all binaries to go under
  67     DESTDIR, you can instead set SBINDIR, BINDIR, ETCDIR, and LIBDIR,
  68     to control the locations of the individual sections.)
  69
  70 2.  When you've completed the configuration, type "make" at the root of
  71     the source.  This will make all binaries.
  72
  73 Building netatalk (1.5 and up):
  74
  75 0.  Be sure to have the following utilities installed before attemping
  76         to build netatalk (*=required, +=optional):
  77         * GNU autoconf
  78         * GNU automake
  79         * GNU libtool
  80         * GCC or another ANSI C compliant compiler
  81         + OpenSSL or another SSL library to enable crypto support
  82         + tcp_wrappers to enable IP filtering support
  83
  84 1.      Run "./configure --help" to give a list of all of the available
  85         configuration options. You can then use "./configure (options)" to
  86         generate the build structure for netatalk. This system will
  87         automatically determine many things about your system to aid in the
  88         build process.
  89
  90 2.      Type "make all" at the root of the source to build everything.
  91
  92 Installing netatalk (versions up to 1.4b2+asun2.1.4):
  93
  94 1.  To install the binaries, type "make install" at the root of the
  95     source tree.  This will install all of the binaries.
  96
  97 2.  Sample config files for the daemons are in the config directory,
  98     e.g. config/AppleVolumes.system.  Install these files, or a version
  99     of these files, in ETCDIR (as distributed DESTDIR/etc), e.g.
 100     ETCDIR/AppleVolumes.system.  See the daemon's man page for a
 101     description of it's configuration file.
 102
 103 3.  psf uses the script SBINDIR/etc2ps to convert anything it
 104     doesn't understand to PostScript.  If you have a troff or dvi to
 105     PostScript filter on your machine, you might wish to edit etc2ps,
 106     to use your locally installed PostScript utilities.
 107
 108 4.  Add the contents of services.atalk to your /etc/services database.
 109     If you're using NIS (YP), add the contents of services.atalk to the
 110     NIS master's maps and push them.
 111
 112 5.  The file rc.atalk is installed in ETCDIR.  It should be called
 113     from your /etc/rc file, e.g. "sh ETCDIR/rc.atalk".  For more
 114     information on what this script does, read the man pages for the
 115     appropriate commands.
 116
 117 Installing netatalk (1.5 and up):
 118
 119 1.      Type "make install" or "make install-strip" to install binaries on
 120         the system. To install in a "fake" tree (like installing all /etc
 121         files in /var/tmp/tree/etc and all /usr files in /var/tmp/tree/usr),
 122         use "make DESTDIR=(path) install" or "make DESTDIR=(path) install-strip".
 123
 124 Please read the FAQ for netatalk if you are having problems
 125
 126 You might be interested in looking at the netatalk home page at
 127 http://www.umich.edu/~rsug/netatalk, which contains netatalk information
 128 up to version 1.4b2.  It has an archive of patches, trouble shooting
 129 hints, and some links to other netatalk and file service related sites.
 130 For more recent information on netatalk, visit the homepage at
 131 http://netatalk.sourceforge.net/
 132
 133 Development is currently carried out on the netatalk-devel list on
 134 sourceforge (netatalk-devel@lists.sourceforge.net).
 135
 136 You may wish to join the netatalk-admins@umich.edu (moderated) mailing
 137 list.  It carries announcements of new releases and general
 138 discussion.  You can join (or resign from) this list by sending mail to
 139 netatalk-admins-request@umich.edu.  Submissions (NOT requests to join
 140 or resign) to this list should be sent to netatalk-admins@umich.edu.
 141
 142 Research Systems Unix Group
 143 The University of Michigan              netatalk@umich.edu
 144 c/o Wesley Craig                        +1-313-764-2278
 145 535 W. William St.
 146 Ann Arbor, Michigan
 147 48103-4943
 148
 149 Amended 07 Feb 2001 jeff b <jefF@univrel.pr.uconn.edu>