From 897c36027476843db988b9d0625a8fc189c8716d Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Tue, 19 Feb 2008 15:25:17 +0000 Subject: [PATCH] man-page-updates-20080219 LICENSE IPL10 FIXES 86677 note 2tb limit, add fs minidump document --- doc/man-pages/README | 1 - doc/man-pages/pod1/fs_listquota.pod | 11 +++++++++ doc/man-pages/pod1/fs_minidump.pod | 47 +++++++++++++++++++++++++++++++++++++ doc/man-pages/pod1/fs_quota.pod | 11 +++++++++ doc/man-pages/pod1/fs_setquota.pod | 11 +++++++++ doc/man-pages/pod1/fs_setvol.pod | 11 +++++++++ doc/man-pages/pod1/vos_addsite.pod | 20 ++++++++++++---- doc/man-pages/pod1/vos_examine.pod | 11 +++++++++ doc/man-pages/pod1/vos_partinfo.pod | 11 +++++++++ doc/man-pages/pod8/afsd.pod | 6 ++++- 10 files changed, 133 insertions(+), 7 deletions(-) create mode 100644 doc/man-pages/pod1/fs_minidump.pod diff --git a/doc/man-pages/README b/doc/man-pages/README index e16d0fb..4e12abf 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -204,7 +204,6 @@ Known Problems copyauth fs cscpolicy fs memdump - fs minidump fs monitor fs rxstatpeer fs rxstatproc diff --git a/doc/man-pages/pod1/fs_listquota.pod b/doc/man-pages/pod1/fs_listquota.pod index 030736a..2d1777f 100644 --- a/doc/man-pages/pod1/fs_listquota.pod +++ b/doc/man-pages/pod1/fs_listquota.pod @@ -28,6 +28,17 @@ examine> command. To set volume quota, use the B or B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/fs_minidump.pod b/doc/man-pages/pod1/fs_minidump.pod new file mode 100644 index 0000000..9be46e7 --- /dev/null +++ b/doc/man-pages/pod1/fs_minidump.pod @@ -0,0 +1,47 @@ +=head1 NAME + +fs_minidump - Generate a minidump from the current afsd service + +=head1 SYNOPSIS + +=for html +
+ +B [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +B generates a mini dump file containing the current stack +of the afsd_service.exe process. This output can be very helpful when +debugging the AFS Client Service when it is unresponsive to SMB/CIFS +requests. + +=head1 CAUTIONS + +This command is only available in OpenAFS for Windows version 1.4 and later. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 SEE ALSO + +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the BSD License as written in the +doc/LICENSE file. This man page was written by Jason Edgecombe for +OpenAFS. diff --git a/doc/man-pages/pod1/fs_quota.pod b/doc/man-pages/pod1/fs_quota.pod index 63a3d12..f652877 100644 --- a/doc/man-pages/pod1/fs_quota.pod +++ b/doc/man-pages/pod1/fs_quota.pod @@ -24,6 +24,17 @@ resides on, use the B and B commands. To set volume quota, use the B or B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/fs_setquota.pod b/doc/man-pages/pod1/fs_setquota.pod index dfec299..f0cd853 100644 --- a/doc/man-pages/pod1/fs_setquota.pod +++ b/doc/man-pages/pod1/fs_setquota.pod @@ -29,6 +29,17 @@ setvol> command. To display a volume's quota, use the B, B, or B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/fs_setvol.pod b/doc/man-pages/pod1/fs_setvol.pod index c0fd59a..8540f7b 100644 --- a/doc/man-pages/pod1/fs_setvol.pod +++ b/doc/man-pages/pod1/fs_setvol.pod @@ -36,6 +36,17 @@ and the B command the percent of quota used. To set quota on one volume at a time, use the B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/vos_addsite.pod b/doc/man-pages/pod1/vos_addsite.pod index 1c4d961..e7d7826 100644 --- a/doc/man-pages/pod1/vos_addsite.pod +++ b/doc/man-pages/pod1/vos_addsite.pod @@ -9,13 +9,14 @@ vos_addsite - Adds a read-only site definition to a volume's VLDB entry B S<<< B<-server> > >>> S<<< B<-partition> > >>> - S<<< B<-id> > >>> S<<< [B<-cell> >] >>> - [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>] + S<<< B<-id> > >>> S<<< B<-valid> > >>> + S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] + [B<-verbose>] [B<-help>] B S<<< B<-s> > >>> S<<< B<-p> > >>> - S<<< B<-i> > >>> S<<< [B<-c> >] >>> - [B<-n>] [B<-l>] [B<-v>] [B<-h>] + S<<< B<-i> > >>> S<<< B<-valid> > >>> + S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>] =for html @@ -68,7 +69,16 @@ L. Specifies either the complete name or volume ID number of the read/write source volume. -=item B<-cell> > +=item B<-valid> > + +Specifies the volume ID number of the existing release-equivalent +volume that is not already marked as a replica. This is useful when an +existing read-only volume is dumped and restored with the B<-readonly> +flag at the new site. This option is available in OpenAFS clients +1.4.7 or later and 1.5.31 and later. This option can be used with +OpenAFS server versions later than 1.4.1 or 1.5.0. + +=Item B<-cell> > Names the cell in which to run the command. Do not combine this argument with the B<-localauth> flag. For more details, see L. diff --git a/doc/man-pages/pod1/vos_examine.pod b/doc/man-pages/pod1/vos_examine.pod index 6f6c334..d1cebca 100644 --- a/doc/man-pages/pod1/vos_examine.pod +++ b/doc/man-pages/pod1/vos_examine.pod @@ -32,6 +32,17 @@ specified by the B<-id> argument. To display the volume header only, use the B command. To display information from the VLDB only, use the B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/vos_partinfo.pod b/doc/man-pages/pod1/vos_partinfo.pod index c9f37a2..d3b436c 100644 --- a/doc/man-pages/pod1/vos_partinfo.pod +++ b/doc/man-pages/pod1/vos_partinfo.pod @@ -25,6 +25,17 @@ size on either all of the partitions on the indicated file server machine that file server machine. The Volume Location Database (VLDB) is not consulted. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod8/afsd.pod b/doc/man-pages/pod8/afsd.pod index 4c92513..f632108 100644 --- a/doc/man-pages/pod8/afsd.pod +++ b/doc/man-pages/pod8/afsd.pod @@ -627,7 +627,11 @@ Bind the Rx socket (one interface only). =item B<-rxpck> > -Set rx_extraPackets to this value. +Set rx_extraPackets to this value. This sets the number of extra Rx +packet structures that are available to handle Rx connections. This +value should be increased if the "rxdebug 127.0.0.1 -port 7001 +-rxstats" command shows no free Rx packets. Increasing this value may +improve OpenAFS client performance in some circumstances. =item B<-settime> -- 1.9.4