README

   1 Copyright 2000, International Business Machines Corporation and others.
   2 All Rights Reserved.
   3
   4 This software has been released under the terms of the IBM Public
   5 License.  For details, see the LICENSE file in the top-level source
   6 directory or online at http://www.openafs.org/dl/license10.html
   7
   8 Short instructions for sites upgrading from a previous version of AFS:
   9 % ./configure --enable-transarc-paths
  10 % make
  11 % make dest
  12
  13 will create a Transarc-style dest tree in ${SYS_NAME}/dest where
  14 ${SYS_NAME} is the AFS sysname of the system you built for.
  15 This assumes if you're building for Linux that your kernel source is
  16 in /usr/src/linux.
  17
  18 Otherwise, please read on.
  19
  20 Building OpenAFS on UNIX and LINUX
  21 ----------------------------------
  22
  23 A. Creating the proper directory structure.
  24
  25    Uncompress the source into a directory of your choice. A directory
  26    in afs space is also valid. In the directory that you uncompressed the
  27    source in, you will only have an src/ directory.
  28
  29    1. Pick a system to build for, and note its default AFS sys_name.
  30       A directory will be automatically created for binaries to be written
  31       into with this name when you build.
  32
  33       alpha_dux40
  34       alpha_dux50 (only tested on 5.0A)
  35       i386_linux22
  36       i386_linux24 (only tested with 2.4.0 kernel)
  37       rs_aix42
  38       sgi_65 (file server not tested)
  39       sun4x_56
  40       sun4x_57
  41       sun4x_58
  42       ppc_darwin_13
  43       ppc_linux22
  44       ppc_linux24
  45       alpha_linux22 (DES does not work, will require one more change to
  46                                 compile)
  47       hp_ux110 (No client support, but db servers and utilities work)
  48       hp_ux102 (No client support, but db servers and utilities work)
  49
  50    2. Using configure in the top level directory, configure for your
  51       AFS system type, providing the necessary flags:
  52       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
  53
  54       For Linux systems you need also provide the path in which your
  55       kernel headers for your configured kernel can be found. This should
  56       be the path of the directory containing a child directory named
  57       "include". So if your version file was
  58       /usr/src/linux/include/linux/version.h you would invoke:
  59       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
  60
  61       Currently you can build for only one Linux kernel at a time,
  62       and the version is extracted from the kernel headers in the root
  63       you specify.
  64
  65       Be prepared to provide the switches --enable-obsolete and
  66       --enable-insecure if you require the use of any bundled but obsolete
  67       or insecure software included with OpenAFS. See README.obsolete and
  68       README.insecure for more details.
  69
  70   There are two modes for directory path handling: "Transarc mode" and "default mode":
  71   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
  72     by putting client configuaration files in /usr/vice/etc, and server
  73     files in /usr/afs under the traditional directory layout.
  74   - In default mode, files are located in standardized locations, usually
  75     under $(prefix).
  76   - Client programs, libraries, and related files always go in standard
  77     directories under $(prefix).  This rule covers things that would go
  78     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
  79   - Other files get located in the following places:
  80
  81     Directory     Transarc Mode              Default Mode
  82     ============  =========================  ==============================
  83     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
  84     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
  85     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
  86     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
  87     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
  88     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
  89     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
  90     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
  91
  92
  93 B  Building
  94
  95    1. Now, you can build OpenAFS.
  96
  97       % make
  98
  99    2. Install your build using either "make install" to install
 100       into the current system (you will need to be root, and files
 101       will be placed as appropriate for Transarc or standard paths),
 102       "make install DESTDIR=/some/path" to install into an alternate
 103       directory tree, or if you configured with --enable-transarc-paths
 104       make dest to create a complete binary tree in the dest directory
 105       under the directory named for the sys_name you built for,
 106       e.g. sun4x_57/dest or i386_linux22/dest
 107
 108    2. As appropriate you can clean up or, if you're using Linux, build for
 109       another kernel version:
 110       a. To clean up:
 111          % make clean
 112
 113       b. To build for another Linux kernel version:
 114          the system type defined in step A1.
 115          % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
 116          % make
 117
 118          Your dest tree will now include an additional kernel module for your
 119          additional kernel headers. Be aware that if the kernel version string
 120          which UTS_RELEASE is defined to in include/linux/version.h matches
 121          the last kernel you built for, the previous kernel module will be
 122          overwritten.
 123
 124 C  Problems
 125    If you have a problem building this source, you may want to visit
 126    http://www.openafs.org/ to see if any problems have been reported
 127    or to find out how to get more help.
 128
 129    Mailing lists have been set up to help; More details can be found
 130    on the openafs.org site.
 131