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