* Document backup deletedump -port/-groupid/-dbonly/-force/-noexecute
- * Replace backup diskrestore/dump -n option with -noexecute or -dryrun?
-
* Document backup help -admin
- * Document backup volrestore -usedump. Also, s/-n/.../ as above?
-
- * Replace backup volsetrestore -n option with -noexecute or -dryrun?
+ * Document backup volrestore -usedump.
If you notice other problems, please send them to the openafs-doc list
even if you don't have time to fix them. Someone else might, and we
S<<< [B<-newserver> <I<destination machine>>] >>>
S<<< [B<-newpartition> <I<destination partition>>] >>>
S<<< [B<-extension> <I<new volume name extension>>] >>>
- [B<-n>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
+ [B<-dryrun>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
B<backup di> S<<< B<-s> <I<machine to restore>> >>>
S<<< B<-pa> <I<partition to restore>> >>>
S<<< [B<-po> <I<TC port offset>>+] >>>
S<<< [B<-news> <I<destination machine>>] >>>
S<<< [B<-newp> <I<destination partition>>] >>>
- S<<< [B<-e> <I<new volume name extension>>] >>> [B<-n>] [B<-l>]
+ S<<< [B<-e> <I<new volume name extension>>] >>> [B<-dryrun>] [B<-l>]
S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
=for html
overwrites it.
To print out a list of the tapes containing the needed dumps, without
-actually performing the restore operation, include the B<-n> flag along
-with the other options to be used on the actual command.
+actually performing the restore operation, include the B<-dryrun> flag
+along with the other options to be used on the actual command.
The Tape Coordinator's default response to this command is to access the
first tape it needs by invoking the C<MOUNT> instruction in the local
to separate the extension from the name, specify it as the first character
of the string (as in C<.rst>, for example).
-=item B<-n>
+=item B<-dryrun>
Displays a list of the tapes necessary to perform the requested restore,
without actually performing the operation.
operation. In the latter case, the operator can then attempt to determine
the cause of the tape error.
-If the issuer includes the B<-n> flag with the command, the following
+If the issuer includes the B<-dryrun> flag with the command, the following
string appears at the head of the list of the tapes necessary to perform
the restore operation:
which the VLDB lists a read/write site on the F</vicepm> partition of the
machine C<fs4.abc.com>:
- % backup diskrestore -server fs4.abc.com -partition /vicepm -n
+ % backup diskrestore -server fs4.abc.com -partition /vicepm -dryrun
Tapes needed:
user.sunday1.1
user.sunday1.2
S<<< B<-volume> <I<volume(s) to restore>>+ >>>
S<<< [B<-extension> <I<new volume name extension>>] >>>
S<<< [B<-date> <I<date from which to restore>>+] >>>
- S<<< [B<-portoffset> <I<TC port offsets>>+] >>> [B<-n>]
+ S<<< [B<-portoffset> <I<TC port offsets>>+] >>> [B<-dryrun>]
S<<< [B<-usedump> <I<specify the dumpID to restore from>>] >>>
[B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
S<<< [B<-d> <I<date from which to restore>>+] >>>
S<<< [B<-po> <I<TC port offsets>>+] >>>
S<<< [B<-u> <I<specify the dumpID to restore from>>] >>>
- [B<-n>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
+ [B<-dryrun>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
=for html
</div>
the Backup System restores dumps of the corresponding volume version only.
To generate a list of the tapes the Backup System needs to perform the
-restore operation, without actually performing it, combine the B<-n> flag
-with the options to be used on the actual command.
+restore operation, without actually performing it, combine the B<-dryrun>
+flag with the options to be used on the actual command.
If all of the full and incremental dumps of all relevant volumes were not
written to a type of tape that a single Tape Coordinator can read, use the
for all dumps. If C<0> is just one of the values in the list, provide it
explicitly in the appropriate order.
-=item B<-n>
+=item B<-dryrun>
Displays the list of tapes that contain the dumps required by the restore
operation, without actually performing the operation.
=head1 OUTPUT
-If the issuer includes the B<-n> flag with the command, the following
+If the issuer includes the B<-dryrun> flag with the command, the following
string appears at the head of the list of the tapes necessary to complete
the restore operation.
B<backup volsetrestore> S<<< [B<-name> <I<volume set name>>] >>>
S<<< [B<-file> <I<file name>>] >>>
S<<< [B<-portoffset> <I<TC port offset>>+] >>>
- S<<< [B<-extension> <I<new volume name extension>>] >>> [B<-n>]
+ S<<< [B<-extension> <I<new volume name extension>>] >>> [B<-dryrun>]
[B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
B<backup vols> S<<< [B<-na> <I<volume set name>>] >>>
S<<< [B<-f> <I<file name>>] >>>
S<<< [B<-p> <I<TC port offset>>+] >>>
S<<< [B<-e> <I<new volume name extension>>] >>>
- [B<-n>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
+ [B<-dryrun>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
=for html
</div>
not affect the existing volume in any way. However, if a volume with the
specified extension also already exists, the command overwrites it.
-The B<-n> flag produces a list of the volumes to be restored if the B<-n>
-flag were not included, without actually restoring any volumes. See
-L</OUTPUT> for a detailed description of the output, and suggestions on how
-to combine it most effectively with the B<-file> and B<-name> arguments.
+The B<-dryrun> flag produces a list of the volumes to be restored if the
+B<-dryrun> flag were not included, without actually restoring any volumes.
+See L</OUTPUT> for a detailed description of the output, and suggestions
+on how to combine it most effectively with the B<-file> and B<-name>
+arguments.
The execution time for a B<backup volsetrestore> command depends on the
number of volumes to be restored and the amount of data in them, but it
for all dumps. If C<0> is just one of the values in the list, provide it
explicitly in the appropriate order.
-=item B<-n>
+=item B<-dryrun>
Displays a list of the volumes to be restored if the flag were not
included, without actually restoring them. L</OUTPUT> details the format of
=head1 OUTPUT
-If the B<-n> flag is not provided, the command displays a unique task ID
-number for the operation, in two places:
+If the B<-dryrun> flag is not provided, the command displays a unique
+task ID number for the operation, in two places:
=over 4
in interactive mode. The Backup System does not assign either type of ID
number until the restoration process actually begins.
-When the B<-n> flag is included, no task ID or job ID numbers are reported
-because none are assigned. Instead, the output begins with a count of the
-number of volumes to be restored, followed by a line for each dump of a
-volume. For each volume, the line representing the most recent full dump
-appears first, and lines for any subsequent incremental dumps follow,
-ordered by dump level. The lines for a given volume do not necessarily
-appear all together, however.
+When the B<-dryrun> flag is included, no task ID or job ID numbers are
+reported because none are assigned. Instead, the output begins with a
+count of the number of volumes to be restored, followed by a line for
+each dump of a volume. For each volume, the line representing the most
+recent full dump appears first, and lines for any subsequent incremental
+dumps follow, ordered by dump level. The lines for a given volume do not
+necessarily appear all together, however.
The format of each line is as follows (the output is shown here on two
lines only for legibility reasons):
=back
One way to generate a file for use as input to the B<-file> argument is to
-combine the B<-name> and B<-n> options, directing the output to a
+combine the B<-name> and B<-dryrun> options, directing the output to a
file. The I<OpenAFS Administration Guide> section on using the Backup
System to restore data explains how to edit the file as necessary before
using it as input to the B<-file> argument.
cmd_AddParm(ts, "-at", CMD_LIST, CMD_OPTIONAL, "Date/time to start dump");
cmd_AddParm(ts, "-append", CMD_FLAG, CMD_OPTIONAL,
"append to existing dump set");
- cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
+ cmd_AddParm(ts, "-dryrun", CMD_FLAG, CMD_OPTIONAL,
+ "list what would be done, don't do it");
+ cmd_AddParmAlias(ts, 5, "-n");
cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "load file");
if (!interact)
add_std_args(ts);
cmd_AddParm(ts, "-date", CMD_LIST, CMD_OPTIONAL,
"date from which to restore");
cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offsets");
- cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
+ cmd_AddParm(ts, "-dryrun", CMD_FLAG, CMD_OPTIONAL,
+ "list what would be done, don't do it");
+ cmd_AddParmAlias(ts, 6, "-n");
cmd_AddParm(ts, "-usedump", CMD_SINGLE, CMD_OPTIONAL,
"specify the dumpID to restore from");
if (!interact)
"destination partition");
cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
"new volume name extension");
- cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
+ cmd_AddParm(ts, "-dryrun", CMD_FLAG, CMD_OPTIONAL,
+ "list what would be done, don't do it");
+ cmd_AddParmAlias(ts, 11, "-n");
if (!interact)
add_std_args(ts);
cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
"new volume name extension");
- cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
+ cmd_AddParm(ts, "-dryrun", CMD_FLAG, CMD_OPTIONAL,
+ "list what would be done, don't do it");
+ cmd_AddParmAlias(ts, 4, "-n");
if (!interact)
add_std_args(ts);
cmd_AddParm(ts, "-noexecute", CMD_FLAG, CMD_OPTIONAL|CMD_HIDDEN, "");
cmd_AddParm(ts, "-dryrun", CMD_FLAG, CMD_OPTIONAL,
"list the dumps, don't delete anything");
+ cmd_AddParmAlias(ts, 8, "-n");
if (!interact)
add_std_args(ts);
git://git.openafs.org / openafs.git / commitdiff