summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2022-08-20 15:12:20 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2022-08-20 15:38:10 +0200
commit92ca260fd851307543f020addeabdd64e1a4de39 (patch)
tree4cfed6b0819267d750d5cd4cc17868eb55e1a15e
parentb024379904f2988f1f276e468728db80b350f975 (diff)
build_usage ; build_man
-rw-r--r--docs/man/borg-benchmark-crud.12
-rw-r--r--docs/man/borg-benchmark.12
-rw-r--r--docs/man/borg-break-lock.12
-rw-r--r--docs/man/borg-check.14
-rw-r--r--docs/man/borg-common.16
-rw-r--r--docs/man/borg-compact.12
-rw-r--r--docs/man/borg-compression.114
-rw-r--r--docs/man/borg-config.16
-rw-r--r--docs/man/borg-create.126
-rw-r--r--docs/man/borg-delete.115
-rw-r--r--docs/man/borg-diff.114
-rw-r--r--docs/man/borg-export-tar.110
-rw-r--r--docs/man/borg-extract.18
-rw-r--r--docs/man/borg-import-tar.16
-rw-r--r--docs/man/borg-info.16
-rw-r--r--docs/man/borg-init.16
-rw-r--r--docs/man/borg-key-change-passphrase.110
-rw-r--r--docs/man/borg-key-export.12
-rw-r--r--docs/man/borg-key-import.12
-rw-r--r--docs/man/borg-key-migrate-to-repokey.12
-rw-r--r--docs/man/borg-key.12
-rw-r--r--docs/man/borg-list.122
-rw-r--r--docs/man/borg-mount.110
-rw-r--r--docs/man/borg-patterns.14
-rw-r--r--docs/man/borg-placeholders.12
-rw-r--r--docs/man/borg-prune.121
-rw-r--r--docs/man/borg-recreate.114
-rw-r--r--docs/man/borg-rename.12
-rw-r--r--docs/man/borg-serve.18
-rw-r--r--docs/man/borg-umount.16
-rw-r--r--docs/man/borg-upgrade.18
-rw-r--r--docs/man/borg-with-lock.14
-rw-r--r--docs/man/borg.130
-rw-r--r--docs/man/borgfs.110
-rw-r--r--docs/usage/delete.rst.inc81
-rw-r--r--docs/usage/prune.rst.inc89
36 files changed, 235 insertions, 223 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1
index 61a6c6a8d..573c7c710 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-06-05" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CRUD" 1 "2022-08-20" "" "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 74decd8d1..20fa1d32a 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-06-05" "" "borg backup tool"
+.TH "BORG-BENCHMARK" 1 "2022-08-20" "" "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 2d8e5755f..e80119d02 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-06-05" "" "borg backup tool"
+.TH "BORG-BREAK-LOCK" 1 "2022-08-20" "" "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 442270c13..21cacebb4 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-06-05" "" "borg backup tool"
+.TH "BORG-CHECK" 1 "2022-08-20" "" "borg backup tool"
.SH NAME
borg-check \- Check repository consistency
.SH SYNOPSIS
@@ -160,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 \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+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
.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 6bac50b8a..277abab01 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-06-05" "" "borg backup tool"
+.TH "BORG-COMMON" 1 "2022-08-20" "" "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: \(dqborg\(dq)
+use PATH as borg executable on the remote (default: "borg")
.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 \(dq.pyprof\(dq.
+Write execution profile in Borg format into FILE. For local use a Python\-compatible file can be generated by suffixing FILE with ".pyprof".
.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 b95c16c09..5254d0d7c 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-06-05" "" "borg backup tool"
+.TH "BORG-COMPACT" 1 "2022-08-20" "" "borg backup tool"
.SH NAME
borg-compact \- compact segment files in the repository
.SH SYNOPSIS
diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1
index db5e60009..302385fd0 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-06-05" "" "borg backup tool"
+.TH "BORG-COMPRESSION" 1 "2022-08-20" "" "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 (\(dqzstandard\(dq) compression, a modern wide\-range algorithm.
+Use zstd ("zstandard") 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 (\(dqgz\(dq) compression. Medium speed, medium compression.
+Use zlib ("gz") 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 \(dqno compression\(dq, but still has zlib protocol
-overhead) is usually pointless, you better use \(dqnone\(dq compression.
+Giving level 0 (means "no compression", but still has zlib protocol
+overhead) is usually pointless, you better use "none" compression.
.TP
.B lzma[,L]
-Use lzma (\(dqxz\(dq) compression. Low speed, high compression.
+Use lzma ("xz") 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 \(dqnone\(dq).
+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.
.TP
diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1
index 680105470..58b2b3c2e 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-06-05" "" "borg backup tool"
+.TH "BORG-CONFIG" 1 "2022-08-20" "" "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 \(dqsection.name\(dq or
-simply \(dqname\(dq; the section will default to \(dqrepository\(dq and \(dqcache\(dq for
+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 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 0c648173f..678158d3b 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-06-05" "" "borg backup tool"
+.TH "BORG-CREATE" 1 "2022-08-20" "" "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 \(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
+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
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: \(aqroot\(aq)
+set group GROUP in archive for stdin data (default: \(aqwheel\(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 \(dqborg help compression\(dq command for details.
+select compression algorithm, see the output of the "borg help compression" command for details.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
@@ -273,7 +273,7 @@ select compression algorithm, see the output of the \(dqborg help compression\(d
.sp
.nf
.ft C
-# Backup ~/Documents into an archive named \(dqmy\-documents\(dq
+# Backup ~/Documents into an archive named "my\-documents"
$ borg create /path/to/repo::my\-documents ~/Documents
# same, but list all files as we process them
@@ -290,15 +290,15 @@ $ borg create /path/to/repo::my\-files \e
$ borg create /path/to/repo::my\-files /home \e
\-\-exclude \(aqsh:home/*/.thumbnails\(aq
-# Backup the root filesystem into an archive named \(dqroot\-YYYY\-MM\-DD\(dq
+# Backup the root filesystem into an archive named "root\-YYYY\-MM\-DD"
# 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 (\(dqpush\(dq style) via ssh to port 2222,
-# logging in as user \(dqborg\(dq and storing into /path/to/repo
+# Backup onto a remote host ("push" style) via ssh to port 2222,
+# logging in as user "borg" 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 (\(dqpull\(dq style) using sshfs
+# Backup a remote host locally ("pull" 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 \(dqprojectA\(dq
+# The root directory of the archive will be "projectA"
$ 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 \(dq\e0\(dq \e
+ \-\-paths\-delimiter "\e0" \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
-\(dqfiles\(dq cache (not relative to the repo \-\- this is an issue if the files cache
+"files" 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 5d9423faa..4f3d50647 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-06-05" "" "borg backup tool"
+.TH "BORG-DELETE" 1 "2022-08-20" "" "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 \(dqDeleted data\(dq deduplicated size there is most interesting as
+deleted \- the "Deleted data" deduplicated size there is most interesting as
that is how much your repository will shrink.
-Please note that the \(dqAll archives\(dq stats refer to the state after deletion.
+Please note that the "All archives" 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
@@ -96,6 +96,9 @@ keep the local security info when deleting a repository
.TP
.B \-\-save\-space
work slower, but using less space
+.TP
+.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS
+write checkpoint every SECONDS seconds (Default: 1800)
.UNINDENT
.SS Archive filters
.INDENT 0.0
@@ -104,7 +107,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 \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+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
.BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
@@ -126,10 +129,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 \(dq\-\(dq
+# delete all archives whose names begin with the machine\(aqs hostname followed by "\-"
$ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo
-# delete all archives whose names contain \(dq\-2012\-\(dq
+# delete all archives whose names contain "\-2012\-"
$ 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 7a1ae2ac9..971446248 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-06-05" "" "borg backup tool"
+.TH "BORG-DIFF" 1 "2022-08-20" "" "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 \(dqsomething\(dq >> file2
+$ echo "something" >> file2
$ borg create ../testrepo::archive2 .
-$ echo \(dqtesting 123\(dq >> file1
+$ echo "testing 123" >> 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
-{\(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}]
+{"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}]
.ft P
.fi
.UNINDENT
diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1
index 7e428013d..cba5c0504 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-06-05" "" "borg backup tool"
+.TH "BORG-EXPORT-TAR" 1 "2022-08-20" "" "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. \(dq\-\(dq to write to stdout instead.
+output tar file. "\-" 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=\(dqgzip \-9\(dq testrepo::linux Monday.tar.gz
+$ borg export\-tar \-\-tar\-filter="gzip \-9" 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 \(dqtarpipe\(dq
-$ borg export\-tar /path/to/repo::Monday \- | ssh somewhere \(dqcd extracted; tar x\(dq
+# remote extraction via "tarpipe"
+$ borg export\-tar /path/to/repo::Monday \- | ssh somewhere "cd extracted; tar x"
.ft P
.fi
.UNINDENT
diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1
index 9f9d8d3af..ecca8a828 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-06-05" "" "borg backup tool"
+.TH "BORG-EXTRACT" 1 "2022-08-20" "" "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 (\(dq.\(dq),
+Currently, extract always writes into the current working directory ("."),
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 \(dqsrc\(dq directory
+# Extract the "src" directory
$ borg extract /path/to/repo::my\-files home/USERNAME/src
-# Extract the \(dqsrc\(dq directory but exclude object files
+# Extract the "src" 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 8d3b484a3..4b2a2b729 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-06-05" "" "borg backup tool"
+.TH "BORG-IMPORT-TAR" 1 "2022-08-20" "" "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. \(dq\-\(dq to read from stdin instead.
+input tar file. "\-" 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 \(dqborg help compression\(dq command for details.
+select compression algorithm, see the output of the "borg help compression" command for details.
.UNINDENT
.SH SEE ALSO
.sp
diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1
index 1e3fca9bf..3249d6773 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-06-05" "" "borg backup tool"
+.TH "BORG-INFO" 1 "2022-08-20" "" "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 (\(dqall archives\(dq), because the two
+up to the deduplicated size of the repository ("all archives"), 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 \(dqborg help patterns\(dq. \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+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
.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 ae981eb87..4dc688f3d 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-06-05" "" "borg backup tool"
+.TH "BORG-INIT" 1 "2022-08-20" "" "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
-\(dqleaving your keys inside your car\(dq (see \fIborg_key_export\fP).
+"leaving your keys inside your car" (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 \(dqpassphrase and having\-the\-key\(dq security, use \fB\-\-encryption keyfile\fP\&.
+If you want "passphrase and having\-the\-key" 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 30be86fb9..6200e3f4f 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-06-05" "" "borg backup tool"
+.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2022-08-20" "" "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 \(dq/path/to/repo\(dq
+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 \(dq/root/.config/borg/keys/mnt_backup\(dq created.
+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.
@@ -90,9 +90,9 @@ Fully automated using environment variables:
.nf
.ft C
$ BORG_NEW_PASSPHRASE=old borg init \-e=repokey repo
-# now \(dqold\(dq is the current passphrase.
+# now "old" is the current passphrase.
$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase repo
-# now \(dqnew\(dq is the current passphrase.
+# now "new" 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 fabd16ef2..06c3f59dc 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-06-05" "" "borg backup tool"
+.TH "BORG-KEY-EXPORT" 1 "2022-08-20" "" "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 fdd4edd67..f23af65af 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-06-05" "" "borg backup tool"
+.TH "BORG-KEY-IMPORT" 1 "2022-08-20" "" "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 1c0dafccd..339814085 100644
--- a/