From ce209b23a5c64ed4b0d79ed775acf6cc000f4a35 Mon Sep 17 00:00:00 2001 From: Steven Jenkins Date: Tue, 12 Jun 2007 04:42:01 +0000 Subject: [PATCH] man-vos-online-20070611 Add initial man pages for vos offline and vos online. --- doc/man-pages/pod1/vos_offline.pod | 124 +++++++++++++++++++++++++++++ doc/man-pages/pod1/vos_online.pod | 120 ++++++++++++++++++++++++++++ 2 files changed, 244 insertions(+) create mode 100644 doc/man-pages/pod1/vos_offline.pod create mode 100644 doc/man-pages/pod1/vos_online.pod diff --git a/doc/man-pages/pod1/vos_offline.pod b/doc/man-pages/pod1/vos_offline.pod new file mode 100644 index 000000000..fd134e81b --- /dev/null +++ b/doc/man-pages/pod1/vos_offline.pod @@ -0,0 +1,124 @@ +=head1 NAME + +vos offline - Takes a volume offline + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-server> > >>> S<<< B<-partition> > >>> + S<<< B<-id> > >>> S<<< [B<-unbless>] >>> S<<< [B<-cell> >] >>> + S<<< [B<-noauth>] | B<-localauth>] >>> S<<< [B<-verbose>] >>> S<<< [B<-encrypt>] >>> S<<< [B<-help>] >>> + +=for html +
+ +=head1 DESCRIPTION + +The B command takes a volume offline on the +B. + +=head1 CAUTIONS + +Taking a volume offline that has existing +callbacks will result in those callbacks being broken +and clients not being able to access the volume. + +=head1 OPTIONS + +=over 4 + +=item B<-server> > + +Identifies the file server machine where the volume resides. +Provide the machine's IP address or its host name (either fully +qualified or using an unambiguous abbreviation). For details, see +L. + +=item B<-partition> > + +Identifies the partition where the volume resides, on the +file server machine named by the B<-server> argument. Provide the +partition's complete name with preceding slash (for example, C) +or use one of the three acceptable abbreviated forms. For details, see +L. + +=item B<-id> > + +Specifies either the complete name or volume ID number of the volume. + +=item B<-unbless> + +If the volume resides on a fileserver running as a I (Demand +Attach File Server), then the volume may be marked as I or +I. A I server will not bring I volumes +online unless the B<-bless> option to L is specified. +See L for setting a volume to be I. + +=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. + +=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 L. + +=item B<-localauth> + +Constructs a server ticket using a key from the local +F file. The B 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. + +=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. + +=item B<-encrypt> + +Encrypts the command so that the operation's results are +not transmitted across the network in clear text. + +=item B<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 EXAMPLES + +The following example takes an online volume offline: + + % vos offline -server sv7.stateu.edu -partition /vicepb -id root.afs + +The following example takes an online volume offline and marks it +so that a B without B<-bless> will not bring it online: + + % vos offline -server sv7.stateu.edu -partition /vicepb -id root.afs \ + -unbless + +=head1 PRIVILEGE REQUIRED + +The issuer must be listed in the F file on the +machine specified with the B<-server> argument and on each database server +machine. If the B<-localauth> flag is included, the issuer must instead be +logged on to a server machine as the local superuser C. + +=head1 SEE ALSO + +L, +L, +L, + +=head1 COPYRIGHT + +IBM Corporation 2000. All Rights Reserved. + +This man page was created by Steven Jenkins. diff --git a/doc/man-pages/pod1/vos_online.pod b/doc/man-pages/pod1/vos_online.pod new file mode 100644 index 000000000..409af7dcd --- /dev/null +++ b/doc/man-pages/pod1/vos_online.pod @@ -0,0 +1,120 @@ +=head1 NAME + +vos online - Brings a volume online + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-server> > >>> S<<< B<-partition> > >>> + S<<< B<-id> > >>> S<<< [B<-bless>] >>> S<<< [B<-cell> >] >>> + S<<< [B<-noauth>] | B<-localauth>] >>> S<<< [B<-verbose>] >>> S<<< [B<-encrypt>] >>> S<<< [B<-help>] >>> + +=for html +
+ +=head1 DESCRIPTION + +The B command brings an offline volume on line with the +B. + +=head1 CAUTIONS + +None. + +=head1 OPTIONS + +=over 4 + +=item B<-server> > + +Identifies the file server machine where the volume resides. +Provide the machine's IP address or its host name (either fully +qualified or using an unambiguous abbreviation). For details, see +L. + +=item B<-partition> > + +Identifies the partition where the volume resides, on the +file server machine named by the B<-server> argument. Provide the +partition's complete name with preceding slash (for example, C) +or use one of the three acceptable abbreviated forms. For details, see +L. + +=item B<-id> > + +Specifies either the complete name or volume ID number of the volume. + +=item B<-bless> + +If the volume resides on a fileserver running as a I (Demand +Attach File Server), then the volume may be marked as I or +I. A I server will not bring I volumes +online unless the B<-bless> option to L is specified. +See L for setting a volume to be I. + +=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. + +=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 L. + +=item B<-localauth> + +Constructs a server ticket using a key from the local +F file. The B 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. + +=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. + +=item B<-encrypt> + +Encrypts the command so that the operation's results are +not transmitted across the network in clear text. + +=item B<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 EXAMPLES + +The following example brings an offline volume online: + + % vos online -server sv7.stateu.edu -partition /vicepb -id root.afs + +The following example brings an offline, unblessed volume online: + + % vos online -server sv7.stateu.edu -partition /vicepb -id root.afs -bless + +=head1 PRIVILEGE REQUIRED + +The issuer must be listed in the F file on the +machine specified with the B<-server> argument and on each database server +machine. If the B<-localauth> flag is included, the issuer must instead be +logged on to a server machine as the local superuser C. + +=head1 SEE ALSO + +L, +L, +L, + +=head1 COPYRIGHT + +IBM Corporation 2000. All Rights Reserved. + +This man page was created by Steven Jenkins. -- 2.39.5