freebsd-20040310
[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 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_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
36               i386_fbsd_46, i386_fbsd_47, i386_fbsd_50, i386_fbsd_51,
37               i386_fbsd_52
38       i386_linux22
39       i386_linux24
40       i386_umlinux22
41       i386_umlinux24
42       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34
43       rs_aix42
44       sgi_65 (file server not tested)
45       sun4_413 (No client support, no fileserver support, db servers only)
46       sun4x_56, sun4x_57, sun4x_58, sun4x_59 (logging UFS not supported 
47               for mixed-use partitions containing client cache)
48       ppc_darwin_13, ppc_darwin_14, ppc_darwin_60 (file server not tested)
49       ppc_linux22
50       ppc_linux24
51       alpha_linux22 
52       alpha_linux24 
53       ia64_linux24
54       sparc_linux22
55       sparc_linux24
56       sparc64_linux22
57       sparc64_linux24
58       hp_ux110 (See notes below for information on getting missing header)
59       hp_ux102 (Client port possible, but db servers and utilities work)
60
61    2. Using configure in the top level directory, configure for your
62       AFS system type, providing the necessary flags:
63       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
64
65       For Linux systems you need also provide the path in which your
66       kernel headers for your configured kernel can be found. This should
67       be the path of the directory containing a child directory named
68       "include". So if your version file was 
69       /usr/src/linux/include/linux/version.h you would invoke:
70       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
71
72       Currently you can build for only one Linux kernel at a time,
73       and the version is extracted from the kernel headers in the root
74       you specify.
75
76       Be prepared to provide the switches --enable-obsolete and
77       --enable-insecure if you require the use of any bundled but obsolete
78       or insecure software included with OpenAFS. See README.obsolete and
79       README.insecure for more details.
80
81   There are two modes for directory path handling: "Transarc mode" and "default mode":
82   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
83     by putting client configuaration files in /usr/vice/etc, and server
84     files in /usr/afs under the traditional directory layout.
85   - In default mode, files are located in standardized locations, usually
86     under $(prefix).
87   - Client programs, libraries, and related files always go in standard
88     directories under $(prefix).  This rule covers things that would go
89     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
90   - Other files get located in the following places:
91
92     Directory     Transarc Mode              Default Mode
93     ============  =========================  ==============================
94     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
95     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
96     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
97     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
98     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
99     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
100     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
101     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
102
103
104 B  Building
105
106    1. Now, you can build OpenAFS. 
107
108       % make
109
110    2. Install your build using either "make install" to install 
111       into the current system (you will need to be root, and files
112       will be placed as appropriate for Transarc or standard paths),
113       "make install DESTDIR=/some/path" to install into an alternate 
114       directory tree, or if you configured with --enable-transarc-paths
115       make dest to create a complete binary tree in the dest directory      
116       under the directory named for the sys_name you built for,
117       e.g. sun4x_57/dest or i386_linux22/dest 
118
119    2. As appropriate you can clean up or, if you're using Linux, build for
120       another kernel version.
121       To clean up:
122          % make clean
123
124 C  Problems
125
126    If you have a problem building this source, you may want to visit
127    http://www.openafs.org/ to see if any problems have been reported 
128    or to find out how to get more help.
129
130    Mailing lists have been set up to help; More details can be found
131    on the openafs.org site.
132
133 D  Linux Notes
134
135    To build for another Linux kernel version:
136    the system type defined in step A1.
137       % ./configure --with-afs-sysname=i386_linux22 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
138       % make 
139
140    Your dest tree will now include an additional kernel module for your
141    additional kernel headers. Be aware that if the kernel version string
142    which UTS_RELEASE is defined to in include/linux/version.h matches the
143    last kernel you built for, the previous kernel module will be
144    overwritten.
145
146 E  HP-UX 11.0 Notes
147
148    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
149    web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
150    To navigate down from the top level of the portal, one would do
151
152         www.hp.com/dspp -> i want to... -> download software -> operating systems
153
154    to get to the same page. 
155
156 F  OpenBSD Notes
157
158    You need kernel source installed to build OpenAFS.  Use the
159    --with-bsd-kernel-headers= configure option if your kernel source is not
160    in /usr/src/sys.
161
162    There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
163    should make a package for the client.  Use pkg_add to install.  The
164    package will install using transarc-paths, regardless of how you
165    configured.
166
167    There is no server package, but I am told that "make install" will put
168    server binaries in /usr/afs.
169
170    Your kernel may panic when you try to shutdown after running the OpenAFS
171    client.  To prevent this, change the "dangling vnode" panic in
172    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
173
174    You can't run arla and OpenAFS at the same time.
175
176 G  FreeBSD Notes
177
178    The FreeBSD client is very new and untested.  Do not trust it for
179    production work.
180
181    You need kernel source installed to build OpenAFS.  Use the
182    --with-bsd-kernel-headers= configure option if your kernel source is not
183    in /usr/src/sys.
184
185    You also need access to your kernel build directory for the opt_global.h
186    include file.  Use the --with-bsd-kernel-build= configure option if your
187    kernel build is not GENERIC in the standard place.
188
189    There is no client package, but you may be able to modify the OpenBSD
190    package builder (see "OpenBSD Notes" above) or install by hand.
191
192    There is no server package, but I am told that "make install" will put
193    server binaries in /usr/afs.