diff options
author | Thomas Waldmann <tw@waldmann-edv.de> | 2023-07-20 18:57:22 +0200 |
---|---|---|
committer | Thomas Waldmann <tw@waldmann-edv.de> | 2023-07-20 18:57:22 +0200 |
commit | b419b6ad032bebc5e8e5525826f7508a88f1719f (patch) | |
tree | 0b37758f047e506ed81076a71b616ddec8a42017 /docs | |
parent | 65a2fe8502df375828b2b527106bce454edc7671 (diff) |
build_man / build_usage
Diffstat (limited to 'docs')
45 files changed, 662 insertions, 438 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 34c1cb01e..5d801a74e 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2023-07-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 a0127a4ed..beca9e957 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2023-07-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 dad46be9d..05ec89313 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2023-07-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 4b524b926..f76e031a0 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -35,94 +35,123 @@ borg-check \- Check repository consistency borg [common options] check [options] [REPOSITORY_OR_ARCHIVE] .SH DESCRIPTION .sp -The check command verifies the consistency of a repository and the corresponding archives. +The check command verifies the consistency of a repository and its archives. +It consists of two major steps: +.INDENT 0.0 +.IP 1. 3 +Checking the consistency of the repository itself. This includes checking +the segment magic headers, and both the metadata and data of all objects in +the segments. The read data is checked by size and CRC. Bit rot and other +types of accidental damage can be detected this way. Running the repository +check can be split into multiple partial checks using \fB\-\-max\-duration\fP\&. +When checking a remote repository, please note that the checks run on the +server and do not cause significant network traffic. +.IP 2. 3 +Checking consistency and correctness of the archive metadata and optionally +archive data (requires \fB\-\-verify\-data\fP). This includes ensuring that the +repository manifest exists, the archive metadata chunk is present, and that +all chunks referencing files (items) in the archive exist. This requires +reading archive and file metadata, but not data. To cryptographically verify +the file (content) data integrity pass \fB\-\-verify\-data\fP, but keep in mind +that this requires reading all data and is hence very time consuming. When +checking archives of a remote repository, archive checks run on the client +machine because they require decrypting data and therefore the encryption +key. +.UNINDENT .sp -check \-\-repair is a potentially dangerous function and might lead to data loss -(for kinds of corruption it is not capable of dealing with). BE VERY CAREFUL! +Both steps can also be run independently. Pass \fB\-\-repository\-only\fP to run the +repository checks only, or pass \fB\-\-archives\-only\fP to run the archive checks +only. .sp -Pursuant to the previous warning it is also highly recommended to test the -reliability of the hardware running this software with stress testing software -such as memory testers. Unreliable hardware can also lead to data loss especially -when this command is run in repair mode. +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 full repository has been checked. Assuming a complete check +would take 7 hours, then running a daily check with \fB\-\-max\-duration=3600\fP +(1 hour) would result in one full repository check per week. Doing a full +repository check aborts any previous partial check; the next partial check will +restart from the beginning. With partial repository checks you can run neither +archive checks, nor enable repair mode. Consequently, if you want to use +\fB\-\-max\-duration\fP you must also pass \fB\-\-repository\-only\fP, and must not pass +\fB\-\-archives\-only\fP, nor \fB\-\-repair\fP\&. +.sp +\fBWarning:\fP Please note that partial repository checks (i.e. running it with +\fB\-\-max\-duration\fP) can only perform non\-cryptographic checksum checks on the +segment files. A full repository check (i.e. without \fB\-\-max\-duration\fP) can +also do a repository index check. Enabling partial repository checks excepts +archive checks for the same reason. Therefore partial checks may be useful with +very large repositories only where a full check would take too long. +.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 repository, decrypting and decompressing it. It is a complete +cryptographic verification and hence very time consuming, but will detect any +accidental and malicious corruption. Tamper\-resistance is only guaranteed for +encrypted repositories against attackers without access to the keys. You can +not use \fB\-\-verify\-data\fP with \fB\-\-repository\-only\fP\&. +.SS About repair mode +.sp +The check command is a readonly task by default. If any corruption is found, +Borg will report the issue and proceed with checking. To actually repair the +issues found, pass \fB\-\-repair\fP\&. .sp -First, the underlying repository data files are checked: +\fBNOTE:\fP .INDENT 0.0 -.IP \(bu 2 -For all segments, the segment magic header is checked. -.IP \(bu 2 -For all objects stored in the segments, all metadata (e.g. CRC and size) and -all data is read. The read data is checked by size and CRC. Bit rot and other -types of accidental damage can be detected this way. -.IP \(bu 2 -In repair mode, if an integrity error is detected in a segment, try to recover -as many objects from the segment as possible. -.IP \(bu 2 -In repair mode, make sure that the index is consistent with the data stored in -the segments. -.IP \(bu 2 -If checking a remote repo via \fBssh:\fP, the repo check is executed on the server -without causing significant network traffic. -.IP \(bu 2 -The repository check can be skipped using the \fB\-\-archives\-only\fP option. -.IP \(bu 2 -A repository check can be time consuming. Partial checks are possible with the -\fB\-\-max\-duration\fP option. +.INDENT 3.5 +\fB\-\-repair\fP is a \fBPOTENTIALLY DANGEROUS FEATURE\fP and might lead to data +loss! This does not just include data that was previously lost anyway, but +might include more data for kinds of corruption it is not capable of +dealing with. \fBBE VERY CAREFUL!\fP .UNINDENT +.UNINDENT +.sp +Pursuant to the previous warning it is also highly recommended to test the +reliability of the hardware running Borg with stress testing software. This +especially includes storage and memory testers. Unreliable hardware might lead +to additional data loss. .sp -Second, the consistency and correctness of the archive metadata is verified: +It is highly recommended to create a backup of your repository before running +in repair mode (i.e. running it with \fB\-\-repair\fP). +.sp +Repair mode will attempt to fix any corruptions found. Fixing corruptions does +not mean recovering lost data: Borg can not magically restore data lost due to +e.g. a hardware failure. Repairing a repository means sacrificing some data +for the sake of the repository as a whole and the remaining data. Hence it is, +by definition, a potentially lossy task. +.sp +In practice, repair mode hooks into both the repository and archive checks: .INDENT 0.0 -.IP \(bu 2 -Is the repo manifest present? If not, it is rebuilt from archive metadata -chunks (this requires reading and decrypting of all metadata and data). -.IP \(bu 2 -Check if archive metadata chunk is present; if not, remove archive from manifest. -.IP \(bu 2 -For all files (items) in the archive, for all chunks referenced by these -files, check if chunk is present. In repair mode, if a chunk is not present, -replace it with a same\-size replacement chunk of zeroes. If a previously lost -chunk reappears (e.g. via a later backup), in repair mode the all\-zero replacement -chunk will be replaced by the correct chunk. This requires reading of archive and -file metadata, but not data. -.IP \(bu 2 -In repair mode, when all the archives were checked, orphaned chunks are deleted -from the repo. One cause of orphaned chunks are input file related errors (like -read errors) in the archive creation process. -.IP \(bu 2 -In verify\-data mode, a complete cryptographic verification of the archive data -integrity is performed. This conflicts with \fB\-\-repository\-only\fP as this mode -only makes sense if the archive checks are enabled. The full details of this mode -are documented below. -.IP \(bu 2 -If checking a remote repo via \fBssh:\fP, the archive check is executed on the -client machine because it requires decryption, and this is always done client\-side -as key access is needed. -.IP \(bu 2 -The archive checks can be time consuming; they can be skipped using the -\fB\-\-repository\-only\fP option. +.IP 1. 3 +When checking the repository\(aqs consistency, repair mode will try to recover +as many objects from segments with integrity errors as possible, and ensure +that the index is consistent with the data stored in the segments. +.IP 2. 3 +When checking the consistency and correctness of archives, repair mode might +remove whole archives from the manifest if their archive metadata chunk is +corrupt or lost. On a chunk level (i.e. the contents of files), repair mode +will replace corrupt or lost chunks with a same\-size replacement chunk of +zeroes. If a previously zeroed chunk reappears, repair mode will restore +this lost chunk using the new chunk. Lastly, repair mode will also delete +orphaned chunks (e.g. caused by read errors while creating the archive). .UNINDENT .sp -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 complete check took 7 -hours, then running a daily check with \-\-max\-duration=3600 (1 hour) resulted in one -completed check per week. -.sp -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 -repository, decrypting and decompressing it. This is a cryptographic verification, -which will detect (accidental) corruption. For encrypted repositories it is -tamper\-resistant as well, unless the attacker has access to the keys. It is also very -slow. +Most steps taken by repair mode have a one\-time effect on the repository, like +removing a lost archive from the repository. However, replacing a corrupt or +lost chunk with an all\-zero replacement will have an ongoing effect on the +repository: When attempting to extract a file referencing an all\-zero chunk, +the \fBextract\fP command will distinctly warn about it. The FUSE filesystem +created by the \fBmount\fP command will reject reading such a \(dqzero\-patched\(dq +file unless a special mount option is given. +.sp +As mentioned earlier, Borg might be able to \(dqheal\(dq a \(dqzero\-patched\(dq file in +repair mode, if all its previously lost chunks reappear (e.g. via a later +backup). This is achieved by Borg not only keeping track of the all\-zero +replacement chunks, but also by keeping metadata about the lost chunks. In +repair mode Borg will check whether a previously lost chunk reappeared and will +replace the all\-zero replacement chunk by the reappeared chunk. If all lost +chunks of a \(dqzero\-patched\(dq file reappear, this effectively \(dqheals\(dq the file. +Consequently, if lost chunks were repaired earlier, it is advised to run +\fB\-\-repair\fP a second time after creating some new backups. .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 38c1c441b..9b4619baa 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands .SH SYNOPSIS diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index 02f78bcfe..9a76c394d 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2023-07-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 9daf0f98e..2a565cab0 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression .SH DESCRIPTION @@ -82,29 +82,70 @@ being any valid compression specifier. .TP .B obfuscate,SPEC,C[,L] Use compressed\-size obfuscation to make fingerprinting attacks based on -the observable stored chunk size more difficult. -Note: -\- you must combine this with encryption or it won\(aqt make any sense. -\- your repo size will be bigger, of course. +the observable stored chunk size more difficult. Note: +.INDENT 7.0 +.IP \(bu 2 +You must combine this with encryption, or it won\(aqt make any sense. +.IP \(bu 2 +Your repo size will be bigger, of course. +.IP \(bu 2 +A chunk is limited by the constant \fBMAX_DATA_SIZE\fP (cur. ~20MiB). +.UNINDENT +.sp +The SPEC value determines how the size obfuscation works: .sp -The SPEC value will determine how the size obfuscation will work: +\fIRelative random reciprocal size variation\fP (multiplicative) .sp -Relative random reciprocal size variation: Size will increase by a factor, relative to the compressed data size. -Smaller factors are often used, larger factors rarely. -1: factor 0.01 .. 100.0 -2: factor 0.1 .. 1000.0 -3: factor 1.0 .. 10000.0 -4: factor 10.0 .. 100000.0 -5: factor 100.0 .. 1000000.0 -6: factor 1000.0 .. 10000000.0 +Smaller factors are used often, larger factors rarely. +.sp +Available factors: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +1: 0.01 .. 100 +2: 0.1 .. 1,000 +3: 1 .. 10,000 +4: 10 .. 100,000 +5: 100 .. 1,000,000 +6: 1,000 .. 10,000,000 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Example probabilities for SPEC \fB1\fP: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +90 % 0.01 .. 0.1 + 9 % 0.1 .. 1 + 0.9 % 1 .. 10 + 0.09% 10 .. 100 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fIRandomly sized padding up to the given size\fP (additive) +.INDENT 7.0 +.INDENT 3.5 .sp -Add a randomly sized padding up to the given size: -110: 1kiB +.nf +.ft C +110: 1kiB (2 ^ (SPEC \- 100)) \&... 120: 1MiB \&... 123: 8MiB (max.) +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .sp Examples: @@ -120,7 +161,7 @@ borg create \-\-compression zlib REPO::ARCHIVE data borg create \-\-compression zlib,1 REPO::ARCHIVE data borg create \-\-compression auto,lzma,6 REPO::ARCHIVE data borg create \-\-compression auto,lzma ... -borg create \-\-compression obfuscate,3,none ... +borg create \-\-compression obfuscate,110,none ... borg create \-\-compression obfuscate,3,auto,zstd,10 ... borg create \-\-compression obfuscate,2,zstd,6 ... .ft P diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index d2050a0e8..e0cc8a0e7 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file .SH SYNOPSIS diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 92bc4d0d0..0419d36c3 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-create \- Create new archive .SH SYNOPSIS @@ -169,15 +169,15 @@ set mode to M in archive for stdin data (default: 0660) interpret PATH as command and store its stdout. See also section Reading from stdin below. .TP .B \-\-paths\-from\-stdin -read DELIM\-separated list of paths to backup from stdin. Will not recurse into directories. +read DELIM\-separated list of paths to backup from stdin. All control is external: it will back up all files given \- no more, no less. .TP .B \-\-paths\-from\-command interpret PATH as command and treat its output as \fB\-\-paths\-from\-stdin\fP .TP .BI \-\-paths\-delimiter \ DELIM -set path delimiter for \fB\-\-paths\-from\-stdin\fP and \fB\-\-paths\-from\-command\fP (default: n) +set path delimiter for \fB\-\-paths\-from\-stdin\fP and \fB\-\-paths\-from\-command\fP (default: \fB\en\fP) .UNINDENT -.SS Exclusion options +.SS Include/Exclude options .INDENT 0.0 .TP .BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN @@ -208,7 +208,7 @@ exclude files flagged NODUMP .INDENT 0.0 .TP .B \-x\fP,\fB \-\-one\-file\-system -stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs. +stay in the same file system and do not store mount points of other file systems \- this might behave different from your expectations, see the description below. .TP .B \-\-numeric\-owner deprecated, use \fB\-\-numeric\-ids\fP instead @@ -376,13 +376,13 @@ through using the \fB\-\-keep\-exclude\-tags\fP option. The \fB\-x\fP or \fB\-\-one\-file\-system\fP option excludes directories, that are mountpoints (and everything in them). It detects mountpoints by comparing the device number from the output of \fBstat()\fP of the directory and its parent directory. Specifically, it excludes directories for which \fBstat()\fP reports a device number different -from the device number of their parent. Be aware that in Linux (and possibly elsewhere) there are directories -with device number different from their parent, which the kernel does not consider a mountpoint and also the -other way around. Examples are bind mounts (possibly same device number, but always a mountpoint) and ALL -subvolumes of a btrfs (different device number from parent but not necessarily a mountpoint). Therefore when -using \fB\-\-one\-file\-system\fP, one should make doubly sure that the backup works as intended especially when using -btrfs. This is even more important, if the btrfs layout was created by someone else, e.g. a distribution -installer. +from the device number of their parent. +In general: be aware that there are directories with device number different from their parent, which the kernel +does not consider a mountpoint and also the other way around. +Linux examples for this are bind mounts (possibly same device number, but always a mountpoint) and ALL +subvolumes of a btrfs (different device number from parent but not necessarily a mountpoint). +macOS examples are the apfs mounts of a typical macOS installation. +Therefore, when using \fB\-\-one\-file\-system\fP, you should double\-check that the backup works as intended. .SS Item flags .sp \fB\-\-list\fP outputs a list of all files, directories and other diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 0e9fa9101..fd35fc1a0 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives .SH SYNOPSIS diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index e3e39bbbc..d85366b30 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -87,7 +87,7 @@ Only compare differences in content (exclude metadata differences) .B \-\-json\-lines Format output as JSON Lines. .UNINDENT -.SS Exclusion options +.SS Include/Exclude options .INDENT 0.0 .TP .BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 90e9b5818..bfbe690cd 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -100,7 +100,7 @@ filter program to pipe data through .B \-\-list output verbose list of items (files, dirs, ...) .UNINDENT -.SS Exclusion options +.SS Include/Exclude options .INDENT 0.0 .TP .BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index a278b56a6..0b2545c57 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents .SH SYNOPSIS @@ -105,7 +105,7 @@ write all extracted data to stdout .B \-\-sparse create holes in output sparse file from all\-zero chunks .UNINDENT -.SS Exclusion options +.SS Include/Exclude options .INDENT 0.0 .TP .BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN diff --git a/docs/man/borg-import-tar.1 b/docs/man/borg-import-tar.1 index 436d98331..9d65e8f69 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index d6102e0ac..4a8c415e9 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 "2023-03-22" "" "borg backup tool" +.TH "BORG-INFO" 1 "2023-07-20" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used .SH SYNOPSIS diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index 84dae864d..ef66ad84d 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]] < |