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 ----------------------------------
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.
33 alpha_dux40, alpha_dux50, alpha_dux51 (client does not work)
34 alpha_linux22, alpha_linux24, alpha_linux26
35 alpha_nbsd15, alpha_nbsd16
36 amd64_fbsd_53 (client does not work)
37 amd64_linux24, amd64_linux26
38 amd64_nbsd20, amd64_nbsd30, amd64_nbsd40
39 arm_linux24, arm_linux26
40 hp_ux11i, hp_ux110, hp_ux1123 (See notes below for information on
41 getting missing header)
42 hp_ux102 (Client port possible, but db servers and utilities work)
43 i386_fbsd_50, i386_fbsd_51, i386_fbsd_52, i386_fbsd_53,
44 i386_fbsd_60, i386_fbsd_61, i386_fbsd_62, i386_fbsd_70,
45 i386_fbsd_80, i386_fbsd_81, i386_fbsd_90, amd64_fbsd_50,
46 amd64_fbsd_51, amd64_fbsd_52, amd64_fbsd_53, amd64_fbsd_60,
47 amd64_fbsd_61, amd64_fbsd_62, amd64_fbsd_70, amd64_fbsd_80,
48 amd64_fbsd_81, amd64_fbsd_90
49 (client may work on 70 and later)
50 i386_linux22, i386_linux24, i386_linux26
51 i386_nbsd15, i386_nbsd16, i386_nbsd20, i386_nbsd21, i386_nbsd30,
53 i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
54 i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39, i386_obsd40,
56 i386_umlinux22, i386_umlinux24, i386_umlinux26
57 ia64_hpux1122, ia64_hpux1123
58 ia64_linux24, ia64_linux26
60 ppc64_linux24, ppc64_linux26
61 ppc_darwin_12, ppc_darwin_13, ppc_darwin_14, ppc_darwin_60,
62 ppc_darwin_70, ppc_darwin_80, ppc_darwin_90
63 ppc_linux22, ppc_linux24, ppc_linux26
64 ppc_nbsd16, ppc_nbsd20
65 rs_aix42, rs_aix51, rs_aix52, rs_aix53, rs_aix61
66 s390_linux22, s390_linux24, s390_linux26
67 s390x_linux24, s390x_linux26
68 sgi_62, sgi_63, sgi_64, sgi_65 (file server not tested)
69 sparc64_linux22, sparc64_linux24, sparc64_linux26
70 sparc_linux22, sparc_linux24
71 sun4x_58, sun4x_59, sun4x_510, sun4x_511
72 (logging UFS not supported for mixed-use partitions containing
74 sunx86_58, sunx86_59, sunx86_510, sunx86_511
75 (logging UFS not supported for mixed-use partitions containing
77 x86_darwin_80, x86_darwin90
79 2. Using configure in the top level directory, configure for your
80 AFS system type, providing the necessary flags:
82 % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
84 If you do not have the "configure" script, or if you modify the
85 source files, you can re-create it by running regen.sh. You will
86 need autoconf to do this.
88 For some systems you need also provide the path in which your kernel
89 headers for your configured kernel can be found. See the
90 system-specific Notes sections below for details. If you want to
91 build only the user-space programs and servers and not the kernel
92 module, specify the --disable-kernel-module option on the
93 ./configure command line.
95 All binaries, except for the 'fileserver' and 'volserver'
96 executables and their 'da' variants, are stripped of their symbol
97 table information by default. To enable a debugging build, specify
98 the --enable-debug option on the ./configure command line. This
99 builds with debugging compiler options and disables stripping of
102 You can also use different combinations of --enable-debug and
103 --enable (or --disable)-strip-binaries for finer control. One can,
104 for example, compile binaries for debug and strip them anyway.
105 Alternatively, one can compile without debug and force the binaries
106 to not be stripped. Note that these combinations are not
109 The binaries noted above, 'fileserver' and 'volserver' and their
110 'da' variants, will never be stripped, regardless of any options
113 There are two modes for directory path handling: "Transarc mode" and
116 - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
117 by putting client configuration files in /usr/vice/etc, and server
118 files in /usr/afs under the traditional directory layout.
119 - In default mode, files are located in standardized locations, usually
120 under $(prefix), which defaults to /usr/local.
121 - Client programs, libraries, and related files always go in standard
122 directories under $(prefix). This rule covers things that would go
123 into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
124 - Other files get located in the following places:
126 Directory Transarc Mode Default Mode
127 ============ ========================= ==============================
128 viceetcdir /usr/vice/etc $(sysconfdir)/openafs
129 afssrvdir /usr/afs/bin (servers) $(libexecdir)/openafs
130 afsconfdir /usr/afs/etc $(sysconfdir)/openafs/server
131 afslocaldir /usr/afs/local $(localstatedir)/openafs
132 afsdbdir /usr/afs/db $(localstatedir)/openafs/db
133 afslogdir /usr/afs/logs $(localstatedir)/openafs/logs
134 afsbosconfig $(afslocaldir)/BosConfig $(afsconfdir)/BosConfig
135 afsbosserver $(afsbindir)/bosserver $(sbindir)/bosserver
137 In default mode, you can change all of the variables named above that
138 do not start with "afs" by passing the flags with the same name to
139 configure. For example, if you want to install the server binaries in
140 /usr/local/lib/openafs instead of /usr/local/libexec/openafs, pass the
141 --libexecdir=/usr/local/lib flag to configure.
143 For additional options, see section I below.
147 1. Now, you can build OpenAFS.
151 2. Install your build using either "make install" to install
152 into the current system (you will need to be root, and files
153 will be placed as appropriate for Transarc or standard paths),
154 "make install DESTDIR=/some/path" to install into an alternate
155 directory tree, or if you configured with --enable-transarc-paths
156 make dest to create a complete binary tree in the dest directory
157 under the directory named for the sys_name you built for,
158 e.g. sun4x_57/dest or i386_linux22/dest
160 3. As appropriate you can clean up or, if you're using Linux, build for
161 another kernel version.
169 If you have a problem building this source, you may want to visit
170 http://www.openafs.org/ to see if any problems have been reported
171 or to find out how to get more help.
173 Mailing lists have been set up to help; More details can be found
174 on the openafs.org site.
178 With current Linux versions, the /lib/modules/`uname -r`/source symlink
179 will be used to locate the kernel headers, but you will need to have
180 the headers and build system for your kernel installed in order to
181 build the kernel module. These are usually found in a separate package
182 from the kernel, often called something like linux-headers-<version>.
184 For older Linux systems, you may also need to provide the path in which
185 your kernel headers for your configured kernel can be found. This
186 should be the path of the directory containing a child directory named
187 "include". So if your version file were
188 /usr/src/linux/include/linux/version.h you would run:
190 % ./configure --with-afs-sysname=i386_linux24 \
191 --with-linux-kernel-headers=/usr/src/linux
193 Currently you can build for only one Linux kernel at a time, and the
194 version is extracted from the kernel headers in the root you specify.
196 To build for another Linux kernel version, determine the sysname for
197 the system type as defined in step A1 for the other kernel version and
200 % ./configure --with-afs-sysname=<sysname> \
201 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
204 Your build tree will now include an additional kernel module for your
205 additional kernel headers. Be aware that if the kernel version string
206 which UTS_RELEASE is defined to in include/linux/version.h matches the
207 last kernel you built for, the previous kernel module will be
212 HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on
213 their web site. Go to http://www.hp.com/dspp, choose Software
214 downloads from the side menu, and select Software: HP operating systems
215 and then Operating systems: HP-UX from the select boxes. The last
216 select box will have an option for downloading vfs_vm.h.
220 If you need to run regen.sh to make the configure script, you should
221 first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
223 You need kernel source installed to build OpenAFS. Use the
224 --with-bsd-kernel-headers= configure option if your kernel source is
227 src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing
228 the client. There is no server package, but I am told that "make
229 install" will put server binaries in /usr/afs.
231 Your kernel may panic when you try to shutdown after running the
232 OpenAFS client. To prevent this, change the "dangling vnode" panic in
233 sys/kern/vfs_syscalls.c to a printf and build a new kernel.
235 You can't run arla and OpenAFS at the same time.
239 The FreeBSD client may now work; It is tested on 7.0 and on current
240 as of the commit date.
242 You need kernel source installed to build OpenAFS. Use the
243 --with-bsd-kernel-headers= configure option if your kernel source is
246 You also need access to your kernel build directory for the opt_global.h
247 include file. Use the --with-bsd-kernel-build= configure option if your
248 kernel build is not GENERIC in the standard place. If
249 /usr/src/sys/${CPUARCH}/compile/GENERIC does not point to
250 /usr/obj/usr/src/sys/GENERIC you may need to resolve that and retry the
253 There is no server package, but I am told that "make install" will put
254 server binaries in /usr/afs.
256 You can't run arla and OpenAFS at the same time.
260 Make sure that your default build environment is 32bit, ie.
261 the OBJECT_MODE environment variable is either unset or set to "32".
263 Verify this before doing configure and make. For example, assuming
266 % export OBJECT_MODE=32
268 To build aklog (in order to be able to get tokens from your Kerberos v5
269 ticket), you will need Kerberos libraries. On AIX 6.1, the IBM
270 Kerberos v5 libraries are in the packages krb5.client.rte and
271 krb5.toolkit.adt on the Expansion Pack.
273 I Other configure options
275 AFS has a ton of other optional features that must be enabled using
276 configure options. Here is a summary:
279 --enable-littleendian
280 These configure options are normally not required and should not be
281 given. They're only needed if the OpenAFS build system cannot
282 determine the endianness of your system, in which case configure
283 will abort and say to use one of these options.
285 --enable-bitmap-later
286 Speeds the startup of the fileserver by deferring reading volume
287 bitmaps until necessary. Demand attach is a better solution to the
291 Enable compiler warnings when building with GCC and turn compiler
292 warnings into errors so that new warnings will cause compilation
293 failures. If you are developing patches to contribute to OpenAFS,
294 please build OpenAFS with this flag enabled. Warning-free code is
295 a requirement for all new submissions to OpenAFS.
298 --enable-debug-kernel
301 Compile the userspace code (for --enable-debug) or the code named
302 by the option with debugging information. If --enable-debug is
303 given, also do not strip binaries when installing them.
305 --enable-linux-syscall-probing
306 OpenAFS now uses keyrings to manage PAGs by default on Linux, which
307 does not require hooking into the system call table. On older
308 versions of Linux without keyring support, OpenAFS uses groups to
309 manage PAGs and probes for the system call table to hook into it to
310 preserve that group information. Normally, which method to use is
311 detected automatically, and if keyring support is present, support
312 for system call table probing is not compiled in. Use this
313 configure option to force inclusion of the system call table
314 probing code even if the kernel appears to support keyrings.
316 --enable-namei-fileserver
317 Forces the namei fileserver on platforms (like Solaris 8 and 9)
318 where the inode fileserver is the default.
320 --enable-pthreaded-ubik
321 Enable the threaded version of Ubik and install the threaded
322 versions of Ubik servers. See README.PTHREADED_UBIK for more
323 information. (EXPERIMENTAL)
325 --enable-redhat-buildsys
326 Enable compilation of the kernel module for the Red Hat build
327 system kernel. Use this configure flag when building kernel
328 modules for Red Hat Linux systems.
330 --enable-reduced-depends
331 Try to minimize the shared library dependencies encoded in the
332 binaries. This omits from the link line all the libraries included
333 solely because the Kerberos libraries depend on them and instead
334 links the programs only against libraries whose APIs are called
335 directly. This will only work with shared Kerberos libraries and
336 will only work on platforms where shared libraries properly encode
337 their own dependencies (such as Linux). It is intended primarily
338 for building packages for Linux distributions to avoid encoding
339 unnecessary shared library dependencies that make shared library
340 migrations more difficult. If none of the above made any sense to
341 you, don't bother with this flag.
344 Enables support of nested groups in the ptserver. WARNING: Once
345 you make use of this option by nesting one group inside another,
346 the resulting PTS database cannot be correctly and safely used by a
347 ptserver built without this option. If some of your ptservers were
348 built with this option and some without this option, you will
349 probably corrupt your PTS database.
352 Build with the Tivoli TSM API libraries for butc support of the
353 Tivoli backup system.
355 --enable-transarc-paths
356 As discussed in A2 above, build for the traditional paths used by
357 the Transarc and IBM AFS distributions instead of the more typical
358 open source /usr/local paths. Passing this option to configure and
359 then running make dest will generate, in the dest directory, the
360 set of files and directory layout matching a Transarc or IBM AFS
364 Enable compilation warnings when built with GCC. This is similar
365 to --enable-checking, but new warnings will only be displayed, not
366 cause a build failure.
368 It's also possible to disable some standard features. None of these
369 options are normally needed, but they may be useful in unusual
372 --disable-kernel-module
373 Even if kernel headers are found, do not attempt to build the
374 kernel module. On Linux, if you provide this flag, you'll also
375 need to provide --with-afs-sysname, since OpenAFS cannot determine
376 the correct sysname automatically without the kernel headers.
379 --disable-optimize-kernel
380 --disable-optimize-lwp
381 --disable-optimize-pam
382 Disable optimization for the given portion of the OpenAFS code.
383 Usually used either for debugging to avoid code optimization making
384 it harder to use a debugger, or to work around bugs in the compiler
385 optimizers or in the OpenAFS code.
388 Do not build the AFS PAM modules. Normally building them is
389 harmless, but the PAM modules that come with OpenAFS are deprecated
390 and should not be used unless you're still using the OpenAFS
391 kaserver (which is itself deprecated and should not be used).
393 --disable-strip-binaries
394 Disable stripping of binaries on installation. You probably want
395 to use --enable-debug instead of this flag to also inclusion of
396 debugging information.
398 --disable-unix-sockets
399 Disable use of UNIX domain sockets for fssync. A TCP connection to
400 localhost will be used instead.
402 You may need to pass one or more of the following options to specify
403 paths and locations of files needed by the OpenAFS build process or
404 additional information required by the build process:
406 --with-afs-sysname=SYSNAME
407 Specifies the AFS sysname of the target system is SYSNAME.
408 Normally this is determined automatically from the build
409 architecture plus additional information (such as, on Linux, from
410 the kernel headers). The SYSNAME should be one of the options
414 --with-gssapi-include=DIR
415 --with-gssapi-lib=DIR
417 --with-krb5-include=DIR
419 Normally, OpenAFS will automatically build with Kerberos support if
420 Kerberos is found during the build. If your Kerberos libraries are
421 in an unusual location, however, you may need to pass one or more
422 of these flags. --with-krb5 forces building with Kerberos support
423 if given and will cause configure to fail if Kerberos is not found.
424 You may optionally specify the root path to your Kerberos
425 installation as an argument to --with-krb5.
427 If you have a krb5-config script, it's used to find the flags to
428 build with Kerberos. If you have no krb5-config script, you can
429 specify the location to the include files with --with-krb5-include
430 and the libraries with --with-krb5-lib. You may need to do this if
431 Autoconf can't figure out whether to use lib, lib32, or lib64 on
434 --with-gssapi is similar, except for the GSS-API libraries instead
435 of the Kerberos libraries. If you have to manually set the
436 location of the Kerberos libraries, you may need to do the same
437 thing for the GSS-API libraries.
440 --with-libintl-include=DIR
441 --with-libintl-lib=DIR
442 Specifies the install location of the libintl library, used for
443 internationalization, or separately specifies the location of the
444 header files and libraries. By default, the default system library
445 paths will be searched. This library is not required on many
449 --with-roken=internal
450 Specifies the install location of the libroken library. Specify
451 "internal" to use the embedded libroken library that comes with
452 OpenAFS (the default). This option is primarily useful for
453 building against a system libroken library if you have one.
455 --with-linux-kernel-build=PATH
456 --with-linux-kernel-headers=PATH
457 --with-bsd-kernel-build=PATH
458 --with-bsd-kernel-headers=PATH
459 Specifies the path to the kernel headers and build system. See the
460 information above for Linux and *BSD systems.
462 --with-linux-kernel-packaging
463 Tells the OpenAFS kernel module build system to use conventions
464 appropriate for building modules to include in Linux kernel module
465 packages. Primarily, this renames the kernel module to openafs.ko
466 rather than libafs-<VERSION>.ko, which is easier to handle in Linux
467 distribution init scripts.
469 --with-docbook2pdf=PROGRAM
470 Specifies the program used to convert the DocBook manuals to PDF.
471 Supported choices are fop, dblatex, and docbook2pdf. By default,
472 the user's path is searched for those programs in that order, and
473 the first one found is used.
475 --with-docbook-stylesheets=PATH
476 The location of the DocBook style sheets, used to convert the
477 DocBook manuals to other formats. By default, a set of likely
481 Specifies the XSLT style sheet to convert DocBook manuals into
482 HTML. The default is html/chunk.xsl. You may wish to use
483 html/docbook.xsml instead.
485 --with-xslt-processor=PROGRAM
486 Specifies the XSLT processor to use to convert the DocBook manuals
487 into HTML. Supported choices are libxslt, saxon, xalan-j, and
488 xsltproc. By default, the user's path is searched for those
489 programs in that order, and the first one found is used.
491 There are also some environment variables that you can set to control
492 aspects of the build. They can be set either on the configure command
493 line (preferred) or in the environment.
496 The C compiler to use. Be aware that this is overridden on some
497 architectures that require a specific compiler be used to build the
501 Additional flags to pass to the C compiler.
504 The C preprocessor to use. Defaults to cpp if found, otherwise
508 Additional flags to pass to the C preprocessor or compiler. This
509 is where to put -I options to add paths to the include file search.
512 Compiler flags required for building applications that use FUSE.
515 Libraries required for linking applications that use FUSE.
518 To specify a particular krb5-config script to use, either set the
519 KRB5_CONFIG environment variable or pass it to configure like:
521 ./configure KRB5_CONFIG=/path/to/krb5-config
523 To not use krb5-config and force library probing even if there is a
524 krb5-config script on your path, set KRB5_CONFIG to a nonexistent
527 ./configure KRB5_CONFIG=/nonexistent
530 Additional flags to pass to the linker. This is where to put -L
531 options to add paths to the library search.
534 Additional libraries to link all userspace programs with.
537 The path to the pkg-config utility. Currently, this is only used
538 to locate the flags for building the FUSE version of afsd.
541 The yacc implementation to use. Defaults to bison, byacc, or yacc,
542 whichever is found first.
545 Additional flags to pass to yacc.