diff options
Diffstat (limited to 'docs/man')
31 files changed, 321 insertions, 272 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index ed1a5e1e0..c763aae31 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK-CRUD 1 "2017-05-17" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. . diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index 0f46eb8a6..79e356ac1 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK 1 "2017-05-17" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command . diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index a7275b0c0..7b4291cd5 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BREAK-LOCK 1 "2017-05-17" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. . diff --git a/docs/man/borg-change-passphrase.1 b/docs/man/borg-change-passphrase.1 index a4649a71e..d5b3edbfa 100644 --- a/docs/man/borg-change-passphrase.1 +++ b/docs/man/borg-change-passphrase.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHANGE-PASSPHRASE 1 "2017-05-17" "" "borg backup tool" +.TH BORG-CHANGE-PASSPHRASE 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-change-passphrase \- Change repository key file passphrase . diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index cb694cac1..cf2996a2a 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHECK 1 "2017-05-17" "" "borg backup tool" +.TH BORG-CHECK 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency . @@ -55,7 +55,7 @@ stored in the segments. If you use a remote repo server via ssh:, the repo check is executed on the repo server without causing significant network traffic. .IP \(bu 2 -The repository check can be skipped using the \-\-archives\-only option. +The repository check can be skipped using the \fB\-\-archives\-only\fP option. .UNINDENT .sp Second, the consistency and correctness of the archive metadata is verified: @@ -84,10 +84,10 @@ decryption and this is always done client\-side, because key access will be required). .IP \(bu 2 The archive checks can be time consuming, they can be skipped using the -\-\-repository\-only option. +\fB\-\-repository\-only\fP option. .UNINDENT .sp -The \-\-verify\-data option will perform a full integrity verification (as opposed to +The \fB\-\-verify\-data\fP option will perform a full integrity verification (as opposed to checking the CRC32 of the segment) of data, which means reading the data from the repository, decrypting and decompressing it. This is a cryptographic verification, which will detect (accidental) corruption. For encrypted repositories it is @@ -113,7 +113,7 @@ only perform repository checks only perform archives checks .TP .B \-\-verify\-data -perform cryptographic archive data integrity verification (conflicts with \-\-repository\-only) +perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP) .TP .B \-\-repair attempt to repair any inconsistencies found @@ -125,7 +125,10 @@ work slower, but using less space .INDENT 0.0 .TP .B \-P\fP,\fB \-\-prefix -only consider archive names starting with this prefix +only consider archive names starting with this prefix. +.TP +.B \-a\fP,\fB \-\-glob\-archives +only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .B \-\-sort\-by Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 223fd33a7..f48ccb6c1 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMMON 1 "2017-05-17" "" "borg backup tool" +.TH BORG-COMMON 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands . diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 9e176f224..3347a6582 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPRESSION 1 "2017-05-17" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression . @@ -32,57 +32,48 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH DESCRIPTION .sp +It is no problem to mix different compression methods in one repo, +deduplication is done on the source data chunks (not on the compressed +or encrypted data). +.sp +If some specific chunk was once compressed and stored into the repo, creating +another backup that also uses this chunk will not change the stored chunk. +So if you use different compression specs for the backups, whichever stores a +chunk first determines its compression. See also borg recreate. +.sp Compression is lz4 by default. If you want something else, you have to specify what you want. .sp Valid compression specifiers are: -.sp -none .INDENT 0.0 -.INDENT 3.5 +.TP +.B none Do not compress. -.UNINDENT -.UNINDENT -.sp -lz4 -.INDENT 0.0 -.INDENT 3.5 +.TP +.B lz4 Use lz4 compression. High speed, low compression. (default) -.UNINDENT -.UNINDENT -.sp -zlib[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. If you do not explicitely give the compression level L (ranging from 0 to 9), it will use level 6. Giving level 0 (means "no compression", but still has zlib protocol overhead) is usually pointless, you better use "none" compression. -.UNINDENT -.UNINDENT -.sp -lzma[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B lzma[,L] Use lzma ("xz") compression. Low speed, high compression. If you do not explicitely give the compression level L (ranging from 0 to 9), it will use level 6. Giving levels above 6 is pointless and counterproductive because it does not compress better due to the buffer size used by borg \- but it wastes lots of CPU cycles and RAM. -.UNINDENT -.UNINDENT -.sp -auto,C[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B auto,C[,L] Use a built\-in heuristic to decide per chunk whether to compress or not. The heuristic tries with lz4 whether the data is compressible. For incompressible data, it will not use compression (uses "none"). For compressible data, it uses the given C[,L] compression \- with C[,L] being any valid compression specifier. .UNINDENT -.UNINDENT .sp Examples: .INDENT 0.0 @@ -99,17 +90,6 @@ borg create \-\-compression auto,lzma ... .fi .UNINDENT .UNINDENT -.sp -General remarks: -.sp -It is no problem to mix different compression methods in one repo, -deduplication is done on the source data chunks (not on the compressed -or encrypted data). -.sp -If some specific chunk was once compressed and stored into the repo, creating -another backup that also uses this chunk will not change the stored chunk. -So if you use different compression specs for the backups, whichever stores a -chunk first determines its compression. See also borg recreate. .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 0cae7ca0c..ec8d7b525 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CREATE 1 "2017-05-17" "" "borg backup tool" +.TH BORG-CREATE 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-create \- Create new archive . @@ -54,7 +54,7 @@ In the archive name, you may use the following placeholders: {now}, {utcnow}, {fqdn}, {hostname}, {user} and some others. .sp To speed up pulling backups over sshfs and similar network file systems which do -not provide correct inode information the \-\-ignore\-inode flag can be used. This +not provide correct inode information the \fB\-\-ignore\-inode\fP flag can be used. This potentially decreases reliability of change detection, while avoiding always reading all files on these file systems. .sp @@ -63,7 +63,7 @@ creation of a new archive to ensure fast operation. This is because the file cac is used to determine changed files quickly uses absolute filenames. If this is not possible, consider creating a bind mount to a stable location. .sp -The \-\-progress option shows (from left to right) Original, Compressed and Deduplicated +The \fB\-\-progress\fP option shows (from left to right) Original, Compressed and Deduplicated (O, C and D, respectively), then the Number of files (N) processed so far, followed by the currently processed path. .sp @@ -98,6 +98,9 @@ only display items with the given status characters .TP .B \-\-json output stats as JSON (implies \-\-stats) +.TP +.B \-\-no\-cache\-sync +experimental: do not synchronize the cache. Implies \-\-no\-files\-cache. .UNINDENT .SS Exclusion options .INDENT 0.0 @@ -118,10 +121,10 @@ exclude directories that are tagged by containing a filesystem object with the g if tag objects are specified with \-\-exclude\-if\-present, don\(aqt omit the tag objects themselves from the backup archive .TP .BI \-\-pattern \ PATTERN -include/exclude paths matching PATTERN +experimental: include/exclude paths matching PATTERN .TP .BI \-\-patterns\-from \ PATTERNFILE -read include/exclude patterns from PATTERNFILE, one per line +experimental: read include/exclude patterns from PATTERNFILE, one per line .UNINDENT .SS Filesystem options .INDENT 0.0 @@ -181,11 +184,7 @@ $ borg create /path/to/repo::my\-files \e \-\-exclude \(aq*.pyc\(aq # Backup home directories excluding image thumbnails (i.e. only -# /home/*/.thumbnails is excluded, not /home/*/*/.thumbnails) -$ borg create /path/to/repo::my\-files /home \e - \-\-exclude \(aqre:^/home/[^/]+/\e.thumbnails/\(aq - -# Do the same using a shell\-style pattern +# /home/<one directory>/.thumbnails is excluded, not /home/*/*/.thumbnails etc.) $ borg create /path/to/repo::my\-files /home \e \-\-exclude \(aqsh:/home/*/.thumbnails\(aq @@ -238,8 +237,8 @@ $ borg create /path/to/repo::daily\-projectA\-{now:%Y\-%m\-%d} projectA .UNINDENT .SH NOTES .sp -The \-\-exclude patterns are not like tar. In tar \-\-exclude .bundler/gems will -exclude foo/.bundler/gems. In borg it will not, you need to use \-\-exclude +The \fB\-\-exclude\fP patterns are not like tar. In tar \fB\-\-exclude\fP .bundler/gems will +exclude foo/.bundler/gems. In borg it will not, you need to use \fB\-\-exclude\fP \(aq*/.bundler/gems\(aq to get the same effect. See \fBborg help patterns\fP for more information. .sp diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index c7c96aa15..2e8891532 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DELETE 1 "2017-05-17" "" "borg backup tool" +.TH BORG-DELETE 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives . @@ -66,7 +66,10 @@ work slower, but using less space .INDENT 0.0 .TP .B \-P\fP,\fB \-\-prefix -only consider archive names starting with this prefix +only consider archive names starting with this prefix. +.TP +.B \-a\fP,\fB \-\-glob\-archives +only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .B \-\-sort\-by Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index b69a792be..ad030a672 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DIFF 1 "2017-05-17" "" "borg backup tool" +.TH BORG-DIFF 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives . @@ -47,7 +47,7 @@ are compared, which is very fast. .sp For archives prior to Borg 1.1 chunk contents are compared by default. If you did not create the archives with different chunker params, -pass \-\-same\-chunker\-params. +pass \fB\-\-same\-chunker\-params\fP\&. Note that the chunker params changed from Borg 0.xx to 1.0. .sp See the output of the "borg help patterns" command for more help on exclude patterns. @@ -97,10 +97,10 @@ exclude directories that are tagged by containing a filesystem object with the g if tag objects are specified with \-\-exclude\-if\-present, don\(aqt omit the tag objects themselves from the backup archive .TP .BI \-\-pattern \ PATTERN -include/exclude paths matching PATTERN +experimental: include/exclude paths matching PATTERN .TP .BI \-\-patterns\-from \ PATTERNFILE -read include/exclude patterns from PATTERNFILE, one per line +experimental: read include/exclude patterns from PATTERNFILE, one per line .UNINDENT .SH EXAMPLES .INDENT 0.0 diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 73cd98150..515b4d849 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXPORT-TAR 1 "2017-05-17" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball . @@ -39,7 +39,7 @@ This command creates a tarball from an archive. .sp When giving \(aq\-\(aq as the output FILE, Borg will write a tar stream to standard output. .sp -By default (\-\-tar\-filter=auto) Borg will detect whether the FILE should be compressed +By default (\fB\-\-tar\-filter=auto\fP) Borg will detect whether the FILE should be compressed based on its file extension and pipe the tarball through an appropriate filter before writing it to FILE: .INDENT 0.0 @@ -51,7 +51,7 @@ before writing it to FILE: \&.tar.xz: xz .UNINDENT .sp -Alternatively a \-\-tar\-filter program may be explicitly specified. It should +Alternatively a \fB\-\-tar\-filter\fP program may be explicitly specified. It should read the uncompressed tar stream from stdin and write a compressed/filtered tar stream to stdout. .sp @@ -62,7 +62,7 @@ BSD flags, ACLs, extended attributes (xattrs), atime and ctime are not exported. Timestamp resolution is limited to whole seconds, not the nanosecond resolution otherwise supported by Borg. .sp -A \-\-sparse option (as found in borg extract) is not supported. +A \fB\-\-sparse\fP option (as found in borg extract) is not supported. .sp By default the entire archive is extracted but a subset of files and directories can be selected by passing a list of \fBPATHs\fP as arguments. @@ -103,10 +103,10 @@ exclude paths matching PATTERN read exclude patterns from EXCLUDEFILE, one per line .TP .BI \-\-pattern \ PATTERN -include/exclude paths matching PATTERN +experimental: include/exclude paths matching PATTERN .TP .BI \-\-patterns\-from \ PATTERNFILE -read include/exclude patterns from PATTERNFILE, one per line +experimental: read include/exclude patterns from PATTERNFILE, one per line .TP .BI \-\-strip\-components \ NUMBER Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index dbe9c3537..13a71ab72 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXTRACT 1 "2017-05-17" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents . @@ -76,10 +76,10 @@ exclude paths matching PATTERN read exclude patterns from EXCLUDEFILE, one per line .TP .BI \-\-pattern \ PATTERN -include/exclude paths matching PATTERN +experimental: include/exclude paths matching PATTERN .TP .BI \-\-patterns\-from \ PATTERNFILE -read include/exclude patterns from PATTERNFILE, one per line +experimental: read include/exclude patterns from PATTERNFILE, one per line .TP .B \-\-numeric\-owner only obey numeric user and group identifiers diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index f235a866c..338d3ca60 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INFO 1 "2017-05-17" "" "borg backup tool" +.TH BORG-INFO 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used . @@ -67,7 +67,10 @@ format output as JSON .INDENT 0.0 .TP .B \-P\fP,\fB \-\-prefix -only consider archive names starting with this prefix +only consider archive names starting with this prefix. +.TP +.B \-a\fP,\fB \-\-glob\-archives +only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .B \-\-sort\-by Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index e25b9ca17..9576afa8d 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INIT 1 "2017-06-11" "" "borg backup tool" +.TH BORG-INIT 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository . @@ -81,6 +81,8 @@ a different keyboard layout. You can change your passphrase for existing repos at any time, it won\(aqt affect the encryption/decryption key or other secrets. .SS Encryption modes +.\" nanorst: inline-fill +. .TS center; |l|l|l|l|. @@ -103,9 +105,10 @@ SHA\-256 T} T{ none T} T{ -authenticated +\fIauthenticated\fP T} T{ -repokey, keyfile +repokey +keyfile T} _ T{ @@ -113,17 +116,22 @@ BLAKE2b T} T{ n/a T} T{ -authenticated\-blake2 +\fIauthenticated\-blake2\fP T} T{ -repokey\-blake2, -keyfile\-blake2 +\fIrepokey\-blake2\fP +\fIkeyfile\-blake2\fP T} _ .TE +.\" nanorst: inline-replace +. +.sp +\fIMarked modes\fP are new in Borg 1.1 and are not backwards\-compatible with Borg 1.0.x. .sp On modern Intel/AMD CPUs (except very cheap ones), AES is usually hardware\-accelerated. -BLAKE2b is faster than SHA256 on Intel/AMD 64\-bit CPUs, +BLAKE2b is faster than SHA256 on Intel/AMD 64\-bit CPUs +(except AMD Ryzen and future CPUs with SHA extensions), which makes \fIauthenticated\-blake2\fP faster than \fInone\fP and \fIauthenticated\fP\&. .sp On modern ARM CPUs, NEON provides hardware acceleration for SHA256 making it faster @@ -134,7 +142,7 @@ Hardware acceleration is always used automatically when available. \fIrepokey\fP and \fIkeyfile\fP use AES\-CTR\-256 for encryption and HMAC\-SHA256 for authentication in an encrypt\-then\-MAC (EtM) construction. The chunk ID hash is HMAC\-SHA256 as well (with a separate key). -These modes are compatible with borg 1.0.x. +These modes are compatible with Borg 1.0.x. .sp \fIrepokey\-blake2\fP and \fIkeyfile\-blake2\fP are also authenticated encryption modes, but use BLAKE2b\-256 instead of HMAC\-SHA256 for authentication. The chunk ID @@ -144,7 +152,7 @@ These modes are new and \fInot\fP compatible with Borg 1.0.x. \fIauthenticated\fP mode uses no encryption, but authenticates repository contents through the same HMAC\-SHA256 hash as the \fIrepokey\fP and \fIkeyfile\fP modes (it uses it as the chunk ID hash). The key is stored like \fIrepokey\fP\&. -This mode is new and \fInot\fP compatible with borg 1.0.x. +This mode is new and \fInot\fP compatible with Borg 1.0.x. .sp \fIauthenticated\-blake2\fP is like \fIauthenticated\fP, but uses the keyed BLAKE2b\-256 hash from the other blake2 modes. @@ -152,7 +160,8 @@ This mode is new and \fInot\fP compatible with Borg 1.0.x. .sp \fInone\fP mode uses no encryption and no authentication. It uses SHA256 as chunk ID hash. Not recommended, rather consider using an authenticated or -authenticated/encrypted mode. +authenticated/encrypted mode. This mode has possible denial\-of\-service issues +when running \fBborg create\fP on contents controlled by an attacker. Use it only for new repositories where no encryption is wanted \fBand\fP when compatibility with 1.0.x is important. If compatibility with 1.0.x is not important, use \fIauthenticated\-blake2\fP or \fIauthenticated\fP instead. @@ -172,7 +181,7 @@ repository to create .B \-e\fP,\fB \-\-encryption select encryption key mode \fB(required)\fP .TP -.B \-a\fP,\fB \-\-append\-only +.B \-\-append\-only create an append\-only mode repository .TP .B \-\-storage\-quota diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index 6457d3a7f..88d1b2c1a 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-05-17" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase . @@ -43,6 +43,50 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .SS arguments .sp REPOSITORY +.SH EXAMPLES +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# Create a key file protected repository +$ borg init \-\-encryption=keyfile \-v /path/to/repo +Initializing repository at "/path/to/repo" +Enter new passphrase: +Enter same passphrase again: +Remember your passphrase. Your data will be inaccessible without it. +Key in "/root/.config/borg/keys/mnt_backup" created. +Keep this key safe. Your data will be inaccessible without it. +Synchronizing chunks cache... +Archives: 0, w/ cached Idx: 0, w/ outdated Idx: 0, w/o cached Idx: 0. +Done. + +# Change key file passphrase +$ borg key change\-passphrase \-v /path/to/repo +Enter passphrase for key /root/.config/borg/keys/mnt_backup: +Enter new passphrase: +Enter same passphrase again: +Remember your passphrase. Your data will be inaccessible without it. +Key updated +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Fully automated using environment variables: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ BORG_NEW_PASSPHRASE=old borg init \-e=repokey repo +# now "old" is the current passphrase. +$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase repo +# now "new" is the current passphrase. +.ft P +.fi +.UNINDENT +.UNINDENT .SH SEE ALSO .sp \fIborg\-common(1)\fP diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 9736bba3e..236886831 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-EXPORT 1 "2017-05-17" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup . diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 2ab5af4c2..92a1754d8 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-IMPORT 1 "2017-05-17" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup . @@ -56,7 +56,7 @@ path to the backup .INDENT 0.0 .TP .B \-\-paper -interactively import from a backup done with \-\-paper +interactively import from a backup done with \fB\-\-paper\fP .UNINDENT .SH SEE ALSO .sp diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 178429792..0d408612e 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2017-05-17" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey . diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index e61f8e30a..0915aa5fd 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY 1 "2017-05-17" "" "borg backup tool" +.TH BORG-KEY 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository . diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index 66bcf1c17..3bceff410 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-LIST 1 "2017-05-17" "" "borg backup tool" +.TH BORG-LIST 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents . @@ -61,16 +61,19 @@ specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}") .TP .B \-\-json -Only valid for listing repository contents. Format output as JSON. The form of \-\-format is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available. +Only valid for listing repository contents. Format output as JSON. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available. .TP .B \-\-json\-lines -Only valid for listing archive contents. Format output as JSON Lines. The form of \-\-format is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available. +Only valid for listing archive contents. Format output as JSON Lines. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available. .UNINDENT .SS filters .INDENT 0.0 .TP |