man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / vos_partinfo.pod
index 35d0f3e..9389f48 100644 (file)
@@ -4,86 +4,81 @@ vos partinfo - Reports the available and total space on a partition
 
 =head1 SYNOPSIS
 
-B<vos partinfo -server> <I<machine name>>  [-partition <I<partition name>>] 
-[B<-cell> <I<cell name>>]  [B<-noauth>]  [B<-localauth>]  [B<-verbose>]  [B<-help>]
+B<vos partinfo> B<-server> <I<machine name>>
+    [B<-partition> <I<partition name>>] [B<-cell> <I<cell name>>]
+    [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
 
-B<vos p -s> <I<machine name>>  [B<-p> <I<partition name>>]  [-c <I<cell name>>]  
-[B<-n>]  [B<-l>]  [B<-v>]  [B<-h>]
+B<vos p> B<-s> <I<machine name>> [B<-p> <I<partition name>>]
+    [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-v>] [B<-h>]
 
 =head1 DESCRIPTION
 
-The vos partinfo command reports the amount of space available
-and total size on B<either> all of the partitions on the indicated
-file server machine (if the B<-partition> argument is omitted)
-B<or> the specified partition on that file server machine. The
-Volume Location Database (VLDB) is not consulted.
+The vos partinfo command reports the amount of space available and total
+size on either all of the partitions on the indicated file server machine
+(if the B<-partition> argument is omitted) or the specified partition on
+that file server machine. The Volume Location Database (VLDB) is not
+consulted.
 
 =head1 OPTIONS
 
 =over 4
 
-=item -server
+=item B<-server> <I<server name>>
 
 Identifies the file server machine for which to display partition
-information. Provide the machine's IP address or its host name
-(either fully qualified or using an unambiguous abbreviation). For
-details, see the introductory reference page for the B<vos> command
-suite.
+information. Provide the machine's IP address or its host name (either
+fully qualified or using an unambiguous abbreviation). For details, see
+L<vos(1)>.
 
-=item -partition
+=item B<-partition> <I<partition name>>
 
 Identifies which partition on the file server machine specified by the
-B<-server> argument for which to display information. Provide
-the partition's complete name with preceding slash (for example,
-B</vicepa>) or use one of the three acceptable abbreviated
-forms. For details, see the introductory reference page for the
-B<vos> command suite.
+B<-server> argument for which to display information. Provide the
+partition's complete name with preceding slash (for example, C</vicepa>)
+or use one of the three acceptable abbreviated forms. For details, see
+L<vos(1)>.
 
-=item -cell
+=item B<-cell> <I<cell name>>
 
-Names the cell in which to run the command. Do not combine this
-argument with the B<-localauth> flag. For more details, see the
-introductory B<vos> reference page.
+Names the cell in which to run the command. Do not combine this argument
+with the B<-localauth> flag. For more details, see L<vos(1)>.
 
-=item -noauth
+=item B<-noauth>
 
-Assigns the unprivileged identity anonymous to the
-issuer. Do not combine this flag with the B<-localauth>
-flag. For more details, see the introductory B<vos> reference
-page.
+Assigns the unprivileged identity C<anonymous> to the issuer. Do not
+combine this flag with the B<-localauth> flag. For more details, see
+L<vos(1)>.
 
-=item -localauth
+=item B<-localauth>
 
 Constructs a server ticket using a key from the local
-B</usr/afs/etc/KeyFile> file. The B<vos> command
-interpreter presents it to the Volume Server and Volume Location Server during
-mutual authentication. Do not combine this flag with the
-B<-cell> argument or B<-noauth> flag. For more details,
-see the introductory B<vos> reference page.
+F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
+to the Volume Server and Volume Location Server during mutual
+authentication. Do not combine this flag with the B<-cell> argument or
+B<-noauth> flag. For more details, see L<vos(1)>.
 
-=item -verbose
+=item B<-verbose>
 
-Produces on the standard output stream a detailed trace of the
-command's execution. If this argument is omitted, only warnings
-and error messages appear.
+Produces on the standard output stream a detailed trace of the command's
+execution. If this argument is omitted, only warnings and error messages
+appear.
 
-=item -help
+=item B<-help>
 
-Prints the online help for this command. All other valid options
-are ignored.
+Prints the online help for this command. All other valid options are
+ignored.
 
 =back
 
-=head1 CAVEATS
+=head1 CAUTIONS
 
-The partition-related statistics in this command's output do not
-always agree with the corresponding values in the output of the standard UNIX
-B<df> command. The statistics reported by this command can be
-up to five minutes old, because the Cache Manager polls the File Server for
-partition information at that frequency. Also, on some operating
-systems, the B<df> command's report of partition size includes
-reserved space not included in this command's calculation, and so is
-likely to be about 10% larger.
+The partition-related statistics in this command's output do not always
+agree with the corresponding values in the output of the standard UNIX
+B<df> command. The statistics reported by this command can be up to five
+minutes old, because the Cache Manager polls the File Server for partition
+information at that frequency. Also, on some operating systems, the B<df>
+command's report of partition size includes reserved space not included in
+this command's calculation, and so is likely to be about 10% larger.
 
 =head1 OUTPUT
 
@@ -93,7 +88,7 @@ specified partition.
 =head1 EXAMPLES
 
 The following command displays all partitions on the file server machine
-B<fs2.abc.com>.
+C<fs2.abc.com>.
 
    % vos partinfo fs2.abc.com
    Free space on partition /vicepa: 27301 K blocks out of total 549197