X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README;h=0c228113a530150d25381c0bb83a9b42c4321646;hb=e41db248e35ef1cc583915f09131422b217b94e8;hp=dc45514bc3e5cc7f649b3d61bd1d46a209f6d999;hpb=6c15b98e2feddcb89b32800ecb1500b462bf6b98;p=netatalk.git diff --git a/README b/README index dc45514b..0c228113 100644 --- a/README +++ b/README @@ -1,149 +1,16 @@ -$Id: README,v 1.4 2001-02-27 14:23:24 rufustfirefly Exp $ - -This is the README file for netatalk. - -Contents: - o A Brief Description - o Building & Installing - o Getting Help - -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. - -netatalk runs on five operating systems: - - OS Versions Hardware Notes - -- -------- -------- ----- - Solaris 2.5 Sparc - Linux 1.3.x,2.x PC - FreeBSD 2.2-current PC after 12 Sept 96 - SunOS 4.1+ Sparc kernel must have VDDRV - option installed - Ultrix 4.[1-4] 3100,5000 - -Instructions for installing the kernel portions of netatalk and system -dependent FAQs are in the README file for your system, e.g. -INSTALL/README.SUNOS, INSTALL/README.ULTRIX. - -Building netatalk (versions up to 1.4b2+asun2.1.4): - -0. To build afpd for use with an AFS filesystem, first follow the - instructions in INSTALL/README.AFS, then complete these - instructions. - -1. Set DESTDIR in the root Makefile. DESTDIR is the directory below - which all binaries will be installed. Setting it causes all - installation-relative pathnames to be set correctly. You may also - wish to set MANDIR. (If you do not want all binaries to go under - DESTDIR, you can instead set SBINDIR, BINDIR, ETCDIR, and LIBDIR, - to control the locations of the individual sections.) - -2. When you've completed the configuration, type "make" at the root of - the source. This will make all binaries. - -Building netatalk (1.5 and up): - -0. Be sure to have the following utilities installed before attemping - to build netatalk (*=required, +=optional): - * GNU autoconf - * GNU automake - * GNU libtool - * GCC or another ANSI C compliant compiler - + OpenSSL or another SSL library to enable crypto support - + tcp_wrappers to enable IP filtering support - -1. Run "./configure --help" to give a list of all of the available - configuration options. You can then use "./configure (options)" to - generate the build structure for netatalk. This system will - automatically determine many things about your system to aid in the - build process. - -2. Type "make all" at the root of the source to build everything. - -Installing netatalk (versions up to 1.4b2+asun2.1.4): - -1. To install the binaries, type "make install" at the root of the - source tree. This will install all of the binaries. - -2. Sample config files for the daemons are in the config directory, - e.g. config/AppleVolumes.system. Install these files, or a version - of these files, in ETCDIR (as distributed DESTDIR/etc), e.g. - ETCDIR/AppleVolumes.system. See the daemon's man page for a - description of it's configuration file. - -3. psf uses the script SBINDIR/etc2ps to convert anything it - doesn't understand to PostScript. If you have a troff or dvi to - PostScript filter on your machine, you might wish to edit etc2ps, - to use your locally installed PostScript utilities. - -4. Add the contents of services.atalk to your /etc/services database. - If you're using NIS (YP), add the contents of services.atalk to the - NIS master's maps and push them. - -5. The file rc.atalk is installed in ETCDIR. It should be called - from your /etc/rc file, e.g. "sh ETCDIR/rc.atalk". For more - information on what this script does, read the man pages for the - appropriate commands. - -Installing netatalk (1.5 and up): - -1. Type "make install" or "make install-strip" to install binaries on - the system. To install in a "fake" tree (like installing all /etc - files in /var/tmp/tree/etc and all /usr files in /var/tmp/tree/usr), - use "make DESTDIR=(path) install" or "make DESTDIR=(path) install-strip". - -Please read the FAQ for netatalk if you are having problems - -You might be interested in looking at the netatalk home page at -http://www.umich.edu/~rsug/netatalk, which contains netatalk information -up to version 1.4b2. It has an archive of patches, trouble shooting -hints, and some links to other netatalk and file service related sites. -For more recent information on netatalk, visit the homepage at -http://netatalk.sourceforge.net/ - -Development is currently carried out on the netatalk-devel list on -sourceforge (netatalk-devel@lists.sourceforge.net). - -You may wish to join the netatalk-admins@umich.edu (moderated) mailing -list. It carries announcements of new releases and general -discussion. You can join (or resign from) this list by sending mail to -netatalk-admins-request@umich.edu. Submissions (NOT requests to join -or resign) to this list should be sent to netatalk-admins@umich.edu. - -Research Systems Unix Group -The University of Michigan netatalk@umich.edu -c/o Wesley Craig +1-313-764-2278 -535 W. William St. -Ann Arbor, Michigan -48103-4943 - -Amended 07 Feb 2001 jeff b +The documentation for Netatalk is arranged as follows: + +* doc/Netatalk-Manual(.pdf|.txt) + the Netatalk manual +* doc/DEVELOPER + information for developers and additional requirements for compiling +* doc/FAQ + FAQ in progress +* doc/README.platforms + additional instructions for various operating systems. +* doc/README.hidden-items + documents the various special files created by netatalk in file shares + +This should be all you need to get netatalk running. + + - The Netatalk Team