afsd -dynroot-sparse mode for hushed cells

[openafs.git] / doc / man-pages / pod8 / afsd.pod

diff --git a/doc/man-pages/pod8/afsd.pod b/doc/man-pages/pod8/afsd.pod
index bacfd7f..c83c6c2 100644 (file)
--- a/doc/man-pages/pod8/afsd.pod
+++ b/doc/man-pages/pod8/afsd.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-afsd - Initializes the Cache Manager and starts related daemons
+afsd, afsd.fuse - Initializes the Cache Manager and starts related daemons
 
 =head1 SYNOPSIS
 
@@ -15,8 +15,8 @@ B<afsd> [B<-afsdb>] [B<-backuptree>]
      S<<< [B<-confdir> <I<configuration directory>>] >>>
      S<<< [B<-daemons> <I<number of daemons to use>>] >>>
      S<<< [B<-dcache> <I<number of dcache entries>>] >>> [B<-debug>]
-     [B<-dynroot>] [B<-enable_peer_stats>] [B<-enable_process_stats>]
-     [B<-fakestat>] [B<-fakestat-all>]
+     [B<-dynroot>] [B<-dynroot-sparse>] [B<-enable_peer_stats>]
+     [B<-enable_process_stats>] [B<-fakestat>] [B<-fakestat-all>]
      S<<< [B<-files> <I<files in cache>>] >>>
      S<<< [B<-files_per_subdir> <I<log(2) of files per dir>> ] >>>
      [B<-help>] S<<< [B<-logfile> <I<Place to keep the CM log>>] >>>
@@ -41,8 +41,11 @@ B<afsd> [B<-afsdb>] [B<-backuptree>]
 
 The B<afsd> command initializes the Cache Manager on an AFS client machine
 by transferring AFS-related configuration information into kernel memory
-and starting several daemons. More specifically, the B<afsd> command
-performs the following actions:
+and starting several daemons. B<afsd.fuse> is an experimental variant that
+inititalizes a FUSE-based Cache Manager instead of one based on a kernel
+module.
+
+The B<afsd> command performs the following actions:
 
 =over 4
 
@@ -349,6 +352,13 @@ If neither argument is used, there are five VM daemons.
 
 =back
 
+B<afsd.fuse> is a variant of B<afsd> that, instead of initializing a Cache
+Manager implemented as a kernel module, initializes a FUSE-based AFS
+client.  FUSE (Filesystem in USErspace) is a Linux-only mechanism for
+providing a file system through a purely user-space daemon without a
+kernel module component.  B<afsd.fuse> takes all of the same options as
+B<afsd>.
+
 This command does not use the syntax conventions of the AFS command
 suites. Provide the command name and all option names in full.
 
@@ -391,6 +401,10 @@ suffice depending on the number of simultaneous B<klog>s).
 Be sure to set the UDP timeouts on the firewall to be at least twenty
 minutes for the best callback performance.
 
+B<afsd.fuse> was first introduced in OpenAFS 1.5.74.  It is only available
+if OpenAFS was built with the C<--enable-fuse-client> configure switch.
+It should be considered experimental.
+
 =head1 OPTIONS
 
 =over 4
@@ -522,6 +536,13 @@ the F<CellAlias> file can be used to provide shortname for common AFS cells
 which provides equivalent functionality to the most commonly used symbolic
 links.
 
+=item B<-dynroot-sparse>
+
+In addition to operating in the manner described for dynroot above,
+cells other than the local cell are not shown by default until a lookup
+occurs. Cell aliases as set in the CellAliases file are shown as normal,
+although they may appear to be dangling links until traversed.
+
 =item B<-enable_peer_stats>
 
 Activates the collection of Rx statistics and allocates memory for their