From 85bb464bb46cd87e10a90b75748e164ae683cba0 Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Tue, 17 Mar 2009 02:21:14 +0000 Subject: [PATCH 1/1] man-page-vos-setfields-20090316 LICENSE BSD FIXES 124472 New man page for vos setfields. Also adds -noresolve documentation to the vos(1) common flags. --- doc/man-pages/README | 1 - doc/man-pages/pod1/vos.pod | 12 +++ doc/man-pages/pod1/vos_setfields.pod | 142 +++++++++++++++++++++++++++++++++++ 3 files changed, 154 insertions(+), 1 deletion(-) create mode 100644 doc/man-pages/pod1/vos_setfields.pod diff --git a/doc/man-pages/README b/doc/man-pages/README index d264bdd..262a3e1 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -247,7 +247,6 @@ Known Problems restorevol rmtsysd tokens.krb - vos setfields vsys * Add -noresolve to the documentation of all the vos commands. diff --git a/doc/man-pages/pod1/vos.pod b/doc/man-pages/pod1/vos.pod index b91eaff..11b6984 100644 --- a/doc/man-pages/pod1/vos.pod +++ b/doc/man-pages/pod1/vos.pod @@ -90,6 +90,10 @@ A command to report Volume Server status: B. =item * +A command to change volume fields: B. + +=item * + Commands to obtain help: B and B. =back @@ -211,6 +215,13 @@ command is issued. The B<-fromserver> and B<-toserver> arguments to the B command also accept these name formats. +=item B<-noresolve> + +Shows all servers as IP addresses instead of the DNS name. This is very +useful when the server address is registered as 127.0.0.1 or when dealing +with multi-homed servers. The B<-noresolve> option is available in OpenAFS +versions 1.4.8 or later and 1.5.35 or later. + =item B<-verbose> Produces on the standard output stream a detailed trace of the command's @@ -261,6 +272,7 @@ L, L, L, L, +L, L, L, L, diff --git a/doc/man-pages/pod1/vos_setfields.pod b/doc/man-pages/pod1/vos_setfields.pod new file mode 100644 index 0000000..14931a9 --- /dev/null +++ b/doc/man-pages/pod1/vos_setfields.pod @@ -0,0 +1,142 @@ +=head1 NAME + +vos_setfields - Sets the quota or clear the access counter on a volume. + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-id> > >>> + S<<< B<-maxquota> > >>> [B<-clearuse>] + S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] + [B<-verbose>] [B<-encrypt>] [b<-noresolve>] [B<-help>] + +B S<<< B<-id> > >>> + S<<< B<-maxquota> > >>> [B<-clearuse>] + S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] + [B<-verbose>] [B<-encrypt>] [b<-noresolve>] [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command can set the quota on a volume, and it can +clear the access counter on a volume. This command differs from +B because only the volume name is needed to set the quota, +whereas the path to the volume is needed with B. + +If the B<-maxquota> and B<-clearuse> flags are missing, then no action is +taken. + +=head1 CAUTIONS + +This command is not effective on read-only or backup volumes. + +=head1 OPTIONS + +=over 4 + +=item B<-id> > + +Identifies the volume on which to operate, either by its complete name or +volume ID number. + +=item B<-maxquota> > + +Sets the maximum amount of file server disk space the volume can +occupy. Specify the number of one-kilobyte blocks as a positive integer +(C<1024> is one megabyte). A value of C<0> sets an unlimited quota, but +the size of the disk partition that houses the volume places an absolute +limit on the volume's size. + +=item B<-clearuse> + +Clears the access counter on a volumes, which is shown as C in the B output. + +=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 C 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<-encrypt> + +Encrypts the command so that the operation's results are not transmitted +across the network in clear text. + +=item B<-noresolve> + +Shows all servers as IP addresses instead of the DNS name. This is very +useful when the server address is registered as 127.0.0.1 or when dealing +with multi-homed servers. The B<-noresolve> option is available in OpenAFS +versions 1.4.8 or later and 1.5.35 or later. + +=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<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 OUTPUT + +This command produces no output other than error messages. + +=head1 EXAMPLES + +To set a 123KB quota on the root.cell volume, the following command may be +used: + + % vos setfields -id root.cell -maxquota 123 + +To clear the access counter on the root.cell volume, use the following +command: + + % vos setfields -id root.cell -clearuse + +The above commands may be combined as follows: + + % vos setfields -id root.cell -maxquota 123 -clearuse + +=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 + +Copyright 2009 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. -- 1.9.4