TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-08-22 17:57:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update manpages and auto-completion

Browse Source
This commit is contained in:
Alexander Neumann
2025-03-27 20:16:56 +01:00
parent 0e5f41c842
commit ab024e6a51
39 changed files with 117 additions and 276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/bash-completion.sh
View File

@@ -1161,6 +1161,10 @@ _restic_find()
two_word_flags+=("--path")
local_nonpersistent_flags+=("--path")
local_nonpersistent_flags+=("--path=")
flags+=("--reverse")
flags+=("-R")
local_nonpersistent_flags+=("--reverse")
local_nonpersistent_flags+=("-R")
flags+=("--show-pack-id")
local_nonpersistent_flags+=("--show-pack-id")
flags+=("--snapshot=")
@@ -1349,6 +1353,10 @@ _restic_forget()
local_nonpersistent_flags+=("--repack-small")
flags+=("--repack-uncompressed")
local_nonpersistent_flags+=("--repack-uncompressed")
flags+=("--repack-smaller-than=")
two_word_flags+=("--repack-smaller-than")
local_nonpersistent_flags+=("--repack-smaller-than")
local_nonpersistent_flags+=("--repack-smaller-than=")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@@ -2224,6 +2232,14 @@ _restic_ls()
local_nonpersistent_flags+=("--path=")
flags+=("--recursive")
local_nonpersistent_flags+=("--recursive")
flags+=("--reverse")
local_nonpersistent_flags+=("--reverse")
flags+=("--sort=")
two_word_flags+=("--sort")
two_word_flags+=("-s")
local_nonpersistent_flags+=("--sort")
local_nonpersistent_flags+=("--sort=")
local_nonpersistent_flags+=("-s")
flags+=("--tag=")
two_word_flags+=("--tag")
local_nonpersistent_flags+=("--tag")
@@ -2556,6 +2572,10 @@ _restic_prune()
local_nonpersistent_flags+=("--repack-cacheable-only")
flags+=("--repack-small")
local_nonpersistent_flags+=("--repack-small")
flags+=("--repack-smaller-than=")
two_word_flags+=("--repack-smaller-than")
local_nonpersistent_flags+=("--repack-smaller-than")
local_nonpersistent_flags+=("--repack-smaller-than=")
flags+=("--repack-uncompressed")
local_nonpersistent_flags+=("--repack-uncompressed")
flags+=("--unsafe-recover-no-free-space=")
@@ -3085,6 +3105,10 @@ _restic_restore()
two_word_flags+=("--exclude-file")
local_nonpersistent_flags+=("--exclude-file")
local_nonpersistent_flags+=("--exclude-file=")
flags+=("--exclude-xattr=")
two_word_flags+=("--exclude-xattr")
local_nonpersistent_flags+=("--exclude-xattr")
local_nonpersistent_flags+=("--exclude-xattr=")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@@ -3121,6 +3145,10 @@ _restic_restore()
two_word_flags+=("--include-file")
local_nonpersistent_flags+=("--include-file")
local_nonpersistent_flags+=("--include-file=")
flags+=("--include-xattr=")
two_word_flags+=("--include-xattr")
local_nonpersistent_flags+=("--include-xattr")
local_nonpersistent_flags+=("--include-xattr=")
flags+=("--overwrite=")
two_word_flags+=("--overwrite")
local_nonpersistent_flags+=("--overwrite")
@@ -3255,6 +3283,10 @@ _restic_rewrite()
two_word_flags+=("--path")
local_nonpersistent_flags+=("--path")
local_nonpersistent_flags+=("--path=")
flags+=("--snapshot-summary")
flags+=("-s")
local_nonpersistent_flags+=("--snapshot-summary")
local_nonpersistent_flags+=("-s")
flags+=("--tag=")
two_word_flags+=("--tag")
local_nonpersistent_flags+=("--tag")

7
doc/man/restic-backup.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-backup - Create a new backup of files and/or directories
.SH SYNOPSIS
.PP
\fBrestic backup [flags] [FILE/DIR] ...\fP
.SH DESCRIPTION
.PP
The "backup" command creates a new snapshot and saves the files and directories
given as the arguments.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was a fatal error (no snapshot created).
Exit status is 3 if some source data could not be read (incomplete snapshot created).
@@ -28,7 +24,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-n\fP, \fB--dry-run\fP[=false]
do not upload or write any data, just show what would be done
@@ -142,7 +137,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -244,5 +238,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-cache.1
View File

@@ -2,28 +2,23 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-cache - Operate on local cache directories
.SH SYNOPSIS
.PP
\fBrestic cache [flags]\fP
.SH DESCRIPTION
.PP
The "cache" command allows listing and cleaning local cache directories.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB--cleanup\fP[=false]
remove old cache directories
@@ -41,7 +36,6 @@ Exit status is 1 if there was any error.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -143,5 +137,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-cat.1
View File

@@ -2,22 +2,18 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-cat - Print internal objects to stdout
.SH SYNOPSIS
.PP
\fBrestic cat [flags] [masterkey|config|pack ID|blob ID|snapshot ID|index ID|key ID|lock ID|tree snapshot:subfolder]\fP
.SH DESCRIPTION
.PP
The "cat" command is used to print internal objects to stdout.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -26,13 +22,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for cat
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -134,5 +128,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-check.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-check - Check the repository for errors
.SH SYNOPSIS
.PP
\fBrestic check [flags]\fP
.SH DESCRIPTION
.PP
The "check" command tests the repository for errors and reports any errors it
finds. It can also be used to read all data and therefore simulate a restore.
@@ -22,7 +19,6 @@ repository and not use a local cache.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -31,7 +27,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for check
@@ -49,7 +44,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -151,5 +145,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-copy.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-copy - Copy snapshots from one repository to another
.SH SYNOPSIS
.PP
\fBrestic copy [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
The "copy" command copies one or more snapshots from one repository to another.
.PP
@@ -31,7 +28,6 @@ new destination repository using the "init" command.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -40,7 +36,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB--from-insecure-no-password\fP[=false]
use an empty password for the source repository (insecure)
@@ -82,7 +77,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -184,5 +178,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

11
doc/man/restic-diff.1
View File

@@ -2,22 +2,17 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-diff - Show differences between two snapshots
.SH SYNOPSIS
.PP
\fBrestic diff [flags] snapshotID snapshotID\fP
.SH DESCRIPTION
.PP
The "diff" command shows differences from the first to the second snapshot. The
first characters in each line display what has happened to a particular file or
directory:
.RS
.IP \(bu 2
+ The item was added
.IP \(bu 2
@@ -31,8 +26,6 @@ T The type was changed, e.g. a file was made a symlink
.IP \(bu 2
? Bitrot detected: The file's content has changed but all metadata is the same
.RE
.PP
Metadata comparison will likely not work if a backup was created using the
\&'--ignore-inode' or '--ignore-ctime' option.
@@ -44,7 +37,6 @@ snapshot.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -53,7 +45,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for diff
@@ -63,7 +54,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -165,5 +155,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

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

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-dump - Print a backed-up file to stdout
.SH SYNOPSIS
.PP
\fBrestic dump [flags] snapshotID file\fP
.SH DESCRIPTION
.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 (default) or zip file containing the contents of the specified folder.
@@ -29,7 +26,6 @@ snapshot.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -38,7 +34,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-a\fP, \fB--archive\fP="tar"
set archive \fBformat\fR as "tar" or "zip"
@@ -64,7 +59,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -166,5 +160,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-features.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-features - Print list of feature flags
.SH SYNOPSIS
.PP
\fBrestic features [flags]\fP
.SH DESCRIPTION
.PP
The "features" command prints a list of supported feature flags.
.PP
@@ -28,19 +25,16 @@ A \fIdeprecated\fP feature is always disabled and cannot be enabled. The flag wi
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for features
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -142,5 +136,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

12
doc/man/restic-find.1
View File

@@ -2,24 +2,22 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-find - Find a file, a directory or restic IDs
.SH SYNOPSIS
.PP
\fBrestic find [flags] PATTERN...\fP
.SH DESCRIPTION
.PP
The "find" command searches for files or directories in snapshots stored in the
repo.
It can also be used to search for restic blobs or trees for troubleshooting.
The default sort option for the snapshots is youngest to oldest. To sort the
output from oldest to youngest specify --reverse.
.SH OPTIONS
.PP
\fB--blob\fP[=false]
pattern is a blob-ID
@@ -59,6 +57,10 @@ It can also be used to search for restic blobs or trees for troubleshooting.
\fB--path\fP=[]
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths)
.PP
\fB-R\fP, \fB--reverse\fP[=false]
reverse sort order oldest to newest
.PP
\fB--show-pack-id\fP[=false]
display the pack-ID the blobs belong to (with --blob or --tree)
@@ -77,7 +79,6 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -200,5 +201,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

13
doc/man/restic-forget.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-forget - Remove snapshots from the repository
.SH SYNOPSIS
.PP
\fBrestic forget [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION
.PP
The "forget" command removes snapshots according to a policy. All snapshots are
first divided into groups according to "--group-by", and after that the policy
specified by the "--keep-\fI" options is applied to each group individually.
@@ -31,7 +28,6 @@ security considerations.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -40,7 +36,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-l\fP, \fB--keep-last\fP=0
keep the last \fBn\fR snapshots (use 'unlimited' to keep all snapshots)
@@ -130,7 +125,7 @@ Exit status is 12 if the password is incorrect.
.PP
\fB--max-repack-size\fP=""
maximum \fBsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
stop after repacking this much data in total (allowed suffixes for \fBsize\fR: k/K, m/M, g/G, t/T)
.PP
\fB--repack-cacheable-only\fP[=false]
@@ -144,13 +139,16 @@ Exit status is 12 if the password is incorrect.
\fB--repack-uncompressed\fP[=false]
repack all uncompressed data
.PP
\fB--repack-smaller-than\fP=""
pack \fBbelow-limit\fR packfiles (allowed suffixes: k/K, m/M)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for forget
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -252,5 +250,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

15
doc/man/restic-generate.1
View File

@@ -2,35 +2,30 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-generate - Generate manual pages and auto-completion files (bash, fish, zsh, powershell)
.SH SYNOPSIS
.PP
\fBrestic generate [flags]\fP
.SH DESCRIPTION
.PP
The "generate" command writes automatically generated files (like the man pages
and the auto-completion files for bash, fish and zsh).
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB--bash-completion\fP=""
write bash completion \fBfile\fR
write bash completion \fBfile\fR (\fB-\fR for stdout)
.PP
\fB--fish-completion\fP=""
write fish completion \fBfile\fR
write fish completion \fBfile\fR (\fB-\fR for stdout)
.PP
\fB-h\fP, \fB--help\fP[=false]
@@ -42,15 +37,14 @@ Exit status is 1 if there was any error.
.PP
\fB--powershell-completion\fP=""
write powershell completion \fBfile\fR
write powershell completion \fBfile\fR (\fB-\fR for stdout)
.PP
\fB--zsh-completion\fP=""
write zsh completion \fBfile\fR
write zsh completion \fBfile\fR (\fB-\fR for stdout)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -152,5 +146,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-init.1
View File

@@ -2,28 +2,23 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-init - Initialize a new repository
.SH SYNOPSIS
.PP
\fBrestic init [flags]\fP
.SH DESCRIPTION
.PP
The "init" command initializes a new repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB--copy-chunker-params\fP[=false]
copy chunker parameters from the secondary repository (useful with the copy command)
@@ -61,7 +56,6 @@ Exit status is 1 if there was any error.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -163,5 +157,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-key-add.1
View File

@@ -2,22 +2,18 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-key-add - Add a new key (password) to the repository; returns the new key ID
.SH SYNOPSIS
.PP
\fBrestic key add [flags]\fP
.SH DESCRIPTION
.PP
The "add" sub-command creates a new key and validates the key. Returns the new key ID.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -26,7 +22,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for add
@@ -48,7 +43,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -150,5 +144,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-key(1)\fP

7
doc/man/restic-key-list.1
View File

@@ -2,24 +2,20 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-key-list - List keys (passwords)
.SH SYNOPSIS
.PP
\fBrestic key list [flags]\fP
.SH DESCRIPTION
.PP
The "list" sub-command lists all the keys (passwords) associated with the repository.
Returns the key ID, username, hostname, created time and if it's the current key being
used to access the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -28,13 +24,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for list
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -136,5 +130,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-key(1)\fP

7
doc/man/restic-key-passwd.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-key-passwd - Change key (password); creates a new key ID and removes the old key ID, returns new key ID
.SH SYNOPSIS
.PP
\fBrestic key passwd [flags]\fP
.SH DESCRIPTION
.PP
The "passwd" sub-command creates a new key, validates the key and remove the old key ID.
Returns the new key ID.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -27,7 +23,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for passwd
@@ -49,7 +44,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -151,5 +145,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-key(1)\fP

7
doc/man/restic-key-remove.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-key-remove - Remove key ID (password) from the repository.
.SH SYNOPSIS
.PP
\fBrestic key remove [ID] [flags]\fP
.SH DESCRIPTION
.PP
The "remove" sub-command removes the selected key ID. The "remove" command does not allow
removing the current key being used to access the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -27,13 +23,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for remove
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -135,5 +129,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-key(1)\fP

6
doc/man/restic-key.1
View File

@@ -2,29 +2,24 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-key - Manage keys (passwords)
.SH SYNOPSIS
.PP
\fBrestic key [flags]\fP
.SH DESCRIPTION
.PP
The "key" command allows you to set multiple access keys or passwords
per repository.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for key
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -126,5 +121,4 @@ per repository.
.SH SEE ALSO
.PP
\fBrestic(1)\fP, \fBrestic-key-add(1)\fP, \fBrestic-key-list(1)\fP, \fBrestic-key-passwd(1)\fP, \fBrestic-key-remove(1)\fP

7
doc/man/restic-list.1
View File

@@ -2,22 +2,18 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-list - List objects in the repository
.SH SYNOPSIS
.PP
\fBrestic list [flags] [blobs|packs|index|snapshots|keys|locks]\fP
.SH DESCRIPTION
.PP
The "list" command allows listing objects in the repository based on type.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -26,13 +22,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for list
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -134,5 +128,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

20
doc/man/restic-ls.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-ls - List files in a snapshot
.SH SYNOPSIS
.PP
\fBrestic ls [flags] snapshotID [dir...]\fP
.SH DESCRIPTION
.PP
The "ls" command lists files and directories in a snapshot.
.PP
@@ -30,9 +27,13 @@ will allow traversing into matching directories' subfolders.
Any directory paths specified must be absolute (starting with
a path separator); paths use the forward slash '/' as separator.
.PP
File listings can be sorted by specifying --sort followed by one of the
sort specifiers '(name|size|time=mtime|atime|ctime|extension)'.
The sorting can be reversed by specifying --reverse.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -41,7 +42,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for ls
@@ -69,13 +69,20 @@ Exit status is 12 if the password is incorrect.
\fB--recursive\fP[=false]
include files in subfolders of the listed directories
.PP
\fB--reverse\fP[=false]
reverse sorted output
.PP
\fB-s\fP, \fB--sort\fP=name
sort output by (name|size|time=mtime|atime|ctime|extension)
.PP
\fB--tag\fP=[]
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=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -177,5 +184,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-migrate.1
View File

@@ -2,24 +2,20 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-migrate - Apply migrations
.SH SYNOPSIS
.PP
\fBrestic migrate [flags] [migration name] [...]\fP
.SH DESCRIPTION
.PP
The "migrate" command checks which migrations can be applied for a repository
and prints a list with available migration names. If one or more migration
names are specified, these migrations are applied.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -28,7 +24,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-f\fP, \fB--force\fP[=false]
apply a migration a second time
@@ -38,7 +33,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -140,5 +134,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

8
doc/man/restic-mount.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-mount - Mount the repository
.SH SYNOPSIS
.PP
\fBrestic mount [flags] mountpoint\fP
.SH DESCRIPTION
.PP
The "mount" command mounts the repository via fuse to a directory. This is a
read-only mount.
.SH Snapshot Directories
.PP
If you need a different template for directories that contain snapshots,
you can pass a time template via --time-template and path templates via
--path-template.
@@ -59,7 +55,6 @@ The default path templates are:
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -68,7 +63,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB--allow-other\fP[=false]
allow other users to access the data in the mounted directory
@@ -106,7 +100,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -208,5 +201,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-options.1
View File

@@ -2,34 +2,28 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-options - Print list of extended options
.SH SYNOPSIS
.PP
\fBrestic options [flags]\fP
.SH DESCRIPTION
.PP
The "options" command prints a list of extended options.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for options
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -131,5 +125,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

13
doc/man/restic-prune.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-prune - Remove unneeded data from the repository
.SH SYNOPSIS
.PP
\fBrestic prune [flags]\fP
.SH DESCRIPTION
.PP
The "prune" command checks the repository and removes data that is not
referenced and therefore not needed any more.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -27,7 +23,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-n\fP, \fB--dry-run\fP[=false]
do not modify the repository, just print what would be done
@@ -37,7 +32,7 @@ Exit status is 12 if the password is incorrect.
.PP
\fB--max-repack-size\fP=""
maximum \fBsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
stop after repacking this much data in total (allowed suffixes for \fBsize\fR: k/K, m/M, g/G, t/T)
.PP
\fB--max-unused\fP="5%"
@@ -51,6 +46,10 @@ Exit status is 12 if the password is incorrect.
\fB--repack-small\fP[=false]
repack pack files below 80% of target pack size
.PP
\fB--repack-smaller-than\fP=""
pack \fBbelow-limit\fR packfiles (allowed suffixes: k/K, m/M)
.PP
\fB--repack-uncompressed\fP[=false]
repack all uncompressed data
@@ -61,7 +60,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -163,5 +161,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-recover.1
View File

@@ -2,24 +2,20 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-recover - Recover data from the repository not referenced by snapshots
.SH SYNOPSIS
.PP
\fBrestic recover [flags]\fP
.SH DESCRIPTION
.PP
The "recover" command builds a new snapshot from all directories it can find in
the raw data of the repository which are not referenced in an existing snapshot.
It can be used if, for example, a snapshot has been removed by accident with "forget".
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -28,13 +24,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for recover
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -136,5 +130,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-repair-index.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-repair-index - Build a new index
.SH SYNOPSIS
.PP
\fBrestic repair index [flags]\fP
.SH DESCRIPTION
.PP
The "repair index" command creates a new index based on the pack files in the
repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -27,7 +23,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for index
@@ -37,7 +32,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -139,5 +133,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-repair(1)\fP

7
doc/man/restic-repair-packs.1
View File

@@ -2,23 +2,19 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-repair-packs - Salvage damaged pack files
.SH SYNOPSIS
.PP
\fBrestic repair packs [packIDs...] [flags]\fP
.SH DESCRIPTION
.PP
The "repair packs" command extracts intact blobs from the specified pack files, rebuilds
the index to remove the damaged pack files and removes the pack files from the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -27,13 +23,11 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for packs
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -135,5 +129,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-repair(1)\fP

8
doc/man/restic-repair-snapshots.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-repair-snapshots - Repair snapshots
.SH SYNOPSIS
.PP
\fBrestic repair snapshots [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION
.PP
The "repair snapshots" command repairs broken snapshots. It scans the given
snapshots and generates new ones with damaged directories and file contents
removed. If the broken snapshots are deleted, a prune run will be able to
@@ -24,7 +21,6 @@ first!
.SH WARNING
.PP
Repairing and deleting broken snapshots causes data loss! It will remove broken
directories and modify broken files in the modified snapshots.
@@ -36,7 +32,6 @@ snapshot!
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -45,7 +40,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-n\fP, \fB--dry-run\fP[=false]
do not do anything, just print what would be done
@@ -71,7 +65,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -173,5 +166,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic-repair(1)\fP

6
doc/man/restic-repair.1
View File

@@ -2,28 +2,23 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-repair - Repair the repository
.SH SYNOPSIS
.PP
\fBrestic repair [flags]\fP
.SH DESCRIPTION
.PP
Repair the repository
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for repair
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -125,5 +120,4 @@ Repair the repository
.SH SEE ALSO
.PP
\fBrestic(1)\fP, \fBrestic-repair-index(1)\fP, \fBrestic-repair-packs(1)\fP, \fBrestic-repair-snapshots(1)\fP

17
doc/man/restic-restore.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-restore - Extract the data from a snapshot
.SH SYNOPSIS
.PP
\fBrestic restore [flags] snapshotID\fP
.SH DESCRIPTION
.PP
The "restore" command extracts the data from a snapshot from the repository to
a directory.
@@ -26,7 +23,6 @@ syntax, where "subfolder" is a path within the snapshot.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -35,7 +31,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB--delete\fP[=false]
delete files from target directory if they do not exist in snapshot. Use '--dry-run -vv' to check what would be deleted
@@ -51,6 +46,10 @@ Exit status is 12 if the password is incorrect.
\fB--exclude-file\fP=[]
read exclude patterns from a \fBfile\fR (can be specified multiple times)
.PP
\fB--exclude-xattr\fP=[]
exclude xattr by \fBpattern\fR (can be specified multiple times)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for restore
@@ -83,9 +82,13 @@ Exit status is 12 if the password is incorrect.
\fB--include-file\fP=[]
read include patterns from a \fBfile\fR (can be specified multiple times)
.PP
\fB--include-xattr\fP=[]
include xattr by \fBpattern\fR (can be specified multiple times)
.PP
\fB--overwrite\fP=always
overwrite behavior, one of (always|if-changed|if-newer|never) (default: always)
overwrite behavior, one of (always|if-changed|if-newer|never)
.PP
\fB--path\fP=[]
@@ -109,7 +112,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -211,5 +213,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

20
doc/man/restic-rewrite.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-rewrite - Rewrite snapshots to exclude unwanted files
.SH SYNOPSIS
.PP
\fBrestic rewrite [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
The "rewrite" command excludes files from existing snapshots. It creates new
snapshots containing the same data as the original ones, but without the files
you specify to exclude. All metadata (time, host, tags) will be preserved.
@@ -32,9 +29,17 @@ Please note that the --forget option only removes the snapshots and not the actu
data stored in the repository. In order to delete the no longer referenced data,
use the "prune" command.
.PP
When rewrite is used with the --snapshot-summary option, a new snapshot is
created containing statistics summary data. Only two fields in the summary will
be non-zero: TotalFilesProcessed and TotalBytesProcessed.
.PP
When rewrite is called with one of the --exclude options, TotalFilesProcessed
and TotalBytesProcessed will be updated in the snapshot summary.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -43,7 +48,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-n\fP, \fB--dry-run\fP[=false]
do not do anything, just print what would be done
@@ -87,13 +91,16 @@ Exit status is 12 if the password is incorrect.
\fB--path\fP=[]
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths)
.PP
\fB-s\fP, \fB--snapshot-summary\fP[=false]
create snapshot summary record if it does not exist
.PP
\fB--tag\fP=[]
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -195,5 +202,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-self-update.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-self-update - Update the restic binary
.SH SYNOPSIS
.PP
\fBrestic self-update [flags]\fP
.SH DESCRIPTION
.PP
The command "self-update" downloads the latest stable release of restic from
GitHub and replaces the currently running binary. After download, the
authenticity of the binary is verified using the GPG signature on the release
@@ -20,7 +17,6 @@ files.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -29,7 +25,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for self-update
@@ -39,7 +34,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -141,5 +135,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-snapshots.1
View File

@@ -2,22 +2,18 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-snapshots - List all snapshots
.SH SYNOPSIS
.PP
\fBrestic snapshots [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
The "snapshots" command lists all snapshots stored in the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -26,7 +22,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-c\fP, \fB--compact\fP[=false]
use compact output format
@@ -56,7 +51,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -158,5 +152,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

11
doc/man/restic-stats.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-stats - Scan the repository and show basic statistics
.SH SYNOPSIS
.PP
\fBrestic stats [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION
.PP
The "stats" command walks one or multiple snapshots in a repository
and accumulates statistics about the data stored therein. It reports
on the number of unique files and their sizes, according to one of
@@ -27,8 +24,6 @@ depending on what you are trying to calculate.
.PP
The modes are:
.RS
.IP \(bu 2
restore-size: (default) Counts the size of the restored files.
.IP \(bu 2
@@ -40,14 +35,11 @@ how many files reference them.
.IP \(bu 2
blobs-per-file: A combination of files-by-contents and raw-data.
.RE
.PP
Refer to the online manual for more details about each mode.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -56,7 +48,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for stats
@@ -78,7 +69,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -180,5 +170,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-tag.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-tag - Modify tags on snapshots
.SH SYNOPSIS
.PP
\fBrestic tag [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
The "tag" command allows you to modify tags on exiting snapshots.
.PP
@@ -24,7 +21,6 @@ When no snapshotID is given, all snapshots matching the host, tag and path filte
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
@@ -33,7 +29,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS
.PP
\fB--add\fP=[]
\fBtags\fR which will be added to the existing tags in the format \fBtag[,tag,...]\fR (can be given multiple times)
@@ -63,7 +58,6 @@ Exit status is 12 if the password is incorrect.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -165,5 +159,4 @@ Exit status is 12 if the password is incorrect.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-unlock.1
View File

@@ -2,28 +2,23 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-unlock - Remove locks other processes created
.SH SYNOPSIS
.PP
\fBrestic unlock [flags]\fP
.SH DESCRIPTION
.PP
The "unlock" command removes stale locks that have been created by other restic processes.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for unlock
@@ -33,7 +28,6 @@ Exit status is 1 if there was any error.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -135,5 +129,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

7
doc/man/restic-version.1
View File

@@ -2,35 +2,29 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-version - Print version information
.SH SYNOPSIS
.PP
\fBrestic version [flags]\fP
.SH DESCRIPTION
.PP
The "version" command prints detailed information about the build environment
and the version of this software.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for version
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -132,5 +126,4 @@ Exit status is 1 if there was any error.
.SH SEE ALSO
.PP
\fBrestic(1)\fP

5
doc/man/restic.1
View File

@@ -2,17 +2,14 @@
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic - Backup and restore files
.SH SYNOPSIS
.PP
\fBrestic [flags]\fP
.SH DESCRIPTION
.PP
restic is a backup program which allows saving multiple revisions of files and
directories in an encrypted repository stored on different backends.
@@ -21,7 +18,6 @@ The full documentation can be found at https://restic.readthedocs.io/ .
.SH OPTIONS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
@@ -127,5 +123,4 @@ The full documentation can be found at https://restic.readthedocs.io/ .
.SH SEE ALSO
.PP
\fBrestic-backup(1)\fP, \fBrestic-cache(1)\fP, \fBrestic-cat(1)\fP, \fBrestic-check(1)\fP, \fBrestic-copy(1)\fP, \fBrestic-diff(1)\fP, \fBrestic-dump(1)\fP, \fBrestic-features(1)\fP, \fBrestic-find(1)\fP, \fBrestic-forget(1)\fP, \fBrestic-generate(1)\fP, \fBrestic-init(1)\fP, \fBrestic-key(1)\fP, \fBrestic-list(1)\fP, \fBrestic-ls(1)\fP, \fBrestic-migrate(1)\fP, \fBrestic-mount(1)\fP, \fBrestic-options(1)\fP, \fBrestic-prune(1)\fP, \fBrestic-recover(1)\fP, \fBrestic-repair(1)\fP, \fBrestic-restore(1)\fP, \fBrestic-rewrite(1)\fP, \fBrestic-self-update(1)\fP, \fBrestic-snapshots(1)\fP, \fBrestic-stats(1)\fP, \fBrestic-tag(1)\fP, \fBrestic-unlock(1)\fP, \fBrestic-version(1)\fP

35
doc/powershell-completion.ps1
View File

@@ -125,7 +125,10 @@ filter __restic_escapeStringWithSpecialChars {
if (-Not $Description) {
$Description = " "
}
@{Name="$Name";Description="$Description"}
New-Object -TypeName PSCustomObject -Property @{
Name = "$Name"
Description = "$Description"
}
}
@@ -203,7 +206,12 @@ filter __restic_escapeStringWithSpecialChars {
__restic_debug "Only one completion left"
# insert space after value
[System.Management.Automation.CompletionResult]::new($($comp.Name | __restic_escapeStringWithSpecialChars) + $Space, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
$CompletionText = $($comp.Name | __restic_escapeStringWithSpecialChars) + $Space
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
} else {
$CompletionText
}
} else {
# Add the proper number of spaces to align the descriptions
@@ -218,7 +226,12 @@ filter __restic_escapeStringWithSpecialChars {
$Description = " ($($comp.Description))"
}
[System.Management.Automation.CompletionResult]::new("$($comp.Name)$Description", "$($comp.Name)$Description", 'ParameterValue', "$($comp.Description)")
$CompletionText = "$($comp.Name)$Description"
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)$Description", 'ParameterValue', "$($comp.Description)")
} else {
$CompletionText
}
}
}
@@ -227,7 +240,13 @@ filter __restic_escapeStringWithSpecialChars {
# insert space after value
# MenuComplete will automatically show the ToolTip of
# the highlighted value at the bottom of the suggestions.
[System.Management.Automation.CompletionResult]::new($($comp.Name | __restic_escapeStringWithSpecialChars) + $Space, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
$CompletionText = $($comp.Name | __restic_escapeStringWithSpecialChars) + $Space
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
} else {
$CompletionText
}
}
# TabCompleteNext and in case we get something unknown
@@ -235,7 +254,13 @@ filter __restic_escapeStringWithSpecialChars {
# Like MenuComplete but we don't want to add a space here because
# the user need to press space anyway to get the completion.
# Description will not be shown because that's not possible with TabCompleteNext
[System.Management.Automation.CompletionResult]::new($($comp.Name | __restic_escapeStringWithSpecialChars), "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
$CompletionText = $($comp.Name | __restic_escapeStringWithSpecialChars)
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
} else {
$CompletionText
}
}
}