Add DAFS docs to the Unix Quick Start guide

[openafs.git] / doc / xml / QuickStartUnix / auqbg005.xml

diff --git a/doc/xml/QuickStartUnix/auqbg005.xml b/doc/xml/QuickStartUnix/auqbg005.xml
index 418e917..48fe317 100644 (file)
--- a/doc/xml/QuickStartUnix/auqbg005.xml
+++ b/doc/xml/QuickStartUnix/auqbg005.xml
@@ -3677,18 +3677,42 @@ Entry for principal afs/&lt;<replaceable>cell name</replaceable>&gt; with kvno 3
   </sect1>
 
   <sect1 id="HDRWQ60">
-    <title>Starting the File Server, Volume Server, and Salvager</title>
-
-    <para>Start the <emphasis role="bold">fs</emphasis> process, which consists of the File Server, Volume Server, and Salvager
-    (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and <emphasis
-    role="bold">salvager</emphasis> processes). <orderedlist>
+    <title>Starting the File Server processes</title>
+
+    <para>Start either the <emphasis role="bold">fs</emphasis> process or, if you want to run the Demand-Attach File Server, the
+    <emphasis role="bold">dafs</emphasis> process. The <emphasis role="bold">fs</emphasis> process consists of the File Server,
+    Volume Server, and Salvager (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and
+    <emphasis role="bold">salvager</emphasis> processes). The <emphasis role="bold">dafs</emphasis> process consists of the
+    Demand-Attach File Server, Volume Server, Salvage Server, and Salvager (<emphasis role="bold">dafileserver</emphasis>,
+    <emphasis role="bold"> davolserver</emphasis>, <emphasis role="bold">salvageserver</emphasis>, and <emphasis
+    role="bold">dasalvager</emphasis> processes). For information about the Demand-Attach File Server and to see whether or not
+    you should run it, see <link linkend="DAFS">Appendix C, The Demand-Attach File Server</link>.
+     <orderedlist>
         <listitem>
           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">fs</emphasis>
-          process. The command appears here on multiple lines only for legibility. <programlisting>
+          process or the <emphasis role="bold">dafs</emphasis> process. The commands appear here on multiple lines only for legibility.
+
+           <itemizedlist>
+             <listitem>
+               <para>If you are not planning on running the Demand-Attach File Server, create the <emphasis role="bold">fs</emphasis>
+               process:
+                 <programlisting>
    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/fileserver</emphasis>   \
                    <emphasis role="bold">/usr/afs/bin/volserver /usr/afs/bin/salvager</emphasis>  \
                    <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>   
 </programlisting></para>
+             </listitem>
+            <listitem>
+              <para>If you are planning on running the Demand-Attach File Server, create the <emphasis
+              role="bold">dafs</emphasis> process:
+                 <programlisting>
+   # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/dafileserver</emphasis>   \
+                   <emphasis role="bold">/usr/afs/bin/davolserver /usr/afs/bin/salvageserver</emphasis> \
+                   <emphasis role="bold">/usr/afs/bin/salvager -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>   
+</programlisting></para>
+             </listitem>
+           </itemizedlist>
+          </para>
 
           <para>Sometimes a message about Volume Location Database (VLDB) initialization appears, along with one or more instances
           of an error message similar to the following:</para>
@@ -3709,13 +3733,25 @@ Entry for principal afs/&lt;<replaceable>cell name</replaceable>&gt; with kvno 3
               <secondary>status</secondary>
             </indexterm></para>
 
-          <para>You can verify that the <emphasis role="bold">fs</emphasis> process has started successfully by issuing the
-          <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
+          <para>You can verify that the <emphasis role="bold">fs</emphasis> or <emphasis role="bold">dafs</emphasis> process has started
+         successfully by issuing the <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
           starts</computeroutput>.</para>
 
+         <itemizedlist>
+           <listitem>
+             <para>If you are not running the Demand-Attach File Server:
+
           <programlisting>
    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs -long -noauth</emphasis>
-</programlisting>
+</programlisting></para></listitem>
+
+            <listitem>
+             <para>If you are running the Demand-Attach File Server:
+          <programlisting>
+   # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs -long -noauth</emphasis>
+</programlisting></para></listitem>
+          </itemizedlist>
+
         </listitem>
 
         <listitem>
@@ -5402,6 +5438,14 @@ and so may already be available at your site.</para>
           role="bold">system:administrators</emphasis> group. It is a default entry that AFS places on every new volume's root
           directory.</para>
 
+         <para>The top-level AFS directory, typically /afs, is a special case:
+           when the client is configured to run in dynroot mode (e.g. 
+           <emphasis role="bold">afsd -dynroot</emphasis>, attempts to set
+           the ACL on this directory will return <emphasis role="bold">
+             Connection timed out</emphasis>. This is because the dynamically-
+           generated root directory is not a part of the global AFS space,
+           and cannot have an access control list set on it.</para>
+
           <programlisting>
    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs system:anyuser rl</emphasis>
 </programlisting>