doc: add section on direct volume access
authorKen Dreyer <kdreyer@usgs.gov>
Fri, 10 Feb 2012 00:37:01 +0000 (17:37 -0700)
committerJeffrey Altman <jaltman@secure-endpoints.com>
Sat, 11 Feb 2012 22:16:22 +0000 (14:16 -0800)
Provide examples of the direct volume access syntax, using the
fictitious example.com cell.

Change-Id: Ia2ea592531e29f6b744d0bd6993d598d78a799c4
Reviewed-on: http://gerrit.openafs.org/6691
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>

doc/xml/AdminGuide/auagd010.xml

index 7e68e18..e6457e2 100644 (file)
         </listitem>
       </orderedlist>
     </sect2>
+
+    <sect2>
+      <title>To access volumes directly by volume ID</title>
+
+      <indexterm>
+        <primary>volume</primary>
+
+        <secondary>direct access</secondary>
+      </indexterm>
+
+      <para>You can directly access volumes by volume IDs. This is only
+      recommended for temporary access to a volume. For example, if you
+      have recently restored a volume from a backup, you can use this
+      syntax to quickly access the volume without mounting it.</para>
+      <para>Examples:</para>
+      <itemizedlist>
+          <listitem>
+           <para><emphasis role="bold">Windows:</emphasis>
+            \\afs\example.com#root.cell</para>
+          <listitem>
+          <listitem>
+           <para><emphasis role="bold">Unix:</emphasis>
+            /afs/.:mount/example.com#root.cell</para>
+          <listitem>
+      </itemizedlist>
+    </sect2>
   </sect1>
 
   <sect1 id="HDRWQ216">