README

   1 This is the README file for netatalk.
   2
   3 Contents:
   4             o A Brief Description
   5             o BUILDING & INSTALLING
   6             o Getting Help
   7
   8 netatalk is an implementation of the AppleTalk Protocol Suite.  The
   9 current release contains support for EtherTalk Phase I and II, DDP,
  10 RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, and AFP.  The complete stack looks
  11 like this on a BSD-derived system:
  12
  13     AFP
  14      |
  15     ASP    PAP
  16       \   /
  17        ATP RTMP NBP ZIP AEP
  18         |    |   |   |   |
  19    -+---------------------------------------------------+- (kernel boundary)
  20     |                    Socket                         |
  21     +-----------------------+------------+--------------+
  22     |                       |     TCP    |    UDP       |
  23     |          DDP          +------------+--------------+
  24     |                       |           IP              |
  25     +-----------------------+---------------------------+
  26     |                Network-Interface                  |
  27     +---------------------------------------------------+
  28
  29 DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
  30 is the AppleTalk equivalent of Unix "routed".  There is also a
  31 client-stub library for NBP.  ATP and ASP are implemented as
  32 libraries.  "papd" allows Macs to spool to "lpd", and "pap" allows Unix
  33 machines to print to AppleTalk connected printers.  "psf" is a
  34 PostScript printer filter for "lpd", designed to use "pap".  "psorder"
  35 is a PostScript reverser, called by "psf" to reverse pages printed to
  36 face-up stacking printers.  "afpd" provides Macs with an interface to
  37 the Unix file system.  Refer to the appropriate man pages for
  38 operational information.
  39
  40 netatalk runs on five operating systems:
  41
  42         OS      Versions        Hardware        Notes
  43         --      --------        --------        -----
  44         Solaris 2.5             Sparc
  45         Linux   1.3.x,2.x       PC
  46         FreeBSD 2.2-current     PC              after 12 Sept 96
  47         SunOS   4.1+            Sparc           kernel must have VDDRV
  48                                                 option installed
  49         Ultrix  4.[1-4]         3100,5000
  50
  51 Instructions for installing the kernel portions of netatalk and system
  52 dependent FAQs are in the README file for your system, e.g.
  53 INSTALL/README.SUNOS, INSTALL/README.ULTRIX.
  54
  55 Building netatalk:
  56
  57 0.  To build afpd for use with an AFS filesystem, first follow the
  58     instructions in INSTALL/README.AFS, then complete these
  59     instructions.
  60
  61 1.  Set DESTDIR in the root Makefile.  DESTDIR is the directory below
  62     which all binaries will be installed.  Setting it causes all
  63     installation-relative pathnames to be set correctly.  You may also
  64     wish to set MANDIR.  (If you do not want all binaries to go under
  65     DESTDIR, you can instead set SBINDIR, BINDIR, ETCDIR, and LIBDIR,
  66     to control the locations of the individual sections.)
  67
  68 2.  When you've completed the configuration, type "make" at the root of
  69     the source.  This will make all binaries.
  70
  71 Installing netatalk:
  72
  73 1.  To install the binaries, type "make install" at the root of the
  74     source tree.  This will install all of the binaries.
  75
  76 2.  Sample config files for the daemons are in the config directory,
  77     e.g. config/AppleVolumes.system.  Install these files, or a version
  78     of these files, in ETCDIR (as distributed DESTDIR/etc), e.g.
  79     ETCDIR/AppleVolumes.system.  See the daemon's man page for a
  80     description of it's configuration file.
  81
  82 3.  psf uses the script SBINDIR/etc2ps to convert anything it
  83     doesn't understand to PostScript.  If you have a troff or dvi to
  84     PostScript filter on your machine, you might wish to edit etc2ps,
  85     to use your locally installed PostScript utilities.
  86
  87 4.  Add the contents of services.atalk to your /etc/services database.
  88     If you're using NIS (YP), add the contents of services.atalk to the
  89     NIS master's maps and push them.
  90
  91 5.  The file rc.atalk is installed in ETCDIR.  It should be called
  92     from your /etc/rc file, e.g. "sh ETCDIR/rc.atalk".  For more
  93     information on what this script does, read the man pages for the
  94     appropriate commands.
  95
  96 You might be interested in looking at the netatalk home page at
  97 http://www.umich.edu/~rsug/netatalk.  It has an archive of patches,
  98 trouble shooting hints, and some links to other netatalk and file
  99 service related sites.
 100
 101 You may report bugs and get help by sending mail to the developers at
 102 netatalk@umich.edu.  If you're reporting bugs, you MUST use the format
 103 provided in the BUGS file!  We will do our best to help you.
 104
 105 You may wish to join the netatalk-admins@umich.edu (moderated) mailing
 106 list.  It carries announcements of new releases and general
 107 discussion.  You can join (or resign from) this list by sending mail to
 108 netatalk-admins-request@umich.edu.  Submissions (NOT requests to join
 109 or resign) to this list should be sent to netatalk-admins@umich.edu.
 110
 111 Research Systems Unix Group
 112 The University of Michigan              netatalk@umich.edu
 113 c/o Wesley Craig                        +1-313-764-2278
 114 535 W. William St.
 115 Ann Arbor, Michigan
 116 48103-4943