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, does not work with 5.1)
  35       i386_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
  36               i386_fbsd_46, i386_fbsd_47, i386_fbsd_50
  37               (gnu make is required for building on FreeBSD)
  38       i386_linux22
  39       i386_linux24
  40       i386_obsd31, i386_obsd32
  41       rs_aix42
  42       sgi_65 (file server not tested)
  43       sun4_413 (No client support, no fileserver support, db servers only)
  44       sun4x_56, sun4x_57, sun4x_58, sun4x_59 (logging UFS not supported
  45               for mixed-use partitions containing client cache)
  46       ppc_darwin_13, ppc_darwin_14, ppc_darwin_60 (file server not tested)
  47       ppc_linux22
  48       ppc_linux24
  49       alpha_linux22
  50       alpha_linux24
  51       ia64_linux24
  52       sparc_linux22
  53       sparc_linux24
  54       sparc64_linux22
  55       sparc64_linux24
  56       hp_ux110 (See notes below for information on getting missing header)
  57       hp_ux102 (Client port possible, but db servers and utilities work)
  58
  59    2. Using configure in the top level directory, configure for your
  60       AFS system type, providing the necessary flags:
  61       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
  62
  63       For Linux systems you need also provide the path in which your
  64       kernel headers for your configured kernel can be found. This should
  65       be the path of the directory containing a child directory named
  66       "include". So if your version file was
  67       /usr/src/linux/include/linux/version.h you would invoke:
  68       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
  69
  70       Currently you can build for only one Linux kernel at a time,
  71       and the version is extracted from the kernel headers in the root
  72       you specify.
  73
  74       Be prepared to provide the switches --enable-obsolete and
  75       --enable-insecure if you require the use of any bundled but obsolete
  76       or insecure software included with OpenAFS. See README.obsolete and
  77       README.insecure for more details.
  78
  79   There are two modes for directory path handling: "Transarc mode" and "default mode":
  80   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
  81     by putting client configuaration files in /usr/vice/etc, and server
  82     files in /usr/afs under the traditional directory layout.
  83   - In default mode, files are located in standardized locations, usually
  84     under $(prefix).
  85   - Client programs, libraries, and related files always go in standard
  86     directories under $(prefix).  This rule covers things that would go
  87     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
  88   - Other files get located in the following places:
  89
  90     Directory     Transarc Mode              Default Mode
  91     ============  =========================  ==============================
  92     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
  93     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
  94     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
  95     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
  96     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
  97     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
  98     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
  99     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
 100
 101
 102 B  Building
 103
 104    1. Now, you can build OpenAFS.
 105
 106       % make
 107
 108    2. Install your build using either "make install" to install
 109       into the current system (you will need to be root, and files
 110       will be placed as appropriate for Transarc or standard paths),
 111       "make install DESTDIR=/some/path" to install into an alternate
 112       directory tree, or if you configured with --enable-transarc-paths
 113       make dest to create a complete binary tree in the dest directory
 114       under the directory named for the sys_name you built for,
 115       e.g. sun4x_57/dest or i386_linux22/dest
 116
 117    2. As appropriate you can clean up or, if you're using Linux, build for
 118       another kernel version:
 119       a. To clean up:
 120          % make clean
 121
 122       b. To build for another Linux kernel version:
 123          the system type defined in step A1.
 124          % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
 125          % make
 126
 127          Your dest tree will now include an additional kernel module for your
 128          additional kernel headers. Be aware that if the kernel version string
 129          which UTS_RELEASE is defined to in include/linux/version.h matches
 130          the last kernel you built for, the previous kernel module will be
 131          overwritten.
 132
 133 C  Problems
 134    If you have a problem building this source, you may want to visit
 135    http://www.openafs.org/ to see if any problems have been reported
 136    or to find out how to get more help.
 137
 138    Mailing lists have been set up to help; More details can be found
 139    on the openafs.org site.
 140
 141 D Notes
 142    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
 143    web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
 144    To navigate down from the top level of the portal, one would do
 145
 146         www.hp.com/dspp -> i want to... -> download software -> operating systems
 147
 148    to get to the same page.