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       sun4x_59
  43       ppc_darwin_13
  44       ppc_linux22
  45       ppc_linux24
  46       alpha_linux22 (DES does not work, will require one more change to
  47                                 compile)
  48       hp_ux110 (No client support, but db servers and utilities work)
  49       hp_ux102 (No client support, but db servers and utilities work)
  50
  51    2. Using configure in the top level directory, configure for your
  52       AFS system type, providing the necessary flags:
  53       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
  54
  55       For Linux systems you need also provide the path in which your
  56       kernel headers for your configured kernel can be found. This should
  57       be the path of the directory containing a child directory named
  58       "include". So if your version file was
  59       /usr/src/linux/include/linux/version.h you would invoke:
  60       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
  61
  62       Currently you can build for only one Linux kernel at a time,
  63       and the version is extracted from the kernel headers in the root
  64       you specify.
  65
  66       Be prepared to provide the switches --enable-obsolete and
  67       --enable-insecure if you require the use of any bundled but obsolete
  68       or insecure software included with OpenAFS. See README.obsolete and
  69       README.insecure for more details.
  70
  71   There are two modes for directory path handling: "Transarc mode" and "default mode":
  72   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
  73     by putting client configuaration files in /usr/vice/etc, and server
  74     files in /usr/afs under the traditional directory layout.
  75   - In default mode, files are located in standardized locations, usually
  76     under $(prefix).
  77   - Client programs, libraries, and related files always go in standard
  78     directories under $(prefix).  This rule covers things that would go
  79     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
  80   - Other files get located in the following places:
  81
  82     Directory     Transarc Mode              Default Mode
  83     ============  =========================  ==============================
  84     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
  85     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
  86     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
  87     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
  88     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
  89     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
  90     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
  91     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
  92
  93
  94 B  Building
  95
  96    1. Now, you can build OpenAFS.
  97
  98       % make
  99
 100    2. Install your build using either "make install" to install
 101       into the current system (you will need to be root, and files
 102       will be placed as appropriate for Transarc or standard paths),
 103       "make install DESTDIR=/some/path" to install into an alternate
 104       directory tree, or if you configured with --enable-transarc-paths
 105       make dest to create a complete binary tree in the dest directory
 106       under the directory named for the sys_name you built for,
 107       e.g. sun4x_57/dest or i386_linux22/dest
 108
 109    2. As appropriate you can clean up or, if you're using Linux, build for
 110       another kernel version:
 111       a. To clean up:
 112          % make clean
 113
 114       b. To build for another Linux kernel version:
 115          the system type defined in step A1.
 116          % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
 117          % make
 118
 119          Your dest tree will now include an additional kernel module for your
 120          additional kernel headers. Be aware that if the kernel version string
 121          which UTS_RELEASE is defined to in include/linux/version.h matches
 122          the last kernel you built for, the previous kernel module will be
 123          overwritten.
 124
 125 C  Problems
 126    If you have a problem building this source, you may want to visit
 127    http://www.openafs.org/ to see if any problems have been reported
 128    or to find out how to get more help.
 129
 130    Mailing lists have been set up to help; More details can be found
 131    on the openafs.org site.
 132