diff options
author | Thomas Waldmann <tw@waldmann-edv.de> | 2022-09-10 16:03:27 +0200 |
---|---|---|
committer | Thomas Waldmann <tw@waldmann-edv.de> | 2022-09-10 18:15:45 +0200 |
commit | 18ca2ab3ce740177b574397910284dbb51fb3000 (patch) | |
tree | 43c8577cabc81fe52bd809f4517e811abf6374e6 /docs/man | |
parent | c8964e92fdf2bcb49c5f23e08dfe800ea10a9426 (diff) |
build_usage build_man
Diffstat (limited to 'docs/man')
38 files changed, 152 insertions, 151 deletions
diff --git a/docs/man/borg-benchmark-cpu.1 b/docs/man/borg-benchmark-cpu.1 index 11d17fd44..161ab4069 100644 --- a/docs/man/borg-benchmark-cpu.1 +++ b/docs/man/borg-benchmark-cpu.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-CPU" 1 "2022-08-07" "" "borg backup tool" +.TH "BORG-BENCHMARK-CPU" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-benchmark-cpu \- Benchmark CPU bound operations. .SH SYNOPSIS diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 2072b349f..4544483fd 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-07" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2022-09-10" "" "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 67ffd8fda..0fbcf65ba 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-07" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2022-09-10" "" "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 9f8a71ab3..1d0bdd99b 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-07" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2022-09-10" "" "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 b585138f4..f4a210244 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-07" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -151,7 +151,7 @@ do only a partial repo check for max. SECONDS seconds (Default: unlimited) .INDENT 0.0 .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -only consider archive names matching the glob. sh: rules apply, see "borg help patterns". +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 7a093f0bc..fd1053cf3 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-07" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2022-09-10" "" "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 \-\-upload\-ratelimit \ RATE set network upload rate limit in kiByte/s (default: 0=unlimited) @@ -91,7 +91,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 0e9aaf2dc..30dd29e24 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-07" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2022-09-10" "" "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 50c74a256..b6937ba1d 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-07" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2022-09-10" "" "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 44c3d70a6..5fdb2c397 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-07" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2022-09-10" "" "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 15c951c0d..e2b916310 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-07" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2022-09-10" "" "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) @@ -247,7 +247,7 @@ open and read block and char device files as well as FIFOs as if they were regul add a comment text to the archive .TP .BI \-\-timestamp \ TIMESTAMP -manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). Alternatively, give a reference file/directory. +manually specify the archive creation date/time (yyyy\-mm\-ddThh:mm:ss[(+|\-)HH:MM] format, (+|\-)HH:MM is the UTC offset, default: local time zone). Alternatively, give a reference file/directory. .TP .BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS write checkpoint every SECONDS seconds (Default: 1800) @@ -256,7 +256,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 @@ -264,7 +264,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 my\-documents ~/Documents # same, but list all files as we process them @@ -280,14 +280,14 @@ $ borg create my\-files \e # /home/<one directory>/.thumbnails is excluded, not /home/*/*/.thumbnails etc.) $ borg create my\-files /home \-\-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 root\-{now:%Y\-%m\-%d} / # Backup into an archive name like FQDN\-root\-TIMESTAMP $ borg create \(aq{fqdn}\-root\-{now}\(aq / -# 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 @@ -330,7 +330,7 @@ $ borg create \(aq{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f}\(aq ~ # 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 \(aqdaily\-projectA\-{now:%Y\-%m\-%d}\(aq projectA # Use external command to determine files to archive @@ -341,7 +341,7 @@ $ borg create \-\-paths\-from\-command joes\-files \-\- find /srv/samba/shared \ # 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 smallfiles\-handle\-newline .ft P .fi @@ -384,7 +384,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 14609e087..091a00aa7 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-07" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-delete \- Delete archives .SH SYNOPSIS @@ -43,9 +43,9 @@ you run \fBborg compact\fP\&. 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 a matching shell pattern, using the \fB\-\-glob\-archives GLOB\fP option (for more info on these patterns, @@ -86,7 +86,7 @@ write checkpoint every SECONDS seconds (Default: 1800) .INDENT 0.0 .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -only consider archive names matching the glob. sh: rules apply, see "borg help patterns". +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 @@ -108,10 +108,10 @@ $ borg delete Monday # actually free disk space: $ borg compact -# 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 \-a \(aq{hostname}\-*\(aq -# delete all archives whose names contain "\-2012\-" +# delete all archives whose names contain \(dq\-2012\-\(dq $ borg delete \-a \(aq*\-2012\-*\(aq # 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 599c23ecb..b39a47157 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-07" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -109,10 +109,10 @@ added 0 B file4 removed 0 B file3 $ borg diff archive1 archive2 -{"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 cb3ac9a45..92753e1cc 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-07" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -119,7 +119,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. specify the archive name .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 diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 1413018b7..019122fac 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-07" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2022-09-10" "" "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 @@ -132,10 +132,10 @@ $ borg extract \-\-list my\-files # Verify whether an archive could be successfully extracted, but do not write files to disk $ borg extract \-\-dry\-run my\-files -# Extract the "src" directory +# Extract the \(dqsrc\(dq directory $ borg extract my\-files home/USERNAME/src -# Extract the "src" directory but exclude object files +# Extract the \(dqsrc\(dq directory but exclude object files $ borg extract 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 074086649..e220a4f37 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-07" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS @@ -90,7 +90,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. specify the archive 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 @@ -117,7 +117,7 @@ output stats as JSON (implies \-\-stats) add a comment text to the archive .TP .BI \-\-timestamp \ TIMESTAMP -manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). alternatively, give a reference file/directory. +manually specify the archive creation date/time (yyyy\-mm\-ddThh:mm:ss[(+|\-)HH:MM] format, (+|\-)HH:MM is the UTC offset, default: local time zone). Alternatively, give a reference file/directory. .TP .BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS write checkpoint every SECONDS seconds (Default: 1800) @@ -126,7 +126,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 @@ -144,7 +144,7 @@ $ borg import\-tar Monday Monday.tar $ borg export\-tar Monday Monday.tar.gz \-\-exclude \(aq*.so\(aq # use higher compression level with gzip -$ borg export\-tar \-\-tar\-filter="gzip \-9" Monday Monday.tar.gz +$ borg export\-tar \-\-tar\-filter=\(dqgzip \-9\(dq Monday Monday.tar.gz # copy an archive from repoA to repoB $ borg \-r repoA export\-tar \-\-tar\-format=BORG archive \- | borg \-r repoB import\-tar archive \- @@ -152,8 +152,8 @@ $ borg \-r repoA export\-tar \-\-tar\-format=BORG archive \- | borg \-r repoB im # export a tar, but instead of storing it on disk, upload it to remote site using curl $ borg export\-tar Monday \- | curl \-\-data\-binary @\- https://somewhere/to/POST -# remote extraction via "tarpipe" -$ borg export\-tar Monday \- | ssh somewhere "cd extracted; tar x" +# remote extraction via \(dqtarpipe\(dq +$ borg export\-tar Monday \- | ssh somewhere \(dqcd extracted; tar x\(dq .ft P .fi .UNINDENT @@ -168,7 +168,7 @@ Outputs a script that copies all archives from repo1 to repo2: .ft C for A T in \(gaborg list \-\-format=\(aq{archive} {time:%Y\-%m\-%dT%H:%M:%S}{LF}\(aq\(ga do - echo "borg \-r repo1 export\-tar \-\-tar\-format=BORG $A \- | borg \-r repo2 import\-tar \-\-timestamp=$T $A \-" + echo \(dqborg \-r repo1 export\-tar \-\-tar\-format=BORG $A \- | borg \-r repo2 import\-tar \-\-timestamp=$T $A \-\(dq done .ft P .fi diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 891a6e0af..122a852c2 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-07" "" "borg backup tool" +.TH "BORG-INFO" 1 "2022-09-10" "" "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] This command displays detailed information about the specified archive. .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 @@ -58,7 +58,7 @@ format output as JSON .INDENT 0.0 .TP .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB -only consider archive names matching the glob. sh: rules apply, see "borg help patterns". +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-key-change-location.1 b/docs/man/borg-key-change-location.1 index bb77b9dca..bbac5c131 100644 --- a/docs/man/borg-key-change-location.1 +++ b/docs/man/borg-key-change-location.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-LOCATION" 1 "2022-08-07" "" "borg backup tool" +.TH "BORG-KEY-CHANGE-LOCATION" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-key-change-location \- Change repository key location .SH SYNOPSIS diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index d24b33345..9e38d68e3 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-08-07" "" "borg backup tool" +.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase .SH SYNOPSIS @@ -53,11 +53,11 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .ft C # Create a key file protected repository $ borg rcreate \-\-encryption=keyfile\-aes\-ocb \-v -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. @@ -87,9 +87,9 @@ Fully automated using environment variables: .nf .ft C $ BORG_NEW_PASSPHRASE=old borg rcreate \-e=repokey -# now "old" is the current passphrase. +# now \(dqold\(dq is the current passphrase. $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase -# 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 b210e14d2..fb9ac8a0c 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-08-07" "" "borg backup tool" +.TH "BORG-KEY-EXPORT" 1 "2022-09-10" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup .SH SYNOPSIS |