zephyr/INSTALL

   1 This file explains how to build and install Zephyr on a machine.  To
   2 learn how to use Zephyr once you've installed it, read the file USING.
   3 To learn how to set up Zephyr service at a site, read the file
   4 OPERATING.
   5
   6 To build and install Zephyr, run:
   7
   8         ./configure
   9         make
  10         make install
  11
  12 This will build Zephyr without Hesiod or Kerberos support, and install
  13 in /usr/local.  To install in a location other than /usr/local, add
  14 "--prefix=INSTPREFIX" to the configure line, where INSTPREFIX is the
  15 directory you want to install Zephyr in.
  16
  17 If your site has a Hesiod service with a valid zephyr.sloc entry (or
  18 you can add one), you can enable Hesiod support by adding the option
  19 "--with-hesiod=HESPREFIX" to the configure line, where
  20 HESPREFIX/include and HESPREFIX/lib are the directories you have the
  21 Hesiod libraries installed in.
  22
  23 If your site has a Kerberos 5 service, you can enable Kerberos 5 support
  24 by adding the option "--with-krb5=KRBPREFIX" to the configure line,
  25 where KRBPREFIX/include and KRBPREFIX/lib are the directories you
  26 have the Kerberos libraries installed in.
  27
  28 If your site has a Kerberos 4 service, you can enable Kerberos 4 support
  29 by adding the option "--with-krb4=KRBPREFIX" to the configure line,
  30 where KRBPREFIX/include and KRBPREFIX/lib are the directories you
  31 have the Kerberos libraries installed in.  Note that this is
  32 deprecated, and should only be enabled for transitions.
  33
  34 If you build with both krb5 and krb4, you will get a client that only
  35 knows how to authenticate with krb5 servers, but a server that can
  36 understand authentication from both krb4 and krb5 clients.
  37
  38 If you want/need a krb4 client, you have to build without krb5.
  39
  40 If you have a make which supports VPATH in a manner compatible with
  41 GNU make, you can build in a separate directory.  Simply invoke the
  42 configure script from within the build directory and configure will
  43 locate the source directory for you.  (If that doesn't work for some
  44 reason, you can also specify "--srcdir=SOURCEDIR" on the configuration
  45 line.)
  46
  47 If configure can't properly find your X11 include or library
  48 directories, add "--x-includes=INCDIR" and "--x-libraries=LIBDIR" to
  49 the configure line.  To build without X11 support, add "--without-x"
  50 to the configure line.
  51
  52 If you have Hesiod and/or Kerberos installed such that you can't
  53 specify a single prefix for both include files and libraries, set the
  54 environment variables CPPFLAGS and LDFLAGS to include the relevant
  55 directories, and just configure with "--with-krb4" and
  56 "--with-hesiod".  For instance (for a csh-like shell):
  57
  58         setenv CPPFLAGS "-I/opt/athena/include"
  59         setenv LDFLAGS "-I/opt/athena/arch/sparc/lib"
  60         ./configure --with-hesiod --with-krb4
  61         make
  62         make install
  63
  64 Although it's not necessary for Zephyr to function correctly, you
  65 should add the following services to /etc/services if possible:
  66
  67 zephyr-clt      2103/udp                        # Zephyr serv-hm connection
  68 zephyr-hm       2104/udp                        # Zephyr hostmanager
  69 zephyr-hm-srv   2105/udp                        # Zephyr hm-serv connection
  70
  71 To learn how to use Zephyr, read the file USING and the man pages for
  72 the various Zephyr programs.  To learn how to operate a Zephyr
  73 service, read the file OPERATING.
  74
  75 We have tried to make Zephyr as portable as is reasonably possible,
  76 but have not taken into account every possible kind of system.  If you
  77 have any problems building or installing Zephyr according to these
  78 instructions, please go to http://zephyr.1ts.org and open a ticket.