doc: fs examine no longer requires read rights on the volume root vnode
[openafs.git] / doc / man-pages / pod1 / fs_examine.pod
index bf66748..0df4c32 100644 (file)
@@ -1,18 +1,24 @@
 =head1 NAME
 
-fs examine - Shows data about the volume containing a directory or file
+fs_examine - Shows data about the volume containing a directory or file
 
 =head1 SYNOPSIS
 
-B<fs examine> [B<-path> <I<dir/file path>>+] [B<-help>]
+=for html
+<div class="synopsis">
 
-B<fs exa> [B<-p> <I<dir/file path>>+] [B<-h>] 
+B<fs examine> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
 
-B<fs listvol> [B<-p> <I<dir/file path>>+] [B<-h>] 
+B<fs exa> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
 
-B<fs listv> [B<-p> <I<dir/file path>>+] [B<-h>] 
+B<fs listvol> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
 
-B<fs lv> [B<-p> <I<dir/file path>>+] [B<-h>]
+B<fs listv> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+
+B<fs lv> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
@@ -94,18 +100,16 @@ in kilobytes.
 The following example shows the output for the volume C<user.smith> and
 the partition housing it:
 
-   % fs examine -path /afs/abc.com/usr/smith
+   % fs examine -path /afs/example.com/usr/smith
    Volume status for vid = 50489902 named user.smith
    Current maximum quota is 15000
    Current blocks used are 5073
-   The partition has 336662 blocks available out of 4177920 
+   The partition has 336662 blocks available out of 4177920
 
 =head1 PRIVILEGE REQUIRED
 
-The issuer must have the C<l> (lookup) permission on the ACL of the root
-directory of the volume that houses the file or directory named by the
-B<-path> argument, and on the ACL of each directory that precedes it in
-the pathname.
+The issuer must have the C<l> (list) permission on the ACL of each directory
+that precedes the file or directory named by the B<-path> argument.
 
 =head1 SEE ALSO