b71fbadfd1a31ff8afb54a0679fdc1e031598d6e
[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       ppc_linux22
32       ppc_linux24
33       alpha_linux22 (DES does not work, will require one more change to
34                                 compile)
35       hp_ux110 (No client support, but db servers and utilities work)
36       hp_ux102 (No client support, but db servers and utilities work)
37
38    2. Using configure in the top level directory, configure for your
39       AFS system type, providing the necessary flags:
40       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
41
42       For Linux systems you need also provide the path in which your
43       kernel headers for your configured kernel can be found. This should
44       be the path of the directory containing a child directory named
45       "include". So if your version file was 
46       /usr/src/linux/include/linux/version.h you would invoke:
47       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
48
49       Currently you can build for only one Linux kernel at a time,
50       and the version is extracted from the kernel headers in the root
51       you specify.
52
53       Be prepared to provide the switches --enable-obsolete and
54       --enable-insecure if you require the use of any bundled but obsolete
55       or insecure software included with OpenAFS. See README.obsolete and
56       README.insecure for more details.
57
58   There are two modes for directory path handling: "Transarc mode" and "default mode":
59   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
60     by putting client configuaration files in /usr/vice/etc, and server
61     files in /usr/afs under the traditional directory layout.
62   - In default mode, files are located in standardized locations, usually
63     under $(prefix).
64   - Client programs, libraries, and related files always go in standard
65     directories under $(prefix).  This rule covers things that would go
66     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
67   - Other files get located in the following places:
68
69     Directory     Transarc Mode              Default Mode
70     ============  =========================  ==============================
71     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
72     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
73     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
74     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
75     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
76     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
77     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
78     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
79
80
81 B  Building
82
83    1. Now, you can build OpenAFS. 
84
85       % make
86
87       When the build completes, you will have a complete binary tree
88       in the dest directory under the directory named for the sys_name you
89       built for, e.g. sun4x_57/dest or i386_linux22/dest 
90
91    2. As appropriate you can clean up or, if you're using Linux, build for
92       another kernel version:
93       a. To clean up:
94          % make clean
95
96       b. To build for another Linux kernel version:
97          the system type defined in step A1.
98          % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
99          % make 
100
101          Your dest tree will now include an additional kernel module for your
102          additional kernel headers. Be aware that if the kernel version string
103          which UTS_RELEASE is defined to in include/linux/version.h matches
104          the last kernel you built for, the previous kernel module will be 
105          overwritten.
106
107 C  Problems
108    If you have a problem building this source, you may want to visit
109    http://www.openafs.org/ to see if any problems have been reported 
110    or to find out how to get more help.
111
112    Mailing lists have been set up to help; More details can be found
113    on the openafs.org site.
114