diff options
author | Thomas Waldmann <tw@waldmann-edv.de> | 2022-01-23 15:53:42 +0100 |
---|---|---|
committer | Thomas Waldmann <tw@waldmann-edv.de> | 2022-01-23 15:53:42 +0100 |
commit | 61c7ee2b3580222453b0644e2cce26f37c526369 (patch) | |
tree | 9ea15557321fa86419cf0a90a729259f04091177 /docs/man | |
parent | 572e996d9a9479abb8c9e50a03d5b96ca413ef90 (diff) |
build_man
Diffstat (limited to 'docs/man')
34 files changed, 483 insertions, 246 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index c07348d25..2aaa58f4e 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK-CRUD 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 069942370..dd28a1951 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-benchmark \- benchmark command . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "borg backup tool" +.SH NAME +borg-benchmark \- benchmark command .SH SYNOPSIS .nf borg [common options] benchmark crud ... diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index ccc411a3d..9acbf8851 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BREAK-LOCK 1 "2021-05-11" "" "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 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 dd926fc80..732372702 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHECK 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-check \- Check repository consistency . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "borg backup tool" +.SH NAME +borg-check \- Check repository consistency .SH SYNOPSIS .sp borg [common options] check [options] [REPOSITORY_OR_ARCHIVE] @@ -40,6 +40,11 @@ The check command verifies the consistency of a repository and the corresponding 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! .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. +.sp First, the underlying repository data files are checked: .INDENT 0.0 .IP \(bu 2 @@ -83,6 +88,11 @@ 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. @@ -122,19 +132,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 acd460829..8fe2ca702 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMMON 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-common \- Common options of Borg commands . .nr rst2man-indent-level 0 . @@ -30,49 +27,52 @@ 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-01-23" "" "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 109d1c3bb..cd6faf243 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPACT 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-compact \- compact segment files in the repository . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "borg backup tool" +.SH NAME +borg-compact \- compact segment files in the repository .SH SYNOPSIS .sp borg [common options] compact [options] [REPOSITORY] @@ -68,7 +68,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 95e45320a..f6672f500 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPRESSION 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-compression \- Details regarding compression . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 93db8f909..a92fe2d63 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CONFIG 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-config \- get, set, and delete values in a repository or cache config file . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 7e8fe2a74..178a2d1cb 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CREATE 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-create \- Create new archive . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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: \(aqroot\(aq) +set group GROUP in archive for stdin data (default: \(aqwheel\(aq) .TP .BI \-\-stdin\-mode \ M set mode to M in archive for stdin data (default: 0660) .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 @@ experimental: include/exclude paths matching PATTERN .BI \-\-patterns\-from \ PATTERNFILE experimental: 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 8d8f7afc7..b08c8fbb1 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DELETE 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-delete \- Delete an existing repository or archives . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 6e8d70447..af8156210 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DIFF 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-diff \- Diff contents of two archives . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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 e744b0777..7fccdc1b9 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXPORT-TAR 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-export-tar \- Export archive contents as a tarball . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "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...] @@ -44,14 +44,18 @@ based on its file extension and pipe the tarball through an appropriate filter before writing it to FILE: .INDENT 0.0 .IP \(bu 2 -\&.tar.gz: gzip +\&.tar.gz or .tgz: gzip +.IP \(bu 2 +\&.tar.bz2 or .tbz: bzip2 +.IP \(bu 2 +\&.tar.xz or .txz: xz .IP \(bu 2 -\&.tar.bz2: bzip2 +\&.tar.zstd: zstd .IP \(bu 2 -\&.tar.xz: xz +\&.tar.lz4: lz4 .UNINDENT .sp -Alternatively a \fB\-\-tar\-filter\fP program may be explicitly specified. It should +Alternatively, a \fB\-\-tar\-filter\fP program may be explicitly specified. It should read the uncompressed tar stream from stdin and write a compressed/filtered tar stream to stdout. .sp @@ -90,10 +94,10 @@ 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, ...) .UNINDENT .SS Exclusion options diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 152117ec4..ba3606888 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXTRACT 1 "2021-05-11" "" "borg backup tool" -.SH NAME -borg-extract \- Extract archive contents . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ 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-01-23" "" "borg backup tool" +.SH NAME +borg-extract \- Extract archive contents .SH SYNOPSIS .sp borg [common options] extract [options] ARCHIVE [PATH...] @@ -71,34 +71,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 new file mode 100644 index 000000000..8b90e6d61 --- /dev/null +++ b/docs/man/borg-import-tar.1 @@ -0,0 +1,127 @@ +.\" Man page generated from reStructuredText. +. +. +.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 +.. +.TH "BORG-IMPORT-TAR" 1 "2022-01-23" "" "borg backup tool" +.SH NAME +borg-import-tar \- Create a backup archive from a tarball +.SH SYNOPSIS +.sp +borg [common options] import\-tar [options] ARCHIVE TARFILE +.SH DESCRIPTION +.sp +This command creates a backup archive from a tarball. +.sp +When giving \(aq\-\(aq as path, Borg will read a tar stream from standard input. +.sp +By default (\-\-tar\-filter=auto) Borg will detect whether the file is compressed +based on its file extension and pipe the file through an appropriate filter: +.INDENT 0.0 +.IP \(bu 2 +\&.tar.gz or .tgz: gzip \-d +.IP \(bu 2 +\&.tar.bz2 or .tbz: bzip2 \-d +.IP \(bu 2 +\&.tar.xz or .txz: xz \-d +.IP \(bu 2 +\&.tar.zstd: zstd \-d +.IP \(bu 2 +\&.tar.lz4: lz4 \-d +.UNINDENT +.sp +Alternatively, a \-\-tar\-filter program may be explicitly specified. It should +read compressed data from stdin and output an uncompressed tar stream on +stdout. +.sp +Most documentation of borg create applies. Note that this command does not +support excluding files. +.sp +import\-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. +.sp +A \fB\-\-sparse\fP option (as found in borg create) is not supported. +.sp +import\-tar reads POSIX.1\-1988 (ustar), POSIX.1\-2001 (pax), GNU tar, UNIX V7 tar +and SunOS tar with extended attributes. +.SH OPTIONS +.sp +See \fIborg\-common(1)\fP for common options of Borg commands. +.SS arguments +.INDENT 0.0 +.TP +.B ARCHIVE +name of archive to create (must be also a valid directory name) +.TP +.B TARFILE +input tar file. "\-" to read from stdin instead. +.UNINDENT +.SS optional arguments +.INDENT 0.0 +.TP +.B \-\-tar\-filter +filter program to pipe data through +.TP +.B \-s\fP,\fB \-\-stats +print statistics for the created archive +.TP +.B \-\-list +output verbose list of items (files, dirs, ...) +.TP +.BI \-\-filter \ STATUSCHARS +only display items with the given status characters +.TP +.B \-\-json +output stats as JSON (implies \-\-stats) +.UNINDENT +.SS Archive options +.INDENT 0.0 +.TP +.BI \-\-comment \ COMMENT +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. +.TP +.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS +write checkpoint every SECONDS seconds (Default: 1800) +.TP +.BI \-\-chunker\-params \ PARAMS +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. +.UNINDENT +.SH SEE ALSO +.sp +\fIborg\-common(1)\fP +.SH AUTHOR +The Borg Collective +.\" Generated by docutils manpage |