diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 041a88a21..61a6c6a8d 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK-CRUD" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. .SH SYNOPSIS diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index 92b5515ef..74decd8d1 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command .SH SYNOPSIS diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index 31bc50bba..2d8e5755f 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BREAK-LOCK" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. .SH SYNOPSIS diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 29265c0ea..442270c13 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CHECK" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -104,15 +104,18 @@ The archive checks can be time consuming; they can be skipped using the The \fB\-\-max\-duration\fP option can be used to split a long\-running repository check into multiple partial checks. After the given number of seconds the check is interrupted. The next partial check will continue where the previous one stopped, -until the complete repository has been checked. Example: Assuming a full check took 7 +until the complete repository has been checked. Example: Assuming a complete check took 7 hours, then running a daily check with \-\-max\-duration=3600 (1 hour) resulted in one -full check per week. +completed check per week. .sp -Attention: Partial checks can only do way less checking than a full check (only the -CRC32 checks on segment file entries are done), and cannot be combined with the -\fB\-\-repair\fP option. Partial checks may therefore be useful only with very large -repositories where a full check took too long. Doing a full repository check aborts a -partial check; the next partial check will restart from the beginning. +Attention: A partial \-\-repository\-only check can only do way less checking than a full +\-\-repository\-only check: only the non\-cryptographic checksum checks on segment file +entries are done, while a full \-\-repository\-only check would also do a repo index check. +A partial check cannot be combined with the \fB\-\-repair\fP option. Partial checks +may therefore be useful only with very large repositories where a full check would take +too long. +Doing a full repository check aborts a partial check; the next partial check will restart +from the beginning. .sp 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 @@ -157,7 +160,7 @@ do only a partial repo check for max. SECONDS seconds (Default: unlimited) only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS 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 9b6f8dfa9..6bac50b8a 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMMON" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands .SH SYNOPSIS @@ -79,7 +79,7 @@ show/log the return code (rc) set umask to M (local only, default: 0077) .TP .BI \-\-remote\-path \ PATH -use PATH as borg executable on the remote (default: "borg") +use PATH as borg executable on the remote (default: \(dqborg\(dq) .TP .BI \-\-remote\-ratelimit \ RATE deprecated, use \fB\-\-upload\-ratelimit\fP instead @@ -97,7 +97,7 @@ set network upload buffer size in MiB. (default: 0=no buffer) treat part files like normal files (e.g. to list/extract them) .TP .BI \-\-debug\-profile \ FILE -Write execution profile in Borg format into FILE. For local use a Python\-compatible file can be generated by suffixing FILE with ".pyprof". +Write execution profile in Borg format into FILE. For local use a Python\-compatible file can be generated by suffixing FILE with \(dq.pyprof\(dq. .TP .BI \-\-rsh \ RSH Use this command to connect to the \(aqborg serve\(aq process (default: \(aqssh\(aq) diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index f159a0875..b95c16c09 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPACT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository .SH SYNOPSIS @@ -53,7 +53,8 @@ When using \fB\-\-verbose\fP, borg will output an estimate of the freed space. .sp After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP to clean up the numerous 17byte commit\-only segments that borg 1.1 did not clean up -due to a bug. It is enough to do that once per repository. +due to a bug. It is enough to do that once per repository. After cleaning up the +commits, borg will also do a normal compaction. .sp See \fIseparate_compaction\fP in Additional Notes for more details. .SH OPTIONS diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 274aa86ed..db5e60009 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPRESSION" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression .SH DESCRIPTION @@ -53,20 +53,20 @@ Do not compress. Use lz4 compression. Very high speed, very low compression. (default) .TP .B zstd[,L] -Use zstd ("zstandard") compression, a modern wide\-range algorithm. +Use zstd (\(dqzstandard\(dq) compression, a modern wide\-range algorithm. If you do not explicitly give the compression level L (ranging from 1 to 22), it will use level 3. Archives compressed with zstd are not compatible with borg < 1.1.4. .TP .B zlib[,L] -Use zlib ("gz") compression. Medium speed, medium compression. +Use zlib (\(dqgz\(dq) compression. Medium speed, medium compression. If you do not explicitly 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. +Giving level 0 (means \(dqno compression\(dq, but still has zlib protocol +overhead) is usually pointless, you better use \(dqnone\(dq compression. .TP .B lzma[,L] -Use lzma ("xz") compression. Low speed, high compression. +Use lzma (\(dqxz\(dq) compression. Low speed, high compression. If you do not explicitly 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 @@ -76,7 +76,7 @@ lots of CPU cycles and RAM. .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 incompressible data, it will not use compression (uses \(dqnone\(dq). For compressible data, it uses the given C[,L] compression \- with C[,L] being any valid compression specifier. .TP diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index 24e0d708c..680105470 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CONFIG" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file .SH SYNOPSIS @@ -41,8 +41,8 @@ For security reasons, this command only works on local repositories. To delete a config value entirely, use \fB\-\-delete\fP\&. To list the values of the configuration file or the default values, use \fB\-\-list\fP\&. To get and existing key, pass only the key name. To set a key, pass both the key name and -the new value. Keys can be specified in the format "section.name" or -simply "name"; the section will default to "repository" and "cache" for +the new value. Keys can be specified in the format \(dqsection.name\(dq or +simply \(dqname\(dq; the section will default to \(dqrepository\(dq and \(dqcache\(dq for the repo and cache configs, respectively. .sp By default, borg config manipulates the repository config file. Using \fB\-\-cache\fP diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 3815b178c..0c648173f 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CREATE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-create \- Create new archive .SH SYNOPSIS @@ -112,8 +112,8 @@ The \fB\-\-progress\fP option shows (from left to right) Original, Compressed an the currently processed path. .sp When using \fB\-\-stats\fP, you will get some statistics about how much data was -added \- the "This Archive" deduplicated size there is most interesting as that is -how much your repository will grow. Please note that the "All archives" stats refer to +added \- the \(dqThis Archive\(dq deduplicated size there is most interesting as that is +how much your repository will grow. Please note that the \(dqAll archives\(dq stats refer to the state after creation. Also, the \fB\-\-stats\fP and \fB\-\-dry\-run\fP options are mutually exclusive because the data is not actually compressed and deduplicated during a dry run. .sp @@ -160,7 +160,7 @@ use NAME in archive for stdin data (default: \(aqstdin\(aq) set user USER in archive for stdin data (default: \(aqroot\(aq) .TP .BI \-\-stdin\-group \ GROUP -set group GROUP in archive for stdin data (default: \(aqwheel\(aq) +set group GROUP in archive for stdin data (default: \(aqroot\(aq) .TP .BI \-\-stdin\-mode \ M set mode to M in archive for stdin data (default: 0660) @@ -265,7 +265,7 @@ write checkpoint every SECONDS seconds (Default: 1800) specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: buzhash,19,23,21,4095 .TP .BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION -select compression algorithm, see the output of the "borg help compression" command for details. +select compression algorithm, see the output of the \(dqborg help compression\(dq command for details. .UNINDENT .SH EXAMPLES .INDENT 0.0 @@ -273,7 +273,7 @@ select compression algorithm, see the output of the "borg help compression" comm .sp .nf .ft C -# Backup ~/Documents into an archive named "my\-documents" +# Backup ~/Documents into an archive named \(dqmy\-documents\(dq $ borg create /path/to/repo::my\-documents ~/Documents # same, but list all files as we process them @@ -288,17 +288,17 @@ $ borg create /path/to/repo::my\-files \e # Backup home directories excluding image thumbnails (i.e. only # /home//.thumbnails is excluded, not /home/*/*/.thumbnails etc.) $ borg create /path/to/repo::my\-files /home \e - \-\-exclude \(aqsh:/home/*/.thumbnails\(aq + \-\-exclude \(aqsh:home/*/.thumbnails\(aq -# Backup the root filesystem into an archive named "root\-YYYY\-MM\-DD" +# Backup the root filesystem into an archive named \(dqroot\-YYYY\-MM\-DD\(dq # use zlib compression (good, but slow) \- default is lz4 (fast, low compression ratio) $ borg create \-C zlib,6 \-\-one\-file\-system /path/to/repo::root\-{now:%Y\-%m\-%d} / -# Backup onto a remote host ("push" style) via ssh to port 2222, -# logging in as user "borg" and storing into /path/to/repo +# Backup onto a remote host (\(dqpush\(dq style) via ssh to port 2222, +# logging in as user \(dqborg\(dq and storing into /path/to/repo $ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}\-root\-{now} / -# Backup a remote host locally ("pull" style) using sshfs +# Backup a remote host locally (\(dqpull\(dq style) using sshfs $ mkdir sshfs\-mount $ sshfs root@example.com:/ sshfs\-mount $ cd sshfs\-mount @@ -341,7 +341,7 @@ $ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f} ~ # Backing up relative paths by moving into the correct directory first $ cd /home/user/Documents -# The root directory of the archive will be "projectA" +# The root directory of the archive will be \(dqprojectA\(dq $ borg create /path/to/repo::daily\-projectA\-{now:%Y\-%m\-%d} projectA # Use external command to determine files to archive @@ -352,7 +352,7 @@ $ borg create \-\-paths\-from\-command /path/to/repo::joes\-files \-\- find /srv # Use \-\-paths\-from\-stdin with \-\-paths\-delimiter (for example, for filenames with newlines in them) $ find ~ \-size \-1000k \-print0 | borg create \e \-\-paths\-from\-stdin \e - \-\-paths\-delimiter "\e0" \e + \-\-paths\-delimiter \(dq\e0\(dq \e /path/to/repo::smallfiles\-handle\-newline .ft P .fi @@ -395,7 +395,7 @@ If you are interested only in a subset of that output, you can give e.g. below). .sp A uppercase character represents the status of a regular file relative to the -"files" cache (not relative to the repo \-\- this is an issue if the files cache +\(dqfiles\(dq cache (not relative to the repo \-\- this is an issue if the files cache is not used). Metadata is stored in any case and for \(aqA\(aq and \(aqM\(aq also new data chunks are stored. For \(aqU\(aq all data chunks refer to already existing chunks. .INDENT 0.0 diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 8435c20ff..5d9423faa 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DELETE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives .SH SYNOPSIS @@ -48,9 +48,9 @@ with the \fB\-\-cache\-only\fP option, or keep the security info with the When in doubt, use \fB\-\-dry\-run \-\-list\fP to see what would be deleted. .sp When using \fB\-\-stats\fP, you will get some statistics about how much data was -deleted \- the "Deleted data" deduplicated size there is most interesting as +deleted \- the \(dqDeleted data\(dq deduplicated size there is most interesting as that is how much your repository will shrink. -Please note that the "All archives" stats refer to the state after deletion. +Please note that the \(dqAll archives\(dq stats refer to the state after deletion. .sp You can delete multiple archives by specifying their common prefix, if they have one, using the \fB\-\-prefix PREFIX\fP option. You can also specify a shell @@ -104,7 +104,7 @@ work slower, but using less space only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp @@ -126,10 +126,10 @@ $ borg delete /path/to/repo::Monday # actually free disk space: $ borg compact /path/to/repo -# delete all archives whose names begin with the machine\(aqs hostname followed by "\-" +# delete all archives whose names begin with the machine\(aqs hostname followed by \(dq\-\(dq $ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo -# delete all archives whose names contain "\-2012\-" +# delete all archives whose names contain \(dq\-2012\-\(dq $ borg delete \-\-glob\-archives \(aq*\-2012\-*\(aq /path/to/repo # see what would be deleted if delete was run without \-\-dry\-run diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 6cce20acd..7a1ae2ac9 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DIFF" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -114,10 +114,10 @@ $ touch file3 $ borg create ../testrepo::archive1 . $ chmod a+x file1 -$ echo "something" >> file2 +$ echo \(dqsomething\(dq >> file2 $ borg create ../testrepo::archive2 . -$ echo "testing 123" >> file1 +$ echo \(dqtesting 123\(dq >> file1 $ rm file3 $ touch file4 $ borg create ../testrepo::archive3 . @@ -139,10 +139,10 @@ added 0 B file4 removed 0 B file3 $ borg diff \-\-json\-lines testrepo::archive1 archive3 -{"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "\-rw\-r\-\-r\-\-", "new_mode": "\-rwxr\-xr\-x"}]} -{"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]} -{"path": "file4", "changes": [{"type": "added", "size": 0}]} -{"path": "file3", "changes": [{"type": "removed", "size": 0}] +{\(dqpath\(dq: \(dqfile1\(dq, \(dqchanges\(dq: [{\(dqtype\(dq: \(dqmodified\(dq, \(dqadded\(dq: 17, \(dqremoved\(dq: 5}, {\(dqtype\(dq: \(dqmode\(dq, \(dqold_mode\(dq: \(dq\-rw\-r\-\-r\-\-\(dq, \(dqnew_mode\(dq: \(dq\-rwxr\-xr\-x\(dq}]} +{\(dqpath\(dq: \(dqfile2\(dq, \(dqchanges\(dq: [{\(dqtype\(dq: \(dqmodified\(dq, \(dqadded\(dq: 135, \(dqremoved\(dq: 252}]} +{\(dqpath\(dq: \(dqfile4\(dq, \(dqchanges\(dq: [{\(dqtype\(dq: \(dqadded\(dq, \(dqsize\(dq: 0}]} +{\(dqpath\(dq: \(dqfile3\(dq, \(dqchanges\(dq: [{\(dqtype\(dq: \(dqremoved\(dq, \(dqsize\(dq: 0}] .ft P .fi .UNINDENT diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 4a26acb6b..7e428013d 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXPORT-TAR" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -86,7 +86,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. archive to export .TP .B FILE -output tar file. "\-" to write to stdout instead. +output tar file. \(dq\-\(dq to write to stdout instead. .TP .B PATH paths to extract; patterns are supported @@ -131,14 +131,14 @@ $ borg export\-tar /path/to/repo::Monday Monday.tar $ borg export\-tar /path/to/repo::Monday Monday.tar.gz \-\-exclude \(aq*.so\(aq # use higher compression level with gzip -$ borg export\-tar \-\-tar\-filter="gzip \-9" testrepo::linux Monday.tar.gz +$ borg export\-tar \-\-tar\-filter=\(dqgzip \-9\(dq testrepo::linux Monday.tar.gz # export a tar, but instead of storing it on disk, # upload it to a remote site using curl. $ borg export\-tar /path/to/repo::Monday \- | curl \-\-data\-binary @\- https://somewhere/to/POST -# remote extraction via "tarpipe" -$ borg export\-tar /path/to/repo::Monday \- | ssh somewhere "cd extracted; tar x" +# remote extraction via \(dqtarpipe\(dq +$ borg export\-tar /path/to/repo::Monday \- | ssh somewhere \(dqcd extracted; tar x\(dq .ft P .fi .UNINDENT diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 9d155d2e9..9f9d8d3af 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXTRACT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents .SH SYNOPSIS @@ -52,7 +52,7 @@ pass over the archive metadata. \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 -Currently, extract always writes into the current working directory ("."), +Currently, extract always writes into the current working directory (\(dq.\(dq), so make sure you \fBcd\fP to the right place before calling \fBborg extract\fP\&. .sp When parent directories are not extracted (because of using file/directory selection @@ -138,10 +138,10 @@ $ borg extract \-\-list /path/to/repo::my\-files # Verify whether an archive could be successfully extracted, but do not write files to disk $ borg extract \-\-dry\-run /path/to/repo::my\-files -# Extract the "src" directory +# Extract the \(dqsrc\(dq directory $ borg extract /path/to/repo::my\-files home/USERNAME/src -# Extract the "src" directory but exclude object files +# Extract the \(dqsrc\(dq directory but exclude object files $ borg extract /path/to/repo::my\-files home/USERNAME/src \-\-exclude \(aq*.o\(aq # Restore a raw device (must not be active/in use/mounted at that time) diff --git a/docs/man/borg-import-tar.1 b/docs/man/borg-import-tar.1 index 9c9f2a11a..8d3b484a3 100644 --- a/docs/man/borg-import-tar.1 +++ b/docs/man/borg-import-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-IMPORT-TAR" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS @@ -80,7 +80,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. name of archive to create (must be also a valid directory name) .TP .B TARFILE -input tar file. "\-" to read from stdin instead. +input tar file. \(dq\-\(dq to read from stdin instead. .UNINDENT .SS optional arguments .INDENT 0.0 @@ -116,7 +116,7 @@ write checkpoint every SECONDS seconds (Default: 1800) specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: buzhash,19,23,21,4095 .TP .BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION -select compression algorithm, see the output of the "borg help compression" command for details. +select compression algorithm, see the output of the \(dqborg help compression\(dq command for details. .UNINDENT .SH SEE ALSO .sp diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 92f516eb6..1e3fca9bf 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INFO" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-INFO" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used .SH SYNOPSIS @@ -38,7 +38,7 @@ borg [common options] info [options] [REPOSITORY_OR_ARCHIVE] This command displays detailed information about the specified archive or repository. .sp Please note that the deduplicated sizes of the individual archives do not add -up to the deduplicated size of the repository ("all archives"), because the two +up to the deduplicated size of the repository (\(dqall archives\(dq), because the two are meaning different things: .sp This archive / deduplicated size = amount of data stored ONLY for this archive @@ -72,7 +72,7 @@ format output as JSON only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS 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 64e68c1f6..ae981eb87 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INIT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-INIT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository .SH SYNOPSIS @@ -82,7 +82,7 @@ This is why it is essential to use a secure passphrase. Encrypt and sign your backups to prevent anyone from reading or forging them unless they have the key and know the passphrase. Make sure to keep a backup of your key \fBoutside\fP the repository \- do not lock yourself out by -"leaving your keys inside your car" (see \fIborg_key_export\fP). +\(dqleaving your keys inside your car\(dq (see \fIborg_key_export\fP). For remote backups the encryption is done locally \- the remote machine never sees your passphrase, your unencrypted key or your unencrypted files. Chunking and id generation are also based on your key to improve @@ -119,7 +119,7 @@ Only use \fB\-\-encryption none\fP if you are OK with anyone who has access to your repository being able to read your backups and tamper with their contents without you noticing. .sp -If you want "passphrase and having\-the\-key" security, use \fB\-\-encryption keyfile\fP\&. +If you want \(dqpassphrase and having\-the\-key\(dq security, use \fB\-\-encryption keyfile\fP\&. The key will be stored in your home directory (in \fB~/.config/borg/keys\fP). .sp If you do \fBnot\fP want to encrypt the contents of your backups, but still diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index 9cde3c97f..30be86fb9 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase .SH SYNOPSIS @@ -56,11 +56,11 @@ REPOSITORY .ft C # Create a key file protected repository $ borg init \-\-encryption=keyfile \-v /path/to/repo -Initializing repository at "/path/to/repo" +Initializing repository at \(dq/path/to/repo\(dq 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. +Key in \(dq/root/.config/borg/keys/mnt_backup\(dq 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. @@ -90,9 +90,9 @@ Fully automated using environment variables: .nf .ft C $ BORG_NEW_PASSPHRASE=old borg init \-e=repokey repo -# now "old" is the current passphrase. +# now \(dqold\(dq is the current passphrase. $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase repo -# now "new" is the current passphrase. +# now \(dqnew\(dq is the current passphrase. .ft P .fi .UNINDENT diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 42e963f0e..fabd16ef2 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-EXPORT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-KEY-EXPORT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup .SH SYNOPSIS diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 589d19f54..fdd4edd67 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-IMPORT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-KEY-IMPORT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup .SH SYNOPSIS diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 38da5b022..1c0dafccd 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey .SH SYNOPSIS diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index 4f898d7c7..f0626bc5c 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-KEY" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository .SH SYNOPSIS diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index ccea21110..1ffd09a15 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-LIST" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-LIST" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents .SH SYNOPSIS @@ -60,13 +60,13 @@ Show checkpoint archives in the repository contents list (default: hidden). only print file/directory names, nothing else .TP .BI \-\-format \ FORMAT -specify format for file or archive listing (default for files: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}"; for archives: "{archive:<36} {time} [{id}]{NL}") +specify format for file or archive listing (default for files: \(dq{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(dq; for archives: \(dq{archive:<36} {time} [{id}]{NL}\(dq) .TP .B \-\-json -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. +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 \(dqbarchive\(dq key is therefore not available. .TP .B \-\-json\-lines -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. +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 \(dqbpath\(dq key is therefore not available. .UNINDENT .SS Archive filters .INDENT 0.0 @@ -75,7 +75,7 @@ Only valid for listing archive contents. Format output as JSON Lines. The form o only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp @@ -122,14 +122,14 @@ lrwxrwxrwx root root 0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdif \-rwxr\-xr\-x root root 2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff \&... -$ borg list /path/to/repo::root\-2016\-02\-15 \-\-pattern "\- bin/ba*" +$ borg list /path/to/repo::root\-2016\-02\-15 \-\-pattern \(dq\- bin/ba*\(dq drwxr\-xr\-x root root 0 Mon, 2016\-02\-15 17:44:27 . drwxrwxr\-x root root 0 Mon, 2016\-02\-15 19:04:49 bin lrwxrwxrwx root root 0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdiff \-rwxr\-xr\-x root root 2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff \&... -$ borg list /path/to/repo::archiveA \-\-format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}" +$ borg list /path/to/repo::archiveA \-\-format=\(dq{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}\(dq drwxrwxr\-x user user 0 Sun, 2015\-02\-01 11:00:00 . drwxrwxr\-x user user 0 Sun, 2015\-02\-01 11:00:00 code drwxrwxr\-x user user 0 Sun, 2015\-02\-01 11:00:00 code/myproject @@ -207,7 +207,7 @@ Keys available only when listing archives in a repository: .IP \(bu 2 archive: archive name interpreted as text (might be missing non\-text characters, see barchive) .IP \(bu 2 -name: alias of "archive" +name: alias of \(dqarchive\(dq .IP \(bu 2 barchive: verbatim archive name, can contain any character except NUL .IP \(bu 2 @@ -219,7 +219,7 @@ id: internal ID of the archive .IP \(bu 2 start: time (start) of creation of the archive .IP \(bu 2 -time: alias of "start" +time: alias of \(dqstart\(dq .IP \(bu 2 end: time (end) of creation of the archive .IP \(bu 2 @@ -309,9 +309,9 @@ archiveid .IP \(bu 2 archivename .IP \(bu 2 -extra: prepends {source} with " \-> " for soft links and " link to " for hard links +extra: prepends {source} with \(dq \-> \(dq for soft links and \(dq link to \(dq for hard links .IP \(bu 2 -health: either "healthy" (file ok) or "broken" (if file has all\-zero replacement chunks) +health: either \(dqhealthy\(dq (file ok) or \(dqbroken\(dq (if file has all\-zero replacement chunks) .UNINDENT .SH SEE ALSO .sp diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index f989d1edc..ff2ea74ed 100644 --- a/docs/man/borg-mount.1 +++ b/docs/man/borg-mount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-MOUNT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-MOUNT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -76,9 +76,9 @@ allow_damaged_files: by default damaged files (where missing chunks were replaced with runs of zeros by borg check \fB\-\-repair\fP) are not readable and return EIO (I/O error). Set this option to read such files. .IP \(bu 2 -ignore_permissions: for security reasons the "default_permissions" mount -option is internally enforced by borg. "ignore_permissions" can be given to -not enforce "default_permissions". +ignore_permissions: for security reasons the \(dqdefault_permissions\(dq mount +option is internally enforced by borg. \(dqignore_permissions\(dq can be given to +not enforce \(dqdefault_permissions\(dq. .UNINDENT .sp The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users @@ -132,7 +132,7 @@ use numeric user and group identifiers from archive(s) only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index 9488d77b0..99e5ca591 100644 --- a/docs/man/borg-patterns.1 +++ b/docs/man/borg-patterns.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PATTERNS" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-PATTERNS" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns .SH DESCRIPTION @@ -36,15 +36,12 @@ The path/filenames used as input for the pattern matching start from the currently active recursion root. You usually give the recursion root(s) when invoking borg and these can be either relative or absolute paths. .sp -So, when you give \fIrelative/\fP as root, the paths going into the matcher -will look like \fIrelative/.../file.ext\fP\&. When you give \fI/absolute/\fP as -root, they will look like \fI/absolute/.../file.ext\fP\&. -.sp -File paths in Borg archives are always stored normalized and relative. -This means that e.g. \fBborg create /path/to/repo ../some/path\fP will -store all files as \fIsome/path/.../file.ext\fP and \fBborg create -/path/to/repo /home/user\fP will store all files as -\fIhome/user/.../file.ext\fP\&. +If you give \fI/absolute/\fP as root, the paths going into the matcher will +look relative like \fIabsolute/.../file.ext\fP, because file paths in Borg +archives are always stored normalized and relative. This means that e.g. +\fBborg create /path/to/repo ../some/path\fP will store all files as +\fIsome/path/.../file.ext\fP and \fBborg create /path/to/repo /home/user\fP +will store all files as \fIhome/user/.../file.ext\fP\&. .sp A directory exclusion pattern can end either with or without a slash (\(aq/\(aq). If it ends with a slash, such as \fIsome/path/\fP, the directory will be @@ -57,10 +54,11 @@ path prefixes and path full\-matches. By default, fnmatch is used for option. For commands that support patterns in their \fBPATH\fP argument like (\fBborg list\fP), the default pattern is path prefix. .sp -Starting with Borg 1.2, for all but regular expression pattern matching -styles, all paths are treated as relative, meaning that a leading path -separator is removed after normalizing and before matching. This allows -you to use absolute or relative patterns arbitrarily. +Starting with Borg 1.2, discovered fs paths are normalised, have leading +slashes removed and then are matched against your patterns. +Note: You need to review your include / exclude patterns and make +sure they do not expect leading slashes. Borg can only deal with this +for some very simple patterns by removing leading slashes there also. .sp If followed by a colon (\(aq:\(aq) the first two characters of a pattern are used as a style selector. Explicit style selection is necessary when a @@ -159,26 +157,26 @@ $ borg create \-e \(aq*.o\(aq backup / # Exclude \(aq/home/user/junk\(aq and \(aq/home/user/subdir/junk\(aq but # not \(aq/home/user/importantjunk\(aq or \(aq/etc/junk\(aq: -$ borg create \-e \(aq/home/*/junk\(aq backup / +$ borg create \-e \(aqhome/*/junk\(aq backup / # Exclude the contents of \(aq/home/user/cache\(aq but not the directory itself: $ borg create \-e home/user/cache/ backup / # The file \(aq/home/user/cache/important\(aq is *not* backed up: -$ borg create \-e /home/user/cache/ backup / /home/user/cache/important +$ borg create \-e home/user/cache/ backup / /home/user/cache/important # The contents of directories in \(aq/home\(aq are not backed up when their name # ends in \(aq.tmp\(aq -$ borg create \-\-exclude \(aqre:^/home/[^/]+\e.tmp/\(aq backup / +$ borg create \-\-exclude \(aqre:^home/[^/]+\e.tmp/\(aq backup / # Load exclusions from file $ cat >exclude.txt <", -where char is "H", "d", "w", "m", "y". For example, \fB\-\-keep\-within 2d\fP means +The \fB\-\-keep\-within\fP option takes an argument of the form \(dq\(dq, +where char is \(dqH\(dq, \(dqd\(dq, \(dqw\(dq, \(dqm\(dq, \(dqy\(dq. For example, \fB\-\-keep\-within 2d\fP means to keep all archives that were created within the past 48 hours. -"1m" is taken to mean "31d". The archives kept with this option do not +\(dq1m\(dq is taken to mean \(dq31d\(dq. The archives kept with this option do not count towards the totals specified by any other options. .sp A good procedure is to thin out more and more the older your backups get. @@ -85,9 +85,9 @@ keep the last N archives under the assumption that you do not create more than o backup archive in the same second). .sp When using \fB\-\-stats\fP, you will get some statistics about how much data was -deleted \- the "Deleted data" deduplicated size there is most interesting as +deleted \- the \(dqDeleted data\(dq deduplicated size there is most interesting as that is how much your repository will shrink. -Please note that the "All archives" stats refer to the state after pruning. +Please note that the \(dqAll archives\(dq stats refer to the state after pruning. .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. @@ -146,7 +146,7 @@ work slower, but using less space only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .UNINDENT .SH EXAMPLES .sp @@ -156,7 +156,7 @@ archives. The default of prune is to apply to \fBall archives in the repository\fP unless you restrict its operation to a subset of the archives using \fB\-\-prefix\fP\&. When using \fB\-\-prefix\fP, be careful to choose a good prefix \- e.g. do not use a -prefix "foo" if you do not also want to match "foobar". +prefix \(dqfoo\(dq if you do not also want to match \(dqfoobar\(dq. .sp It is strongly recommended to always run \fBprune \-v \-\-list \-\-dry\-run ...\fP first so you will see what it would do without it actually doing anything. @@ -170,7 +170,7 @@ first so you will see what it would do without it actually doing anything. $ borg prune \-v \-\-list \-\-dry\-run \-\-keep\-daily=7 \-\-keep\-weekly=4 /path/to/repo # Same as above but only apply to archive names starting with the hostname -# of the machine followed by a "\-" character: +# of the machine followed by a \(dq\-\(dq character: $ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-prefix=\(aq{hostname}\-\(aq /path/to/repo # actually free disk space: $ borg compact /path/to/repo diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index df8a79b09..46b5437ea 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RECREATE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-RECREATE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives .SH SYNOPSIS @@ -43,7 +43,7 @@ recreate is a potentially dangerous function and might lead to data loss Important: Repository disk space is \fBnot\fP freed until you run \fBborg compact\fP\&. .sp \fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, \fB\-\-exclude\-if\-present\fP, \fB\-\-keep\-exclude\-tags\fP -and PATH have the exact same semantics as in "borg create", but they only check +and PATH have the exact same semantics as in \(dqborg create\(dq, but they only check for files in the archives and not in the local file system. If PATHs are specified, the resulting archives will only contain files from these PATHs. .sp @@ -67,7 +67,7 @@ interpreted. See \fIlist_item_flags\fP in \fBborg create\fP for details. .sp The archive being recreated is only removed after the operation completes. The archive that is built during the operation exists at the same time at -".recreate". The new archive will have a different archive ID. +\(dq.recreate\(dq. The new archive will have a different archive ID. .sp With \fB\-\-target\fP the original archive is not replaced, instead a new archive is created. .sp @@ -152,10 +152,10 @@ add a comment text to the archive manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). alternatively, give a reference file/directory. .TP .BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION -select compression algorithm, see the output of the "borg help compression" command for details. +select compression algorithm, see the output of the \(dqborg help compression\(dq command for details. .TP .BI \-\-recompress \ MODE -recompress data chunks according to \fIMODE\fP and \fB\-\-compression\fP\&. Possible modes are \fIif\-different\fP: recompress if current compression is with a different compression algorithm (the level is not considered); \fIalways\fP: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and \fInever\fP: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, \fIif\-different\fP will be used. Not passing \-\-recompress is equivalent to "\-\-recompress never". +recompress data chunks according to \fIMODE\fP and \fB\-\-compression\fP\&. Possible modes are \fIif\-different\fP: recompress if current compression is with a different compression algorithm (the level is not considered); \fIalways\fP: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and \fInever\fP: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, \fIif\-different\fP will be used. Not passing \-\-recompress is equivalent to \(dq\-\-recompress never\(dq. .TP .BI \-\-chunker\-params \ PARAMS specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or \fIdefault\fP to use the current defaults. default: buzhash,19,23,21,4095 @@ -182,13 +182,13 @@ $ borg recreate /mnt/backup::archive \-\-recompress \-\-compression zlib,9 $ borg recreate /mnt/backup \-\-exclude home/icke/Pictures/drunk_photos # Change archive comment -$ borg create \-\-comment "This is a comment" /mnt/backup::archivename ~ +$ borg create \-\-comment \(dqThis is a comment\(dq /mnt/backup::archivename ~ $ borg info /mnt/backup::archivename Name: archivename Fingerprint: ... Comment: This is a comment \&... -$ borg recreate \-\-comment "This is a better comment" /mnt/backup::archivename +$ borg recreate \-\-comment \(dqThis is a better comment\(dq /mnt/backup::archivename $ borg info /mnt/backup::archivename Name: archivename Fingerprint: ... diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index dac4c23cb..a20817b5d 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RENAME" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-RENAME" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-rename \- Rename an existing archive .SH SYNOPSIS diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1 index c0bba21a8..36ef57c1a 100644 --- a/docs/man/borg-serve.1 +++ b/docs/man/borg-serve.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-SERVE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-SERVE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-serve \- Start in server mode. This command is usually not used manually. .SH SYNOPSIS @@ -83,11 +83,11 @@ locations like \fB/etc/environment\fP or in the forced command itself (example b # Use key options to disable unneeded and potentially dangerous SSH functionality. # This will help to secure an automated remote backup system. $ cat ~/.ssh/authorized_keys -command="borg serve \-\-restrict\-to\-path /path/to/repo",restrict ssh\-rsa AAAAB3[...] +command=\(dqborg serve \-\-restrict\-to\-path /path/to/repo\(dq,restrict ssh\-rsa AAAAB3[...] -# Set a BORG_XXX environment variable on the "borg serve" side +# Set a BORG_XXX environment variable on the \(dqborg serve\(dq side $ cat ~/.ssh/authorized_keys -command="export BORG_XXX=value; borg serve [...]",restrict ssh\-rsa [...] +command=\(dqexport BORG_XXX=value; borg serve [...]\(dq,restrict ssh\-rsa [...] .ft P .fi .UNINDENT diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1 index 27b85c699..41d1770a9 100644 --- a/docs/man/borg-umount.1 +++ b/docs/man/borg-umount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UMOUNT" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-UMOUNT" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-umount \- un-mount the FUSE filesystem .SH SYNOPSIS @@ -69,7 +69,7 @@ bin boot etc home lib lib64 lost+found media mnt opt root sbin srv tmp usr var $ borg umount /tmp/mymountpoint -# The "versions view" merges all archives in the repository +# The \(dqversions view\(dq merges all archives in the repository # and provides a versioned view on files. $ borg mount \-o versions /path/to/repo /tmp/mymountpoint $ ls \-l /tmp/mymountpoint/home/user/doc.txt/ @@ -79,7 +79,7 @@ total 24 $ borg umount /tmp/mymountpoint # Archive filters are supported. -# These are especially handy for the "versions view", +# These are especially handy for the \(dqversions view\(dq, # which does not support lazy processing of archives. $ borg mount \-o versions \-\-glob\-archives \(aq*\-my\-home\(aq \-\-last 10 /path/to/repo /tmp/mymountpoint diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1 index d3985d24e..249d0f95d 100644 --- a/docs/man/borg-upgrade.1 +++ b/docs/man/borg-upgrade.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UPGRADE" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-UPGRADE" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-upgrade \- upgrade a repository from a previous version .SH SYNOPSIS @@ -170,11 +170,11 @@ no key file found for repository .UNINDENT .SS Upgrading a passphrase encrypted attic repo .sp -attic offered a "passphrase" encryption mode, but this was removed in borg 1.0 -and replaced by the "repokey" mode (which stores the passphrase\-protected +attic offered a \(dqpassphrase\(dq encryption mode, but this was removed in borg 1.0 +and replaced by the \(dqrepokey\(dq mode (which stores the passphrase\-protected encryption key into the repository config). .sp -Thus, to upgrade a "passphrase" attic repo to a "repokey" borg repo, 2 steps +Thus, to upgrade a \(dqpassphrase\(dq attic repo to a \(dqrepokey\(dq borg repo, 2 steps are needed, in this order: .INDENT 0.0 .IP \(bu 2 diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1 index a0daf9cd3..099cca727 100644 --- a/docs/man/borg-with-lock.1 +++ b/docs/man/borg-with-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-WITH-LOCK" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG-WITH-LOCK" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg-with-lock \- run a user specified command with the repository lock held .SH SYNOPSIS @@ -47,7 +47,7 @@ code as borg\(aqs return code. .INDENT 3.5 If you copy a repository with the lock held, the lock will be present in the copy. Thus, before using borg on the copy from a different host, -you need to use "borg break\-lock" on the copied repository, because +you need to use \(dqborg break\-lock\(dq on the copied repository, because Borg is cautious and does not automatically remove stale locks made by a different host. .UNINDENT .UNINDENT diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 97e636ba8..631bfbd88 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG" 1 "2022-02-19" "" "borg backup tool" +.TH "BORG" 1 "2022-06-05" "" "borg backup tool" .SH NAME borg \- deduplicating and encrypting backup tool .SH SYNOPSIS @@ -162,7 +162,7 @@ $ borg extract /path/to/repo::Monday .UNINDENT .UNINDENT .IP 7. 3 -Recover disk space by manually deleting the \fIMonday\fP archive: +Delete the \fIMonday\fP archive (please note that this does \fBnot\fP free repo disk space): .INDENT 3.0 .INDENT 3.5 .sp @@ -173,6 +173,18 @@ $ borg delete /path/to/repo::Monday .fi .UNINDENT .UNINDENT +.IP 8. 3 +Recover disk space by compacting the segment files in the repo: +.INDENT 3.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ borg compact /path/to/repo +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .sp \fBNOTE:\fP @@ -413,7 +425,7 @@ be checked. Main usecase for this is to fully automate \fBborg change\-passphrase\fP\&. .TP .B BORG_DISPLAY_PASSPHRASE -When set, use the value to answer the "display the passphrase for verification" question when defining a new passphrase for encrypted repositories. +When set, use the value to answer the \(dqdisplay the passphrase for verification\(dq question when defining a new passphrase for encrypted repositories. .TP .B BORG_HOST_ID Borg usually computes a host id from the FQDN plus the results of \fBuuid.getnode()\fP (which usually returns @@ -433,7 +445,7 @@ a custom identity file \fBssh \-i /path/to/private/key\fP\&. See \fBman ssh\fP f the \fB\-\-rsh CMD\fP commandline option overrides the environment variable. .TP .B BORG_REMOTE_PATH -When set, use the given path as borg executable on the remote (defaults to "borg" if unset). +When set, use the given path as borg executable on the remote (defaults to \(dqborg\(dq if unset). Using \fB\-\-remote\-path PATH\fP commandline option overrides the environment variable. .TP .B BORG_FILES_CACHE_SUFFIX @@ -442,7 +454,7 @@ When set to a value at least one character long, instructs borg to use a specifi cache entries for backup sources other than the current sources. .TP .B BORG_FILES_CACHE_TTL -When set to a numeric value, this determines the maximum "time to live" for the files cache +When set to a numeric value, this determines the maximum \(dqtime to live\(dq for the files cache entries (default: 20). The files cache is used to quickly determine whether a file is unchanged. The FAQ explains this more detailed in: \fIalways_chunking\fP .TP @@ -498,20 +510,20 @@ in WSL1 (Windows Subsystem for Linux 1). .UNINDENT .UNINDENT .TP -.B Some automatic "answerers" (if set, they automatically answer confirmation questions): +.B Some automatic \(dqanswerers\(dq (if set, they automatically answer confirmation questions): .INDENT 7.0 .TP .B BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no (or =yes) -For "Warning: Attempting to access a previously unknown unencrypted repository" +For \(dqWarning: Attempting to access a previously unknown unencrypted repository\(dq .TP .B BORG_RELOCATED_REPO_ACCESS_IS_OK=no (or =yes) -For "Warning: The repository at location ... was previously located at ..." +For \(dqWarning: The repository at location ... was previously located at ...\(dq .TP .B BORG_CHECK_I_KNOW_WHAT_I_AM_DOING=NO (or =YES) -For "This is a potentially dangerous function..." (check \-\-repair) +For \(dqThis is a potentially dangerous function...\(dq (check \-\-repair) .TP .B BORG_DELETE_I_KNOW_WHAT_I_AM_DOING=NO (or =YES) -For "You requested to completely DELETE the repository \fIincluding\fP all archives it contains:" +For \(dqYou requested to completely DELETE the repository \fIincluding\fP all archives it contains:\(dq .UNINDENT .sp Note: answers are case sensitive. setting an invalid answer value might either give the default @@ -544,8 +556,8 @@ for a security advisory about the data in this directory: \fIhome_config_borg\fP .TP .B BORG_SECURITY_DIR Defaults to \fB$BORG_CONFIG_DIR/security\fP\&. -This directory contains information borg uses to track its usage of NONCES ("numbers used -once" \- usually in encryption context) and other security relevant data. +This directory contains information borg uses to track its usage of NONCES (\(dqnumbers used +once\(dq \- usually in encryption context) and other security relevant data. .TP .B BORG_KEYS_DIR Defaults to \fB$BORG_CONFIG_DIR/keys\fP\&. @@ -582,7 +594,7 @@ will be linked against the system libzstd instead of a bundled implementation. ( Please note: .INDENT 0.0 .IP \(bu 2 -Be very careful when using the "yes" sayers, the warnings with prompt exist for your / your data\(aqs security/safety. +Be very careful when using the \(dqyes\(dq sayers, the warnings with prompt exist for your / your data\(aqs security/safety. .IP \(bu 2 Also be very careful when putting your passphrase into a script, make sure it has appropriate file permissions (e.g. mode 600, root:root). @@ -727,7 +739,7 @@ process. For some OSes, this can be done just by setting the correct value in the \&.bashrc (or equivalent login config file for other shells), however in other cases it may be necessary to first enable \fBPermitUserEnvironment yes\fP -in your \fBsshd_config\fP file, then add \fBenvironment="TMPDIR=/my/big/tmpdir"\fP +in your \fBsshd_config\fP file, then add \fBenvironment=\(dqTMPDIR=/my/big/tmpdir\(dq\fP at the start of the public key to be used in the \fBauthorized_hosts\fP file. .TP .B Cache files (client only): @@ -755,7 +767,7 @@ special files: .IP \(bu 2 character and block device files (restored via mknod) .IP \(bu 2 -FIFOs ("named pipes") +FIFOs (\(dqnamed pipes\(dq) .IP \(bu 2 special file \fIcontents\fP can be backed up in \fB\-\-read\-special\fP mode. By default the metadata to create them with mknod(2), mkfifo(2) etc. is stored. @@ -875,7 +887,7 @@ Other Unix\-like operating systems may work as well, but have not been tested at Note that most of the platform\-dependent features also depend on the file system. For example, ntfs\-3g on Linux isn\(aqt able to convey NTFS ACLs. .IP [1] 5 -Only "nodump", "immutable", "compressed" and "append" are supported. +Only \(dqnodump\(dq, \(dqimmutable\(dq, \(dqcompressed\(dq and \(dqappend\(dq are supported. Feature request #618 for more flags. .IP [2] 5 Feature request #1332 diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 3440b0936..05fff3c5c 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORGFS" 1 "2022-02-19" "" "borg backup tool" +.TH "BORGFS" 1 "2022-06-05" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -76,9 +76,9 @@ allow_damaged_files: by default damaged files (where missing chunks were replaced with runs of zeros by borg check \fB\-\-repair\fP) are not readable and return EIO (I/O error). Set this option to read such files. .IP \(bu 2 -ignore_permissions: for security reasons the "default_permissions" mount -option is internally enforced by borg. "ignore_permissions" can be given to -not enforce "default_permissions". +ignore_permissions: for security reasons the \(dqdefault_permissions\(dq mount +option is internally enforced by borg. \(dqignore_permissions\(dq can be given to +not enforce \(dqdefault_permissions\(dq. .UNINDENT .sp The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users @@ -135,7 +135,7 @@ use numeric user and group identifiers from archive(s) only consider archive names starting with this prefix. .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -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. +only consider archive names matching the glob. sh: rules apply, see \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp