diff options
Diffstat (limited to 'doc/restore.1in')
-rw-r--r-- | doc/restore.1in | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/doc/restore.1in b/doc/restore.1in new file mode 100644 index 0000000..ee88781 --- /dev/null +++ b/doc/restore.1in @@ -0,0 +1,134 @@ +.\" This file is part of backup -*- nroff -*- +.\" Copyright (C) 2012 Sergey Poznyakoff +.\" +.\" Backup is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 3, or (at your option) +.\" any later version. +.\" +.\" Backup is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with backup. If not, see <http://www.gnu.org/licenses/>. +.\" +.TH RESTORE 1 "May 17, 2012" "RESTORE" "Backup User Reference" +.SH NAME +restore \- restore file system from a backup. +.SH SYNOPSIS +.B restore +[\fB\-h\fR] [\fB\-\-help\fR] + +.B restore +[\fB\-cntv\fR] [\fB\-\-confirm\fR] [\fB\-C\fR \fIDIR\fR]\ + [\fB\-\-directory\fR \fIDIR\fR] [\fB\-\-verbose\fR] + [\fB\-\-dry\-run\fR] [\fB\-\-list\fR] [\fB\-\-logfile\fR \fIFILE\fR]\ + [\fB\-L\fR \fIN\fR] [\fB\-\-level\fR \fIN\fR] + [\fB\-R\fR \fIN\fR] [\fB\-\-round\fR \fIN\fR] [\fB\-\-week\fR \fIN\fR] + [\fBITEM\fR [\fBITEM\fR...]] +.SH DESCRIPTION +The +.B restore +utility restores the file system from incremental backups created +using +.BR backup (1). +.PP +The program reads its configuration from the file +.B backup.conf +located in the +.B @SYSCONFDIR@ +directory, or from the file named in the environment variable +.BR BACKUP_CONFIG . +The configuration file must exist. +.PP +After loading the configuration file, the program examines its command +line for options that modify its behavior. These are described in +detail in the section +.BR OPTIONS , +below. +.PP +Once the configuration loaded, the +.B restore +utility determines which backup archives to use for restoring. Unless +being requested otherwise by the command line options, the utility +selects the most recent set of backup files. +.PP +Before starting the restore, the utility displays the backup files it +has selected and asks the user if he wishes to proceed. Empty line +(the \fBCR\fR alone) or any word beginning with \fBY\fR +(case-insensitive) is taken as affirmative. Otherwise, a negative +answer is assumed and program terminates. +.PP +The program restores file systems and other backup items in the +order they are listed in the \fBbackup_items\fR configuration +variable. The \fBITEM\fR arguments override this default. If they +are present, the program will restore only those items that are listed +in the command line and exactly in the order they appear. +.SH OPTIONS +.TP +\fB\-c\fR, \fB\-\-confirm\fR +Do not ask for confirmation; run straight into restoring. +.TP +\fB\-C\fR, \fB\-\-directory\fR \fIDIR\fR +Restore into directory \fIDIR\fR instead of \fB/\fR. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Increase verbosity. +.TP +\fB\-n\fR, \fB\-\-dry\-run\fR +Do nothing, but print what would have been done. +.TP +\fB\-t\fR, \fB\-\-list\fR +List archive files, instead of extracting from them. +.TP +\fB\-l\fR, \fB\-\-logfile\fR \fIFILE\fB +Log to \fIFILE\fR instead of the standard error. This option implies +\fB\-\-confirm\R. Note also, that due to its specific nature +.B restore +ignores the \fBbackup_logfile\fR configuration setting. +.TP +\fB\-L\fR, \fB\-\-level\fR \fIN\fN +Set incremental dump level to stop at. +.TP +\fB\-R\fR, \fB\-\-round\fR \fIN\fR +Use archives from incremental round \fIN\fR. +.TP +\fB\-W\fR, \fB\-\-week\fR \fIN\fR +Use archives from week \fIN\fR. +.TP +\fB\-h\fR, \fB\-\-help\fR +Display a short help summary. +.SH EXAMPLES +.SH FILES +.TP +.BR @SYSCONFDIR@/backup.conf +Default configuration file. +.TP +.BR @LIBDIR@/backup +Backup module directory. Whenever a backup item of type \fBT\fR is +requested, \fBrestore\fR will attempt to load from this directory a +file named \fBT.sh\fR. This file provides methods and definitions +necessary to handle that particular item type. +.TP +.BR @LIBDIR@/backup/common.sh +Settings and definitions shared between +.BR backup (1) +and +.BR restore. +.SH "SEE ALSO" +.BR backup (1), +.BR backup.conf (5) +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <gray@gnu.org.ua>. +.\" Local variables: +.\" eval: (add-hook 'write-file-hooks 'time-stamp) +.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \"" +.\" time-stamp-format: "%:B %:d, %:y" +.\" time-stamp-end: "\"" +.\" time-stamp-line-limit: 20 +.\" end: + |