From: Jason Edgecombe <jason@rampaginggeek.com>
Date: Tue, 25 Dec 2007 22:28:15 +0000 (+0000)
Subject: STABLE14-man-page-misc-updates-20071225
X-Git-Tag: openafs-stable-1_4_7pre1~105
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=72fd2b94901ac20460c13e06a9e55c49501e7722;p=packages%2Fo%2Fopenafs.git

STABLE14-man-page-misc-updates-20071225

LICENSE BSD

Add some additional cross-references, add some missing man pages, fix a
few references to the OpenAFS manuals, document the -live flag to vos
move, and add an example for rxdebug.


(cherry picked from commit 84ef02b0f392c761211adc7d5876217ad835c6c0)
---

diff --git a/doc/man-pages/README b/doc/man-pages/README
index 4f789c612..a8c11def0 100644
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -202,6 +202,11 @@ Known Problems
    * The following installed commands have no man pages:
 
        copyauth
+       fs cscpolicy
+       fs memdump
+       fs minidump
+       fs monitor
+       fs rxstatpeer
        fs rxstatproc
        fs setcbaddr
        restorevol
diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod
index 75dce00cb..773762434 100644
--- a/doc/man-pages/pod1/fs.pod
+++ b/doc/man-pages/pod1/fs.pod
@@ -27,6 +27,7 @@ L<B<fs setcell>|fs_setcell(1)>,
 L<B<fs setcrypt>|fs_setcrypt(1)>,
 L<B<fs setserverprefs>|fs_setserverprefs(1)>,
 L<B<fs sysname>|fs_sysname(1)>,
+L<B<fs uuid>|fs_uuid(1)>,
 and L<B<fs wscell>|fs_wscell(1)>.
 
 =item *
diff --git a/doc/man-pages/pod1/rxdebug.pod b/doc/man-pages/pod1/rxdebug.pod
index 9370448a2..3a023cee6 100644
--- a/doc/man-pages/pod1/rxdebug.pod
+++ b/doc/man-pages/pod1/rxdebug.pod
@@ -183,6 +183,25 @@ additional information as described in L<OPTIONS>. The output is intended
 for debugging purposes and is meaningful to someone familiar with the
 implementation of Rx.
 
+=head1 EXAMPLES
+
+The following command shows Rx statistics on the server 192.168.1.100:
+
+   % rxdebug  192.168.1.100
+   Trying 192.168.1.100 (port 7000):
+   Free packets: 265, packet reclaims: 0, calls: 0, used FDs: 34
+   not waiting for packets.
+   0 calls waiting for a thread
+   11 threads are idle
+   Done.
+
+The following command shows the OpenAFS version running on the server
+192.168.1.100:
+
+   % rxdebug  192.168.1.100 -version
+   Trying 192.168.1.100 (port 7000):
+   AFS version:  OpenAFS 1.4.2fc2 built  2006-08-31 
+
 =head1 PRIVILEGE REQUIRED
 
 None.
diff --git a/doc/man-pages/pod1/sys.pod b/doc/man-pages/pod1/sys.pod
index 70e41dcbd..7a094dbf1 100644
--- a/doc/man-pages/pod1/sys.pod
+++ b/doc/man-pages/pod1/sys.pod
@@ -60,9 +60,9 @@ None
 L<fs_sysname(1)>,
 L<livesys(1)>
 
-I<IBM AFS Quick Beginnings>
+I<OpenAFS Quick Beginnings>
 
-I<IBM AFS Administration Guide>
+I<OpenAFS Administration Guide>
 
 =head1 COPYRIGHT
 
diff --git a/doc/man-pages/pod1/vos_move.pod b/doc/man-pages/pod1/vos_move.pod
index d52787cbb..7ca03ce6e 100644
--- a/doc/man-pages/pod1/vos_move.pod
+++ b/doc/man-pages/pod1/vos_move.pod
@@ -12,14 +12,14 @@ B<vos move> S<<< B<-id> <I<volume name or ID>> >>>
     S<<< B<-frompartition> <I<partition name on source>> >>>
     S<<< B<-toserver> <I<machine name on destination>> >>>
     S<<< B<-topartition> <I<partition name on destination>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>]
-    [B<-help>]
+    [B<-live>] S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>]
+    [B<-localauth>] [B<-verbose>] [B<-help>]
 
 B<vos m> S<<< B<-i> <I<volume name or ID>> >>>
     S<<< B<-froms> <I<machine name on source>> >>>
     S<<< B<-fromp> <I<partition name on source>> >>>
     S<<< B<-tos> <I<machine name on destination>> >>>
-    S<<< B<-top> <I<partition name on destination>> >>>
+    S<<< B<-top> <I<partition name on destination>> >>> [B<-li>]
     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
 
 =for html
@@ -120,6 +120,14 @@ Names the partition to which to move the volume. Provide the full
 partition name (for, example, B</vicepa>) or one of the abbreviated forms
 described in L<vos(1)>.
 
+=item B<-live>
+
+Avoids making a temporary copy of the volume during the move. This is
+useful if the partition is full, but the administrator needs to move
+volumes to a another partition or server to free up disk space. The
+caveat is that the volume is locked during the entire operation
+instead of the short time that is needed to make the temporary clone.
+
 =item B<-cell> <I<cell name>>
 
 Names the cell in which to run the command. Do not combine this argument
@@ -174,6 +182,7 @@ superuser C<root>.
 L<vos(1)>,
 L<vos_addsite(1)>,
 L<vos_backup(1)>,
+L<vos_copy(1)>,
 L<vos_release(1)>,
 L<vos_listvol(1)>,
 L<vos_remove(1)>