move-readmes-one-level-up-20010716
[openafs.git] / 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 Building OpenAFS on UNIX and LINUX
9 ----------------------------------
10
11 A. Creating the proper directory structure.
12
13    Uncompress the source into a directory of your choice. A directory
14    in afs space is also valid. In the directory that you uncompressed the
15    source in, you will only have an src/ directory.
16
17    1. Pick a system to build for, and note its default AFS sys_name.
18       A directory will be automatically created for binaries to be written 
19       into with this name when you build.
20
21       alpha_dux40
22       alpha_dux50 (only tested on 5.0A)
23       i386_linux22
24       i386_linux24 (only tested with 2.4.0 kernel)
25       rs_aix42
26       sgi_65 (file server not tested)
27       sun4x_56
28       sun4x_57
29       sun4x_58
30       ppc_darwin_13
31       alpha_linux_22 (DES does not work, will require one more change to
32                                 compile)
33       hp_ux110 (No client support, but db servers and utilities work)
34       hp_ux102 (No client support, but db servers and utilities work)
35
36    2. Using configure in the top level directory, configure for your
37       AFS system type, providing the necessary flags:
38       % ./configure --with-afs-sysname=sun4x_58
39
40       For Linux systems you need also provide the patch in which your
41       kernel headers for your configured kernel can be found. This should
42       be the path of the directory containing a child directory named
43       "include". So if your version file was 
44       /usr/src/linux/include/linux/version.h you would invoke:
45       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
46
47       Currently you can build for only one Linux kernel at a time,
48       and the version is extracted from the kernel headers in the root
49       you specify.
50
51       Be prepared to provide the switches --enable-obsolete and
52       --enable-insecure if you require the use of any bundled but obsolete
53       or insecure software included with OpenAFS. See README.obsolete and
54       README.insecure for more details.
55
56 B  Building
57
58    1. Now, you can build OpenAFS. 
59
60       % make
61
62       When the build completes, you will have a complete binary tree
63       in the dest directory under the directory named for the sys_name you
64       built for, e.g. sun4x_57/dest or i386_linux22/dest 
65
66    2. As appropriate you can clean up or, if you're using Linux, build for
67       another kernel version:
68       a. To clean up:
69          % make clean
70
71       b. To build for another Linux kernel version:
72          the system type defined in step A1.
73          % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
74          % make 
75
76          Your dest tree will now include an additional kernel module for your
77          additional kernel headers. Be aware that if the kernel version string
78          which UTS_RELEASE is defined to in include/linux/version.h matches
79          the last kernel you built for, the previous kernel module will be 
80          overwritten.
81
82 C  Problems
83    If you have a problem building this source, you may want to visit
84    http://www.openafs.org/ to see if any problems have been reported 
85    or to find out how to get more help.
86
87    Mailing lists have been set up to help; More details can be found
88    on the openafs.org site.
89