diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-09-17 04:15:04 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-09-17 04:15:04 +0000 |
commit | afa9f8ccda18c5ff879f432ae6f0b9a601b992b3 (patch) | |
tree | 8356bdc65590449d1a86d64a309c95681f802ad2 /sbin/restore/restore.8 | |
parent | 90e9edeb57b7efe3b1aba0ddeda30341b7e9fd0c (diff) |
sbin/ man page fixes
Diffstat (limited to 'sbin/restore/restore.8')
-rw-r--r-- | sbin/restore/restore.8 | 61 |
1 files changed, 32 insertions, 29 deletions
diff --git a/sbin/restore/restore.8 b/sbin/restore/restore.8 index d43208b3ce0..0eac9fc76a8 100644 --- a/sbin/restore/restore.8 +++ b/sbin/restore/restore.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: restore.8,v 1.8 1998/01/10 13:48:58 deraadt Exp $ +.\" $OpenBSD: restore.8,v 1.9 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: restore.8,v 1.15 1997/07/01 05:37:53 lukem Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -65,19 +65,19 @@ .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Op file ... +.Op Ar file Ar ... .Nm restore .Fl x .Op Fl chmvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Op file ... +.Op Ar file Ar ... .Pp .in -\\n(iSu (The .Bx 4.3 -option syntax is implemented for backward compatibility, but +option syntax is implemented for backward compatibility but is not documented here.) .Sh DESCRIPTION The @@ -139,12 +139,12 @@ The most expedient way to extract most of the files from a directory is to add the directory to the extraction list and then delete those files that are not needed. .It Ic extract -All the files that are on the extraction list are extracted +All files on the extraction list are extracted from the dump. .Nm will ask which volume the user wishes to mount. The fastest way to extract a few files is to -start with the last volume, and work towards the first volume. +start with the last volume and work towards the first volume. .It Ic help List a summary of the available commands. .It Ic \&ls Op Ar arg @@ -152,14 +152,14 @@ List the current or specified directory. Entries that are directories are appended with a ``/''. Entries that have been marked for extraction are prepended with a ``*''. If the verbose -flag is set the inode number of each entry is also listed. +flag is set, the inode number of each entry is also listed. .It Ic pwd Print the full pathname of the current working directory. .It Ic quit Restore immediately exits, even if the extraction list is not empty. .It Ic setmodes -All the directories that have been added to the extraction list +All directories that have been added to the extraction list have their owner, modes, and times set; nothing is extracted from the dump. This is useful for cleaning up after a restore has been prematurely aborted. @@ -176,17 +176,17 @@ to print out information about each file as it is extracted. .El .It Fl R .Nm -requests a particular tape of a multi volume set on which to restart +requests a particular tape of a multi-volume set on which to restart a full restore (see the .Fl r flag below). This is useful if the restore has been interrupted. .It Fl r -Restore (rebuild a file system). +Restore (rebuild) a file system. The target file system should be made pristine with .Xr newfs 8 , -mounted and the user +mounted, and the user .Xr cd Ns 'd into the pristine file system before starting the restoration of the initial level 0 backup. If the @@ -197,8 +197,8 @@ any necessary incremental backups on top of the level 0. The .Fl r flag precludes an interactive file extraction and can be -detrimental to one's health if not used carefully (not to mention -the disk). An example: +detrimental to one's health (not to mention the disk) if not used carefully. +An example: .Bd -literal -offset indent newfs /dev/rrp0g eagle mount /dev/rp0g /mnt @@ -227,7 +227,7 @@ such as size or block size. The names of the specified files are listed if they occur on the backup. If no file argument is given, -then the root directory is listed, +the root directory is listed, which results in the entire content of the backup being listed, unless the @@ -250,7 +250,7 @@ the directory is recursively extracted. The owner, modification time, and mode are restored (if possible). If no file argument is given, -then the root directory is extracted, +the root directory is extracted, which results in the entire content of the backup being extracted, unless the @@ -290,7 +290,7 @@ or .Ql Fl (the standard input). If the name of the file is of the form -.Dq host:file , +.Dq host:file or .Dq user@host:file , .Nm @@ -353,7 +353,7 @@ Most checks are self-explanatory or can ``never happen''. Common errors are given below. .Pp .Bl -tag -width Ds -compact -.It Converting to new file system format. +.It Converting to new file system format A dump tape created from the old file system has been loaded. It is automatically converted to the new file system format. .Pp @@ -368,12 +368,12 @@ A file that was not listed in the directory showed up. This can occur when using a dump created on an active file system. .Pp .It Incremental dump too low -When doing incremental restore, +When doing an incremental restore, a dump that was written before the previous incremental dump, or that has too low an incremental level has been loaded. .Pp .It Incremental dump too high -When doing incremental restore, +When doing an incremental restore, a dump that does not begin its coverage where the previous incremental dump left off, or that has too high an incremental level has been loaded. @@ -383,9 +383,9 @@ or that has too high an incremental level has been loaded. .It Tape read error while trying to resynchronize A tape (or other media) read error has occurred. If a file name is specified, -then its contents are probably partially wrong. +its contents are probably partially wrong. If an inode is being skipped or the tape is trying to resynchronize, -then no extracted files have been corrupted, +no extracted files have been corrupted, though files may not be found on the tape. .Pp .It resync restore, skipped <num> blocks @@ -397,9 +397,12 @@ This message lists the number of blocks that were skipped over. .Sh ENVIRONMENT If the following environment variable exists it will be utilized by .Nm restore : +.Pp .Bl -tag -width "TMPDIR" -compact -.It TMPDIR -The directory given in TMPDIR will be used +.It Ev TMPDIR +The directory given in +.Ev TMPDIR +will be used instead of .Pa /tmp to store temporary files. @@ -412,13 +415,13 @@ for more information. .It Pa /dev/rst0 the default tape drive .It Pa /dev/rst* -Raw SCSI tape interface +raw SCSI tape interface .It Pa /tmp/rstdir* -file containing directories on the tape. +file containing directories on the tape .It Pa /tmp/rstmode* -owner, mode, and time stamps for directories. +owner, mode, and time stamps for directories .It Pa \&./restoresymtable -information passed between incremental restores. +information passed between incremental restores .El .Sh SEE ALSO .Xr environ 7 , @@ -431,7 +434,7 @@ information passed between incremental restores. can get confused when doing incremental restores from dumps that were made on active file systems. .Pp -A level zero dump must be done after a full restore. +A level 0 dump must be done after a full restore. Because .Nm runs in user code, @@ -447,7 +450,7 @@ and are generated with a unique name based on the date of the dump and the process ID (see .Xr mktemp 3 ), -except for when +except when .Fl r or .Fl R |