From: Andrew Deason Date: Thu, 29 Jul 2010 18:02:47 +0000 (-0500) Subject: Document the 'vos offline' -busy and -sleep opts X-Git-Tag: openafs-devel-1_5_76~64 X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=ea8be82b95972d46882e8e7fce91a1973c966049 Document the 'vos offline' -busy and -sleep opts Change-Id: I68d374a206a398467e5980a87b3ca2ad41bf9653 Reviewed-on: http://gerrit.openafs.org/2482 Reviewed-by: Derrick Brashear Tested-by: Derrick Brashear --- diff --git a/doc/man-pages/README b/doc/man-pages/README index 3a25ee8..b76a072 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -263,8 +263,6 @@ Known Problems Changes needed to have vos suite commands completely up to date, including the 1.5 branch: - * Document vos offline -busy / -sleep - * Document vos create -minquota which is available since 1.5.61 * Document vos restore -creation/-lastupdate and -nodelete diff --git a/doc/man-pages/pod1/vos_offline.pod b/doc/man-pages/pod1/vos_offline.pod index 301e218..53ca666 100644 --- a/doc/man-pages/pod1/vos_offline.pod +++ b/doc/man-pages/pod1/vos_offline.pod @@ -60,6 +60,37 @@ L. Specifies either the complete name or volume ID number of the volume. +=item B<-sleep> > + +Specifies to sleep for a certain number of seconds after taking the +volume offline before bringing it online again. If this option is +specified, the volume will be online when B successfully +completes. If this option is not specified, B must be run to +bring the volume online. + +=item B<-busy> + +Specifies to mark the volume as `busy' instead of `offline'. This +means that a program trying to access this volume will receive a VBUSY +error instead of a VOFFLINE error (until the volume is brought back +online). + +Different programs may react differently when they see these two +different states, but in general a `busy' volume is only unavailable +for a short period of time and will become online soon. An `offline' +volume, on the other hand, is typically unavailable for longer periods +and may not come back online until an administrator intervenes. + +As an example of when these states occur normally, a volume can be +`busy' when it is being cloned (perhaps as the result of a +B or B operation). A volume can be `offline' +if a non-DAFS fileserver has detected a problem in the volume, and an +administrator must manually schedule a salvage for that volume before +it becomes available again. + +If B<-busy> is specified, the B<-sleep> option must also be specified, to +indicate for how long to keep the volume busy. + =item B<-cell> > Names the cell in which to run the command. Do not combine this argument