Update NEWS file with important changes in 1.2.5 release.
[openafs.git] / README
diff --git a/README b/README
index 7646e1e..44ed3d5 100644 (file)
--- a/README
+++ b/README
@@ -5,6 +5,18 @@ This software has been released under the terms of the IBM Public
 License.  For details, see the LICENSE file in the top-level source
 directory or online at http://www.openafs.org/dl/license10.html
 
+Short instructions for sites upgrading from a previous version of AFS:
+% ./configure --enable-transarc-paths
+% make
+% make dest
+
+will create a Transarc-style dest tree in ${SYS_NAME}/dest where
+${SYS_NAME} is the AFS sysname of the system you built for.
+This assumes if you're building for Linux that your kernel source is
+in /usr/src/linux.
+
+Otherwise, please read on.
+
 Building OpenAFS on UNIX and LINUX
 ----------------------------------
 
@@ -27,6 +39,7 @@ A. Creating the proper directory structure.
       sun4x_56
       sun4x_57
       sun4x_58
+      sun4x_59
       ppc_darwin_13
       ppc_linux22
       ppc_linux24
@@ -37,9 +50,9 @@ A. Creating the proper directory structure.
 
    2. Using configure in the top level directory, configure for your
       AFS system type, providing the necessary flags:
-      % ./configure --with-afs-sysname=sun4x_58
+      % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
 
-      For Linux systems you need also provide the patch in which your
+      For Linux systems you need also provide the path in which your
       kernel headers for your configured kernel can be found. This should
       be the path of the directory containing a child directory named
       "include". So if your version file was 
@@ -55,15 +68,43 @@ A. Creating the proper directory structure.
       or insecure software included with OpenAFS. See README.obsolete and
       README.insecure for more details.
 
+  There are two modes for directory path handling: "Transarc mode" and "default mode":
+  - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
+    by putting client configuaration files in /usr/vice/etc, and server
+    files in /usr/afs under the traditional directory layout.
+  - In default mode, files are located in standardized locations, usually
+    under $(prefix).
+  - Client programs, libraries, and related files always go in standard
+    directories under $(prefix).  This rule covers things that would go
+    into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
+  - Other files get located in the following places:
+
+    Directory     Transarc Mode              Default Mode
+    ============  =========================  ==============================
+    viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
+    afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
+    afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
+    afslocaldir   /usr/afs/local             $(localstatedir)/openafs
+    afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
+    afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
+    afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
+    afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
+
+
 B  Building
 
    1. Now, you can build OpenAFS. 
 
       % make
 
-      When the build completes, you will have a complete binary tree
-      in the dest directory under the directory named for the sys_name you
-      built for, e.g. sun4x_57/dest or i386_linux22/dest 
+   2. Install your build using either "make install" to install 
+      into the current system (you will need to be root, and files
+      will be placed as appropriate for Transarc or standard paths),
+      "make install DESTDIR=/some/path" to install into an alternate 
+      directory tree, or if you configured with --enable-transarc-paths
+      make dest to create a complete binary tree in the dest directory      
+      under the directory named for the sys_name you built for,
+      e.g. sun4x_57/dest or i386_linux22/dest 
 
    2. As appropriate you can clean up or, if you're using Linux, build for
       another kernel version: