From 368c44b537d6940482ceefe2ef8e1fd7fd099783 Mon Sep 17 00:00:00 2001
From: Andrew Deason <adeason@sinenomine.net>
Date: Thu, 1 Jul 2010 11:57:59 -0500
Subject: [PATCH] Document fs -human

Document the new -human switch for 'fs diskfree' and 'fs listquota'.

Change-Id: Ic4b4f9d7492c887085ab6da4c802cfc75fd4d08e
Reviewed-on: http://gerrit.openafs.org/2314
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
---
 doc/man-pages/pod1/fs_diskfree.pod  | 23 ++++++++++++++++-------
 doc/man-pages/pod1/fs_listquota.pod | 15 +++++++++++----
 2 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/doc/man-pages/pod1/fs_diskfree.pod b/doc/man-pages/pod1/fs_diskfree.pod
index 491db26..b19db2b 100644
--- a/doc/man-pages/pod1/fs_diskfree.pod
+++ b/doc/man-pages/pod1/fs_diskfree.pod
@@ -7,11 +7,11 @@ fs_diskfree - Shows data about the partition housing a directory or file
 =for html
 <div class="synopsis">
 
-B<fs diskfree> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
+B<fs diskfree> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-human>] [B<-help>]
 
-B<fs df> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+B<fs df> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
 
-B<fs di> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+B<fs di> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
 
 =for html
 </div>
@@ -47,6 +47,12 @@ produce output. Partial pathnames are interpreted relative to the current
 working directory, which is also the default value if this argument is
 omitted.
 
+=item B<-human>
+
+Print space in a "human-readable" format. Instead of always printing space
+in kilobytes, show disk space in kilobytes, megabytes, gigabytes,
+terabytes, or petabytes, as appropriate.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
@@ -67,20 +73,23 @@ The name of the volume.
 
 =item total
 
-The partition's total size in kilobytes.
+The partition's total size. If B<-human> is not specified, this value is
+in kilobytes.
 
 =item used
 
-The number of kilobytes used on the partition.
+The amount of space used on the partition. If B<-human> is not specified,
+this value is in kilobytes.
 
 =item avail
 
-The number of kilobytes available on the partition.
+The amount of space available on the partition. If B<-human> is not
+specified, this value is in kilobytes.
 
 =item %used
 
 The percentage of the partition's total space that is used (the C<used>
-statistic divided by the C<total> statistic, times 100).
+statistic divided by the C<kbytes> statistic, times 100).
 
 =back
 
diff --git a/doc/man-pages/pod1/fs_listquota.pod b/doc/man-pages/pod1/fs_listquota.pod
index 84cc614..385a449 100644
--- a/doc/man-pages/pod1/fs_listquota.pod
+++ b/doc/man-pages/pod1/fs_listquota.pod
@@ -7,11 +7,11 @@ fs_listquota - Displays quota information for a volume
 =for html
 <div class="synopsis">
 
-B<fs listquota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
+B<fs listquota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-human>] [B<-help>]
 
-B<fs listq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+B<fs listq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
 
-B<fs lq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+B<fs lq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
 
 =for html
 </div>
@@ -43,6 +43,12 @@ produce output. Partial pathnames are interpreted relative to the current
 working directory, which is also the default value if this argument is
 omitted.
 
+=item B<-human>
+
+Print space in a "human-readable" format. Instead of always printing space
+in kilobytes, show disk space in kilobytes, megabytes, gigabytes,
+terabytes, or petabytes, as appropriate.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
@@ -69,7 +75,8 @@ unlimited quota.
 
 =item Used
 
-The number of kilobytes of quota used.
+The amount of space used. If B<-human> is not specified, this value is in
+kilobytes.
 
 =item % Used
 
-- 
1.9.4