DOC: afsd man page: give an example of the direct volume mount syntax
authorJason Edgecombe <jason@rampaginggeek.com>
Fri, 27 Sep 2013 02:07:39 +0000 (22:07 -0400)
committerDerrick Brashear <shadow@your-file-system.com>
Mon, 30 Sep 2013 14:50:00 +0000 (07:50 -0700)
The syntax is a little confusing, so an example is needed to clarify it.

Change-Id: I413a5f2af6ccf48e780007c658c35a34384d09e0
Reviewed-on: http://gerrit.openafs.org/10281
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Mark Vitale <mvitale@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>

doc/man-pages/pod8/afsd.pod

index 391a5ad..cb5be31 100644 (file)
@@ -541,10 +541,12 @@ When the dynamic root (B<-dynroot>, B<-dynroot-sparse>) and the fake stat
 provides a special directory named F</afs/.:mount> which allows access to
 volumes by volume name or ID.  The F</afs/.:mount> directory appears to be
 empty, but any name in the form of I<cell>:I<volume> will be resolved as a
-read-write mount point to the specified volume.  This dynamic mount feature is
-recommended only for temporary access to a volume.  Linux-based cache managers
-provide this dynamic mount feature even when dynamic root (B<-dynroot>,
-B<-dynroot-sparse>) is not in effect.
+read-write mount point to the specified volume.  For example, the
+I<user.jdoe> volume in the I<example.com> cell would be accessible at the
+following path: F</afs/.:mount/example.com:user.jdoe>.  This dynamic mount
+feature is recommended only for temporary access to a volume.  Linux-based
+cache managers provide this dynamic mount feature even when dynamic root
+(B<-dynroot>, B<-dynroot-sparse>) is not in effect.
 
 =item B<-dynroot-sparse>