diff options
34 files changed, 177 insertions, 179 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 573c7c710..7dfcabc34 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-08-20" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2022-12-24" "" "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 20fa1d32a..2d2045201 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-08-20" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2022-12-24" "" "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 e80119d02..4284712be 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-08-20" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2022-12-24" "" "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 21cacebb4..17ed5059f 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-08-20" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -132,7 +132,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to check consistency of .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-repository\-only @@ -157,10 +157,10 @@ do only a partial repo check for max. SECONDS seconds (Default: unlimited) .INDENT 0.0 .TP .BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX -only consider archive names starting with this prefix. +only consider archive names starting with this prefix. (deprecated) .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. .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 277abab01..4ea4f97da 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-08-20" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2022-12-24" "" "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 5254d0d7c..5ead9e002 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-08-20" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository .SH SYNOPSIS @@ -66,7 +66,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to compact .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-cleanup\-commits diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 302385fd0..97f75b336 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-08-20" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2022-12-24" "" "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 58b2b3c2e..8067a4109 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-08-20" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2022-12-24" "" "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 @@ -62,7 +62,7 @@ name of config key .B VALUE new value for key .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-c\fP,\fB \-\-cache diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 678158d3b..62065f9e3 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-08-20" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2022-12-24" "" "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 @@ -132,7 +132,7 @@ name of archive to create (must be also a valid directory name) .B PATH paths to archive .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run @@ -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 @@ -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 "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 4f3d50647..6431669ee 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-08-20" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives .SH SYNOPSIS @@ -48,15 +48,13 @@ 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 -pattern to match multiple archives using the \fB\-\-glob\-archives GLOB\fP option -(for more info on these patterns, see \fIborg_patterns\fP). Note that these -two options are mutually exclusive. +You can delete multiple archives by specifying a shell pattern to match +multiple archives using the \fB\-\-glob\-archives GLOB\fP option (for more info on +these patterns, see \fIborg_patterns\fP). .sp To avoid accidentally deleting archives, especially when using glob patterns, it might be helpful to use the \fB\-\-dry\-run\fP to test out the command without @@ -73,7 +71,7 @@ repository or archive to delete .B ARCHIVE archives to delete .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run @@ -104,10 +102,10 @@ write checkpoint every SECONDS seconds (Default: 1800) .INDENT 0.0 .TP .BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX -only consider archive names starting with this prefix. +only consider archive names starting with this prefix. (deprecated) .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. .TP .BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp @@ -129,10 +127,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 "\-" -$ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo +# delete all archives whose names begin with the machine\(aqs hostname followed by \(dq\-\(dq +$ borg delete \-\-glob\-archives \(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 971446248..28ca936e1 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-08-20" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -66,7 +66,7 @@ ARCHIVE2 name (no repository location allowed) .B PATH paths of items inside the archives to compare; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-numeric\-owner @@ -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 cba5c0504..54b48ce5f 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-08-20" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -50,7 +50,7 @@ before writing it to FILE: .IP \(bu 2 \&.tar.xz or .txz: xz .IP \(bu 2 -\&.tar.zstd: zstd +\&.tar.zstd or .tar.zst: zstd .IP \(bu 2 \&.tar.lz4: lz4 .UNINDENT @@ -86,12 +86,12 @@ 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 .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-tar\-filter @@ -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 ecca8a828..1dc992ddd 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-08-20" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2022-12-24" "" "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 @@ -72,7 +72,7 @@ archive to extract .B PATH paths to extract; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-list @@ -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 4b2a2b729..ec4699727 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-08-20" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2022-12-24" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS @@ -49,7 +49,7 @@ based on its file extension and pipe the file through an appropriate filter: .IP \(bu 2 \&.tar.xz or .txz: xz \-d .IP \(bu 2 -\&.tar.zstd: zstd \-d +\&.tar.zstd or .tar.zst: zstd \-d .IP \(bu 2 \&.tar.lz4: lz4 \-d .UNINDENT @@ -80,9 +80,9 @@ 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 +.SS options .INDENT 0.0 .TP .B \-\-tar\-filter @@ -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 3249d6773..8932ab009 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-08-20" "" "borg backup tool" +.TH "BORG-INFO" 1 "2022-12-24" "" "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 @@ -59,7 +59,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to display information about .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-json @@ -69,10 +69,10 @@ format output as JSON .INDENT 0.0 .TP .BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX -only consider archive names starting with this prefix. +only consider archive names starting with this prefix. (deprecated) .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. .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 4dc688f3d..9d31b2b20 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-08-20" "" "borg backup tool" +.TH "BORG-INIT" 1 "2022-12-24" "" "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 @@ -223,7 +223,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to create .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index 6200e3f4f..cdd72d818 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[rst2 |