mirror of
https://github.com/restic/restic.git
synced 2025-10-09 13:49:58 +00:00
Update manpages and auto-completion
This commit is contained in:
@@ -50,7 +50,15 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
|
||||
|
||||
.PP
|
||||
\fB\-\-files\-from\fP=[]
|
||||
read the files to backup from \fB\fCfile\fR (can be combined with file args/can be specified multiple times)
|
||||
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-\-files\-from\-raw\fP=[]
|
||||
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-\-files\-from\-verbatim\fP=[]
|
||||
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-f\fP, \fB\-\-force\fP[=false]
|
||||
@@ -72,6 +80,10 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
|
||||
\fB\-\-iexclude\-file\fP=[]
|
||||
same as \-\-exclude\-file but ignores casing of \fB\fCfile\fRnames in patterns
|
||||
|
||||
.PP
|
||||
\fB\-\-ignore\-ctime\fP[=false]
|
||||
ignore ctime changes when checking for modified files
|
||||
|
||||
.PP
|
||||
\fB\-\-ignore\-inode\fP[=false]
|
||||
ignore inode number changes when checking for modified files
|
||||
@@ -94,7 +106,7 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
|
||||
|
||||
.PP
|
||||
\fB\-\-tag\fP=[]
|
||||
add a \fB\fCtag\fR for the new snapshot (can be specified multiple times)
|
||||
add \fB\fCtags\fR for the new snapshot in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-\-time\fP=""
|
||||
|
@@ -43,7 +43,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
|
||||
.PP
|
||||
\fB\-\-read\-data\-subset\fP=""
|
||||
read subset n of m data packs (format: \fB\fCn/m\fR)
|
||||
read a \fB\fCsubset\fR of data packs, specified as 'n/t' for specific subset or either 'x%' or 'x.y%' for random subset
|
||||
|
||||
.PP
|
||||
\fB\-\-with\-cache\fP[=false]
|
||||
|
@@ -15,12 +15,21 @@ restic\-copy \- Copy snapshots from one repository to another
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The "copy" command copies one or more snapshots from one repository to another
|
||||
repository. Note that this will have to read (download) and write (upload) the
|
||||
entire snapshot(s) due to the different encryption keys on the source and
|
||||
destination, and that transferred files are not re\-chunked, which may break
|
||||
their deduplication. This can be mitigated by the "\-\-copy\-chunker\-params"
|
||||
option when initializing a new destination repository using the "init" command.
|
||||
The "copy" command copies one or more snapshots from one repository to another.
|
||||
|
||||
.PP
|
||||
NOTE: This process will have to both download (read) and upload (write) the
|
||||
entire snapshot(s) due to the different encryption keys used in the source and
|
||||
destination repositories. This /may incur higher bandwidth usage and costs/ than
|
||||
expected during normal backup runs.
|
||||
|
||||
.PP
|
||||
NOTE: The copying process does not re\-chunk files, which may break deduplication
|
||||
between the files copied and files already stored in the destination repository.
|
||||
This means that copied files, which existed in both the source and destination
|
||||
repository, /may occupy up to twice their space/ in the destination repository.
|
||||
This can be mitigated by the "\-\-copy\-chunker\-params" option when initializing a
|
||||
new destination repository using the "init" command.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
|
@@ -17,8 +17,8 @@ restic\-dump \- Print a backed\-up file to stdout
|
||||
.PP
|
||||
The "dump" command extracts files from a snapshot from the repository. If a
|
||||
single file is selected, it prints its contents to stdout. Folders are output
|
||||
as a tar file containing the contents of the specified folder. Pass "/" as
|
||||
file name to dump the whole snapshot as a tar file.
|
||||
as a tar (default) or zip file containing the contents of the specified folder.
|
||||
Pass "/" as file name to dump the whole snapshot as an archive file.
|
||||
|
||||
.PP
|
||||
The special snapshot "latest" can be used to use the latest snapshot in the
|
||||
@@ -31,6 +31,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-a\fP, \fB\-\-archive\fP="tar"
|
||||
set archive \fB\fCformat\fR as "tar" or "zip"
|
||||
|
||||
.PP
|
||||
\fB\-h\fP, \fB\-\-help\fP[=false]
|
||||
help for dump
|
||||
|
@@ -87,6 +87,18 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
\fB\-\-prune\fP[=false]
|
||||
automatically run the 'prune' command if snapshots have been removed
|
||||
|
||||
.PP
|
||||
\fB\-\-max\-unused\fP="5%"
|
||||
tolerate given \fB\fClimit\fR of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
|
||||
|
||||
.PP
|
||||
\fB\-\-max\-repack\-size\fP=""
|
||||
maximum \fB\fCsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
|
||||
|
||||
.PP
|
||||
\fB\-\-repack\-cacheable\-only\fP[=false]
|
||||
only repack packs which are cacheable
|
||||
|
||||
.PP
|
||||
\fB\-h\fP, \fB\-\-help\fP[=false]
|
||||
help for forget
|
||||
|
@@ -25,10 +25,26 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
|
||||
do not modify the repository, just print what would be done
|
||||
|
||||
.PP
|
||||
\fB\-h\fP, \fB\-\-help\fP[=false]
|
||||
help for prune
|
||||
|
||||
.PP
|
||||
\fB\-\-max\-repack\-size\fP=""
|
||||
maximum \fB\fCsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
|
||||
|
||||
.PP
|
||||
\fB\-\-max\-unused\fP="5%"
|
||||
tolerate given \fB\fClimit\fR of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
|
||||
|
||||
.PP
|
||||
\fB\-\-repack\-cacheable\-only\fP[=false]
|
||||
only repack packs which are cacheable
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
|
@@ -5,7 +5,7 @@
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
restic\-rebuild\-index \- Build a new index file
|
||||
restic\-rebuild\-index \- Build a new index
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
@@ -29,6 +29,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
\fB\-h\fP, \fB\-\-help\fP[=false]
|
||||
help for rebuild\-index
|
||||
|
||||
.PP
|
||||
\fB\-\-read\-all\-packs\fP[=false]
|
||||
read all pack files to generate new index from scratch
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
|
@@ -50,7 +50,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
|
||||
.PP
|
||||
\fB\-\-tag\fP=[]
|
||||
only consider snapshots which include this \fB\fCtaglist\fR (can be specified multiple times)
|
||||
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
|
@@ -33,7 +33,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-add\fP=[]
|
||||
\fB\fCtag\fR which will be added to the existing tags (can be given multiple times)
|
||||
\fB\fCtags\fR which will be added to the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-h\fP, \fB\-\-help\fP[=false]
|
||||
@@ -49,11 +49,11 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
|
||||
|
||||
.PP
|
||||
\fB\-\-remove\fP=[]
|
||||
\fB\fCtag\fR which will be removed from the existing tags (can be given multiple times)
|
||||
\fB\fCtags\fR which will be removed from the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-\-set\fP=[]
|
||||
\fB\fCtag\fR which will replace the existing tags (can be given multiple times)
|
||||
\fB\fCtags\fR which will replace the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
|
||||
|
||||
.PP
|
||||
\fB\-\-tag\fP=[]
|
||||
|
Reference in New Issue
Block a user