DEVEL15-remove-administration-reference-20080627
[openafs.git] / README
diff --git a/README b/README
index 2491c1e..862de41 100644 (file)
--- a/README
+++ b/README
@@ -34,15 +34,17 @@ A. Creating the proper directory structure.
       alpha_dux50 (only tested on 5.0A, does not work with 5.1)
       i386_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
          i386_fbsd_46, i386_fbsd_47, i386_fbsd_50, i386_fbsd_51,
-         i386_fbsd_52, i386_fbsd_53, i386_fbsd_60
+         i386_fbsd_52, i386_fbsd_53, i386_fbsd_60, i386_fbsd_61
+         (client does not work)
       i386_linux22, i386_linux24, i386_linux26
       i386_umlinux22, i386_umlinux24
       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
-         i386_obsd36, i386_obsd37, i386_obsd38
+         i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39
       rs_aix42
       sgi_65 (file server not tested)
       sun4_413 (No client support, no fileserver support, db servers only)
-      sun4x_56, sun4x_57, sun4x_58, sun4x_59 (logging UFS not supported 
+      sun4x_56, sun4x_57, sun4x_58, sun4x_59, sun4x_510,
+      sunx86_57, sunx86_58, sunx86_59, sunx86_510 (logging UFS not supported 
          for mixed-use partitions containing client cache)
       ppc_darwin_70
       ppc_linux22, ppc_linux24
@@ -50,21 +52,44 @@ A. Creating the proper directory structure.
       ia64_linux24, ia64_linux26
       sparc_linux22, sparc_linux24
       sparc64_linux22, sparc64_linux24
-      hp_ux110 (See notes below for information on getting missing header)
+      hp_ux11i, hp_ux110 (See notes below for information on getting 
+         missing header)
       hp_ux102 (Client port possible, but db servers and utilities work)
 
    2. Using configure in the top level directory, configure for your
       AFS system type, providing the necessary flags:
       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
 
+      If you do not have the "configure" script you can re-create it by
+      running regen.sh.  You will need autoconf to do this.
+
       For some systems you need also provide the path in which your kernel
       headers for your configured kernel can be found.  See the
       system-specific Notes sections below for details.
 
-      Be prepared to provide the switches --enable-obsolete and
-      --enable-insecure if you require the use of any bundled but obsolete
-      or insecure software included with OpenAFS. See README.obsolete and
-      README.insecure for more details.
+      There is an option to control whether or not binaries are stripped
+      of their symbol table information.  All binaries, except for the
+      'fileserver' and 'volserver' executables, are stripped by default.
+
+      To prevent stripping, specify the '--disable-strip-binaries' option on
+      the ./configure command line.
+
+      This option works alongside the existing --enable-debug option to
+      control how binaries are produced.  When --enable-debug is specified,
+      binaries will not be stripped.  This behavior can be modified by
+      using different combinations of --enable-debug and --enable (or
+      --disable)-strip-binaries.  One can, for example, compile binaries for
+      debug and strip them anyway.  Alternatively, one can compile without
+      debug and force the binaries to not be stripped.  Note that these
+      combinations are not necessarily useful.
+
+      If neither of these options is specified, the default will be to build
+      non-debug binaries that are stripped (with the exceptions noted above,
+      which are never stripped at present).  Specifying --enable-debug also
+      turns on --disable-strip-binaries.  These are the most useful settings.
+
+      The two binaries noted above, 'fileserver' and 'volserver' will never
+      be stripped, regardless of any options given to configure.
 
   There are two modes for directory path handling: "Transarc mode" and "default mode":
   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
@@ -89,6 +114,13 @@ A. Creating the proper directory structure.
     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
 
 
+    The Demand Attach Fileserver (DAFS), is built by providing the
+    --enable_demand_attach_fs argument to configure.  Note that the
+    bosserver must be built with DAFS in order to be able to create
+    the dafs instance, which will be used in place of the fs instance.  In
+    addition, the fileserver, volserver, salvager, salvage, and salvageserver
+    binaries must be built for DAFS.
+
 B  Building
 
    1. Now, you can build OpenAFS. 
@@ -154,21 +186,21 @@ E  HP-UX 11.0 Notes
 
 F  OpenBSD Notes
 
-   We recommend you build with --enable-namei-fileserver and
-   --enable-largefile-fileserver options.
+   If you need to run regen.sh to make the configure script, you should
+   first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
 
    You need kernel source installed to build OpenAFS.  Use the
    --with-bsd-kernel-headers= configure option if your kernel source is not
    in /usr/src/sys.
 
-   There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
-   should make a package for the client.  Use pkg_add to install.  The
-   package will install using transarc-paths, regardless of how you
-   configured.  The package builder does not work on OpenBSD 3.5 and later
-   due to the incompatible re-write of pkg_create.
+   If you want to build src/aklog, add the following options to your
+   configure.  Note that you shouldn't need aklog because heimdal afslog
+   does (almost) the same thing.
+     --with-krb5 KRB5CFLAGS=-I/usr/include/kerberosV KRB5LIBS=-lcrypto
 
-   There is no server package, but I am told that "make install" will put
-   server binaries in /usr/afs.
+   src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing the
+   client.  There is no server package, but I am told that "make install"
+   will put server binaries in /usr/afs.
 
    Your kernel may panic when you try to shutdown after running the OpenAFS
    client.  To prevent this, change the "dangling vnode" panic in
@@ -178,11 +210,9 @@ F  OpenBSD Notes
 
 G  FreeBSD Notes
 
-   The FreeBSD client is very new and untested.  Do not trust it for
-   production work.
-
-   We recommend you build with --enable-namei-fileserver and
-   --enable-largefile-fileserver options.
+   The FreeBSD client does not currently work.  The remaining problems
+   mostly have to do with locking, vnode refcounting, and packaging.  The
+   server should work.
 
    You need kernel source installed to build OpenAFS.  Use the
    --with-bsd-kernel-headers= configure option if your kernel source is not
@@ -192,12 +222,7 @@ G  FreeBSD Notes
    include file.  Use the --with-bsd-kernel-build= configure option if your
    kernel build is not GENERIC in the standard place.
 
-   There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
-   should make a package for the client.  Use pkg_add to install.  The
-   package will install using transarc-paths, regardless of how you
-   configured.  The builder uses an old version of the /usr/vice/etc/rc file
-   that probably won't work.  You might be able to replace it with something
-   like "kldload libafs.ko; /usr/vice/etc/afsd".
-
    There is no server package, but I am told that "make install" will put
    server binaries in /usr/afs.
+
+   You can't run arla and OpenAFS at the same time.