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