TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-12-12 03:22:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update manpages and auto-completion

Browse Source
This commit is contained in:
Alexander Neumann
2023-10-24 20:02:55 +02:00
parent be1b978ac8
commit 524c2721b4
32 changed files with 707 additions and 518 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
doc/man/restic-dump.1
View File

@@ -1,5 +1,5 @@
.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
@@ -19,9 +19,14 @@ 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
The special snapshotID "latest" can be used to use the latest snapshot in the
repository.
.PP
To include the folder content at the root of the archive, you can use the
":" syntax, where "subfolder" is a path within the
snapshot.
.SH EXIT STATUS
.PP
@@ -31,7 +36,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.SH OPTIONS
.PP
\fB-a\fP, \fB--archive\fP="tar"
set archive \fB\fCformat\fR as "tar" or "zip"
set archive \fBformat\fR as "tar" or "zip"
.PP
\fB-h\fP, \fB--help\fP[=false]
@@ -39,25 +44,25 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.PP
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when snapshot ID "latest" is given (can be specified multiple times)
only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB--path\fP=[]
only consider snapshots including this (absolute) \fB\fCpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB--tag\fP=[]
only consider snapshots including \fB\fCtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times)
only consider snapshots including \fBtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
.PP
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
set the cache \fBdirectory\fR\&. (default: use system default cache directory)
.PP
\fB--cleanup-cache\fP[=false]
@@ -77,15 +82,15 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.PP
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
\fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB--limit-download\fP=0
limits downloads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
.PP
\fB--limit-upload\fP=0
limits uploads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
.PP
\fB--no-cache\fP[=false]
@@ -97,19 +102,19 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.PP
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
set extended option (\fBkey=value\fR, can be specified multiple times)
.PP
\fB--pack-size\fP=0
set target pack \fB\fCsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
\fBfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
@@ -117,11 +122,11 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.PP
\fB-r\fP, \fB--repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
.PP
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB--retry-lock\fP=0s
@@ -129,7 +134,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er
.PP
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
.PP
\fB-v\fP, \fB--verbose\fP[=0]