diff options
36 files changed, 757 insertions, 420 deletions
diff --git a/docs/man/borg-benchmark-cpu.1 b/docs/man/borg-benchmark-cpu.1 new file mode 100644 index 000000000..e6c51936b --- /dev/null +++ b/docs/man/borg-benchmark-cpu.1 @@ -0,0 +1,53 @@ +.\" Man page generated from reStructuredText. +. +.TH BORG-BENCHMARK-CPU 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-benchmark-cpu \- Benchmark CPU bound operations. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +borg [common options] benchmark cpu [options] +.SH DESCRIPTION +.sp +This command benchmarks misc. CPU bound borg operations. +.sp +It creates input data in memory, runs the operation and then displays throughput. +To reduce outside influence on the timings, please make sure to run this with: +\- an otherwise as idle as possible machine +\- enough free memory so there will be no slow down due to paging activity +.SH OPTIONS +.sp +See \fIborg\-common(1)\fP for common options of Borg commands. +.SH SEE ALSO +.sp +\fIborg\-common(1)\fP +.SH AUTHOR +The Borg Collective +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 041a88a21..efa4df554 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-BENCHMARK-CRUD 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK-CRUD" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. .SH SYNOPSIS .sp borg [common options] benchmark crud [options] REPOSITORY PATH diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index 92b5515ef..0cd5e90cb 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-BENCHMARK 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-benchmark \- benchmark command . .nr rst2man-indent-level 0 . @@ -27,12 +30,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-benchmark \- benchmark command .SH SYNOPSIS .nf borg [common options] benchmark crud ... +borg [common options] benchmark cpu ... .fi .sp .SH DESCRIPTION @@ -40,7 +41,7 @@ borg [common options] benchmark crud ... These commands do various benchmarks. .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-benchmark\-crud(1)\fP +\fIborg\-common(1)\fP, \fIborg\-benchmark\-crud(1)\fP, \fIborg\-benchmark\-cpu(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index 31bc50bba..bd01367c9 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-BREAK-LOCK 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BREAK-LOCK" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. .SH SYNOPSIS .sp borg [common options] break\-lock [options] [REPOSITORY] diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 29265c0ea..0dfbc27b1 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-CHECK 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-check \- Check repository consistency . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CHECK" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-check \- Check repository consistency .SH SYNOPSIS .sp borg [common options] check [options] [REPOSITORY_OR_ARCHIVE] @@ -104,15 +104,18 @@ The archive checks can be time consuming; they can be skipped using the The \fB\-\-max\-duration\fP option can be used to split a long\-running repository check into multiple partial checks. After the given number of seconds the check is interrupted. The next partial check will continue where the previous one stopped, -until the complete repository has been checked. Example: Assuming a full check took 7 +until the complete repository has been checked. Example: Assuming a complete check took 7 hours, then running a daily check with \-\-max\-duration=3600 (1 hour) resulted in one -full check per week. +completed check per week. .sp -Attention: Partial checks can only do way less checking than a full check (only the -CRC32 checks on segment file entries are done), and cannot be combined with the -\fB\-\-repair\fP option. Partial checks may therefore be useful only with very large -repositories where a full check took too long. Doing a full repository check aborts a -partial check; the next partial check will restart from the beginning. +Attention: A partial \-\-repository\-only check can only do way less checking than a full +\-\-repository\-only check: only the non\-cryptographic checksum checks on segment file +entries are done, while a full \-\-repository\-only check would also do a repo index check. +A partial check cannot be combined with the \fB\-\-repair\fP option. Partial checks +may therefore be useful only with very large repositories where a full check would take +too long. +Doing a full repository check aborts a partial check; the next partial check will restart +from the beginning. .sp The \fB\-\-verify\-data\fP option will perform a full integrity verification (as opposed to checking the CRC32 of the segment) of data, which means reading the data from the @@ -132,19 +135,19 @@ repository or archive to check consistency of .SS optional arguments .INDENT 0.0 .TP -.B \-\-repository\-only +.B \-\-repository\-only only perform repository checks .TP -.B \-\-archives\-only +.B \-\-archives\-only only perform archives checks .TP -.B \-\-verify\-data +.B \-\-verify\-data perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP) .TP -.B \-\-repair +.B \-\-repair attempt to repair any inconsistencies found .TP -.B \-\-save\-space +.B \-\-save\-space work slower, but using less space .TP .BI \-\-max\-duration \ SECONDS diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 9b6f8dfa9..85b46e70f 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-COMMON 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-common \- Common options of Borg commands . .nr rst2man-indent-level 0 . @@ -27,52 +30,49 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMMON" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-common \- Common options of Borg commands .SH SYNOPSIS .INDENT 0.0 .TP -.B \-h\fP,\fB \-\-help +.B \-h\fP,\fB \-\-help show this help message and exit .TP -.B \-\-critical +.B \-\-critical work on log level CRITICAL .TP -.B \-\-error +.B \-\-error work on log level ERROR .TP -.B \-\-warning +.B \-\-warning work on log level WARNING (default) .TP -.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose +.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose work on log level INFO .TP -.B \-\-debug +.B \-\-debug enable debug output, work on log level DEBUG .TP .BI \-\-debug\-topic \ TOPIC enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified. .TP -.B \-p\fP,\fB \-\-progress +.B \-p\fP,\fB \-\-progress show progress information .TP -.B \-\-iec +.B \-\-iec format using IEC units (1KiB = 1024B) .TP -.B \-\-log\-json +.B \-\-log\-json Output one JSON object per log line instead of formatted text. .TP .BI \-\-lock\-wait \ SECONDS wait at most SECONDS for acquiring a repository/cache lock (default: 1). .TP -.B \-\-bypass\-lock +.B \-\-bypass\-lock Bypass locking mechanism .TP -.B \-\-show\-version +.B \-\-show\-version show/log the borg version .TP -.B \-\-show\-rc +.B \-\-show\-rc show/log the return code (rc) .TP .BI \-\-umask \ M @@ -93,7 +93,7 @@ deprecated, use \fB\-\-upload\-buffer\fP instead .BI \-\-upload\-buffer \ UPLOAD_BUFFER set network upload buffer size in MiB. (default: 0=no buffer) .TP -.B \-\-consider\-part\-files +.B \-\-consider\-part\-files treat part files like normal files (e.g. to list/extract them) .TP .BI \-\-debug\-profile \ FILE diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index f159a0875..79f8fc4e8 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-COMPACT 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-compact \- compact segment files in the repository . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPACT" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-compact \- compact segment files in the repository .SH SYNOPSIS .sp borg [common options] compact [options] [REPOSITORY] @@ -53,7 +53,8 @@ When using \fB\-\-verbose\fP, borg will output an estimate of the freed space. .sp After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP to clean up the numerous 17byte commit\-only segments that borg 1.1 did not clean up -due to a bug. It is enough to do that once per repository. +due to a bug. It is enough to do that once per repository. After cleaning up the +commits, borg will also do a normal compaction. .sp See \fIseparate_compaction\fP in Additional Notes for more details. .SH OPTIONS @@ -68,7 +69,7 @@ repository to compact .SS optional arguments .INDENT 0.0 .TP -.B \-\-cleanup\-commits +.B \-\-cleanup\-commits cleanup commit\-only 17\-byte segment files .TP .BI \-\-threshold \ PERCENT diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 274aa86ed..a55a7dba7 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-COMPRESSION 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-compression \- Details regarding compression . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPRESSION" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-compression \- Details regarding compression .SH DESCRIPTION .sp It is no problem to mix different compression methods in one repo, diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index 24e0d708c..26ccffdd6 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-CONFIG 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-config \- get, set, and delete values in a repository or cache config file . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CONFIG" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-config \- get, set, and delete values in a repository or cache config file .SH SYNOPSIS .sp borg [common options] config [options] [REPOSITORY] [NAME] [VALUE] @@ -65,13 +65,13 @@ new value for key .SS optional arguments .INDENT 0.0 .TP -.B \-c\fP,\fB \-\-cache +.B \-c\fP,\fB \-\-cache get and set values from the repo cache .TP -.B \-d\fP,\fB \-\-delete +.B \-d\fP,\fB \-\-delete delete the key from the config file .TP -.B \-l\fP,\fB \-\-list +.B \-l\fP,\fB \-\-list list the configuration of the repo .UNINDENT .SH EXAMPLES diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 3815b178c..887814626 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-CREATE 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-create \- Create new archive . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CREATE" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-create \- Create new archive .SH SYNOPSIS .sp borg [common options] create [options] ARCHIVE [PATH...] @@ -135,22 +135,22 @@ paths to archive .SS optional arguments .INDENT 0.0 .TP -.B \-n\fP,\fB \-\-dry\-run +.B \-n\fP,\fB \-\-dry\-run do not create a backup archive .TP -.B \-s\fP,\fB \-\-stats +.B \-s\fP,\fB \-\-stats print statistics for the created archive .TP -.B \-\-list +.B \-\-list output verbose list of items (files, dirs, ...) .TP .BI \-\-filter \ STATUSCHARS only display items with the given status characters (see description) .TP -.B \-\-json +.B \-\-json output stats as JSON. Implies \fB\-\-stats\fP\&. .TP -.B \-\-no\-cache\-sync +.B \-\-no\-cache\-sync experimental: do not synchronize the cache. Implies not using the files cache. .TP .BI \-\-stdin\-name \ NAME @@ -160,18 +160,18 @@ 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) .TP -.B \-\-content\-from\-command +.B \-\-content\-from\-command interpret PATH as command and store its stdout. See also section Reading from stdin below. .TP -.B \-\-paths\-from\-stdin +.B \-\-paths\-from\-stdin read DELIM\-separated list of paths to backup from stdin. Will not recurse into directories. .TP -.B \-\-paths\-from\-command +.B \-\-paths\-from\-command interpret PATH as command and treat its output as \fB\-\-paths\-from\-stdin\fP .TP .BI \-\-paths\-delimiter \ DELIM @@ -192,61 +192,61 @@ include/exclude paths matching PATTERN .BI \-\-patterns\-from \ PATTERNFILE read include/exclude patterns from PATTERNFILE, one per line .TP -.B \-\-exclude\-caches +.B \-\-exclude\-caches exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP) .TP .BI \-\-exclude\-if\-present \ NAME exclude directories that are tagged by containing a filesystem object with the given NAME .TP -.B \-\-keep\-exclude\-tags +.B \-\-keep\-exclude\-tags if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive .TP -.B \-\-exclude\-nodump +.B \-\-exclude\-nodump exclude files flagged NODUMP .UNINDENT .SS Filesystem options .INDENT 0.0 .TP -.B \-x\fP,\fB \-\-one\-file\-system +.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. .TP -.B \-\-numeric\-owner +.B \-\-numeric\-owner deprecated, use \fB\-\-numeric\-ids\fP instead .TP -.B \-\-numeric\-ids +.B \-\-numeric\-ids only store numeric user and group identifiers .TP -.B \-\-noatime +.B \-\-noatime do not store atime into archive .TP -.B \-\-atime +.B \-\-atime do store atime into archive .TP -.B \-\-noctime +.B \-\-noctime do not store ctime into archive .TP -.B \-\-nobirthtime +.B \-\-nobirthtime do not store birthtime (creation date) into archive .TP -.B \-\-nobsdflags +.B \-\-nobsdflags deprecated, use \fB\-\-noflags\fP instead .TP -.B \-\-noflags +.B \-\-noflags do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive .TP -.B \-\-noacls +.B \-\-noacls do not read and store ACLs into archive .TP -.B \-\-noxattrs +.B \-\-noxattrs do not read and store xattrs into archive .TP -.B \-\-sparse +.B \-\-sparse detect sparse holes in input (supported only by fixed chunker) .TP .BI \-\-files\-cache \ MODE operate files cache in MODE. default: ctime,size,inode .TP -.B \-\-read\-special +.B \-\-read\-special open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files. .UNINDENT .SS Archive options diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 8435c20ff..68639c1ea 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-DELETE 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-delete \- Delete an existing repository or archives . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DELETE" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-delete \- Delete an existing repository or archives .SH SYNOPSIS .sp borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...] @@ -76,25 +76,25 @@ archives to delete .SS optional arguments .INDENT 0.0 .TP -.B \-n\fP,\fB \-\-dry\-run +.B \-n\fP,\fB \-\-dry\-run do not change repository .TP -.B \-\-list +.B \-\-list output verbose list of archives .TP -.B \-s\fP,\fB \-\-stats +.B \-s\fP,\fB \-\-stats print statistics for the deleted archive .TP -.B \-\-cache\-only +.B \-\-cache\-only delete only the local cache for the given repository .TP -.B \-\-force +.B \-\-force force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work. .TP -.B \-\-keep\-security\-info +.B \-\-keep\-security\-info keep the local security info when deleting a repository .TP -.B \-\-save\-space +.B \-\-save\-space work slower, but using less space .UNINDENT .SS Archive filters diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 6cce20acd..2ccf05e03 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-DIFF 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-diff \- Diff contents of two archives . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DIFF" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-diff \- Diff contents of two archives .SH SYNOPSIS .sp borg [common options] diff [options] REPO::ARCHIVE1 ARCHIVE2 [PATH...] @@ -69,19 +69,19 @@ paths of items inside the archives to compare; patterns are supported .SS optional arguments .INDENT 0.0 .TP -.B \-\-numeric\-owner +.B \-\-numeric\-owner deprecated, use \fB\-\-numeric\-ids\fP instead .TP -.B \-\-numeric\-ids +.B \-\-numeric\-ids only consider numeric user and group identifiers .TP -.B \-\-same\-chunker\-params +.B \-\-same\-chunker\-params Override check of chunker parameters. .TP -.B \-\-sort +.B \-\-sort Sort the output lines by file path. .TP -.B \-\-json\-lines +.B \-\-json\-lines Format output as JSON Lines. .UNINDENT .SS Exclusion options diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 4a26acb6b..437aad535 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-EXPORT-TAR 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-export-tar \- Export archive contents as a tarball . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXPORT-TAR" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS .sp borg [common options] export\-tar [options] ARCHIVE FILE [PATH...] @@ -59,12 +59,45 @@ Alternatively, a \fB\-\-tar\-filter\fP program may be explicitly specified. It s read the uncompressed tar stream from stdin and write a compressed/filtered tar stream to stdout. .sp -The generated tarball uses the GNU tar format. -.sp -export\-tar is a lossy conversion: -BSD flags, ACLs, extended attributes (xattrs), atime and ctime are not exported. -Timestamp resolution is limited to whole seconds, not the nanosecond resolution -otherwise supported by Borg. +Depending on the \fB\-tar\-format\fP option, these formats are created: +.TS +center; +|l|l|l|. +_ +T{ +\-\-tar\-format +T} T{ +Specification +T} T{ +Metadata +T} +_ +T{ +BORG +T} T{ +BORG specific, like PAX +T} T{ +all as supported by borg +T} +_ +T{ +PAX +T} T{ +POSIX.1\-2001 (pax) format +T} T{ +GNU + atime/ctime/mtime ns +T} +_ +T{ +GNU +T} T{ +GNU tar format +T} T{ +mtime s, no atime/ctime, +no ACLs/xattrs/bsdflags +T} +_ +.TE .sp A \fB\-\-sparse\fP option (as found in borg extract) is not supported. .sp @@ -94,11 +127,14 @@ paths to extract; patterns are supported .SS optional arguments .INDENT 0.0 .TP -.B \-\-tar\-filter +.B \-\-tar\-filter filter program to pipe data through .TP -.B \-\-list +.B \-\-list output verbose list of items (files, dirs, ...) +.TP +.BI \-\-tar\-format \ FMT +select tar format: BORG, PAX or GNU .UNINDENT .SS Exclusion options .INDENT 0.0 @@ -118,31 +154,6 @@ read include/exclude patterns from PATTERNFILE, one per line .BI \-\-strip\-components \ NUMBER Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. .UNINDENT -.SH EXAMPLES -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -# export as uncompressed tar -$ borg export\-tar /path/to/repo::Monday Monday.tar - -# exclude some types, compress using gzip -$ 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 - -# 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" -.ft P -.fi -.UNINDENT -.UNINDENT .SH SEE ALSO .sp \fIborg\-common(1)\fP diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 9d155d2e9..69d2a0e41 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-EXTRACT 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-extract \- Extract archive contents . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXTRACT" 1 "2022-02-19" "" "borg backup tool" -.SH NAME -borg-extract \- Extract archive contents .SH SYNOPSIS .sp borg [common options] extract [options] ARCHIVE [PATH...] @@ -75,34 +75,34 @@ paths to extract; patterns are supported .SS optional arguments .INDENT 0.0 .TP -.B \-\-list +.B \-\-list output verbose list of items (files, dirs, ...) .TP -.B \-n\fP,\fB \-\-dry\-run +.B \-n\fP,\fB \-\-dry\-run do not actually change any files .TP -.B \-\-numeric\-owner +.B \-\-numeric\-owner deprecated, use \fB\-\-numeric\-ids\fP instead .TP -.B \-\-numeric\-ids +.B \-\-numeric\-ids only obey numeric user and group identifiers .TP -.B \-\-nobsdflags +.B \-\-nobsdflags deprecated, use \fB\-\-noflags\fP instead .TP -.B \-\-noflags +.B \-\-noflags do not extract/set flags (e.g. NODUMP, IMMUTABLE) .TP -.B \-\-noacls +.B \-\-noacls do not extract/set ACLs .TP -.B \-\-noxattrs +.B \-\-noxattrs do not extract/set xattrs .TP -.B \-\-stdout +.B \-\-stdout write all extracted data to stdout .TP -.B \-\-sparse +.B \-\-sparse create holes in output sparse file from all\-zero chunks .UNINDENT .SS Exclusion options diff --git a/docs/man/borg-import-tar.1 b/docs/man/borg-import-tar.1 index 9c9f2a11a..dc8439775 100644 --- a/docs/man/borg-import-tar.1 +++ b/docs/man/borg-import-tar.1 @@ -1,5 +1,8 @@ .\" Man page generated from reStructuredText. . +.TH BORG-IMPORT-TAR 1 "2022-04-14" "" "borg backup tool" +.SH NAME +borg-import-tar \- Create a backup archive from a tarball . .nr rst2man-indent-level 0 . @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |