浏览代码

build_man

Thomas Waldmann 4 年之前
父节点
当前提交
95a719eba4

+ 1 - 1
docs/man/borg-benchmark-crud.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-BENCHMARK-CRUD 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-BENCHMARK-CRUD 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .
 .

+ 1 - 1
docs/man/borg-benchmark.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-BENCHMARK 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-BENCHMARK 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-benchmark \- benchmark command
 borg-benchmark \- benchmark command
 .
 .

+ 1 - 1
docs/man/borg-break-lock.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-BREAK-LOCK 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-BREAK-LOCK 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .
 .

+ 1 - 1
docs/man/borg-change-passphrase.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-CHANGE-PASSPHRASE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-CHANGE-PASSPHRASE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-change-passphrase \- Change repository key file passphrase
 borg-change-passphrase \- Change repository key file passphrase
 .
 .

+ 1 - 1
docs/man/borg-check.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-CHECK 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-CHECK 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-check \- Check repository consistency
 borg-check \- Check repository consistency
 .
 .

+ 1 - 1
docs/man/borg-common.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-COMMON 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-COMMON 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-common \- Common options of Borg commands
 borg-common \- Common options of Borg commands
 .
 .

+ 1 - 1
docs/man/borg-compression.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-COMPRESSION 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-COMPRESSION 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-compression \- Details regarding compression
 borg-compression \- Details regarding compression
 .
 .

+ 1 - 1
docs/man/borg-config.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-CONFIG 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-CONFIG 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-config \- get, set, and delete values in a repository or cache config file
 borg-config \- get, set, and delete values in a repository or cache config file
 .
 .

+ 7 - 1
docs/man/borg-create.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-CREATE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-CREATE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-create \- Create new archive
 borg-create \- Create new archive
 .
 .
@@ -215,6 +215,12 @@ do not store birthtime (creation date) into archive
 .B \-\-nobsdflags
 .B \-\-nobsdflags
 do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive
 do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive
 .TP
 .TP
+.B \-\-noacls
+do not read and store ACLs into archive
+.TP
+.B \-\-noxattrs
+do not read and store xattrs into archive
+.TP
 .B \-\-ignore\-inode
 .B \-\-ignore\-inode
 ignore inode data in the file metadata cache used to detect unchanged files.
 ignore inode data in the file metadata cache used to detect unchanged files.
 .TP
 .TP

+ 1 - 1
docs/man/borg-delete.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-DELETE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-DELETE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-delete \- Delete an existing repository or archives
 borg-delete \- Delete an existing repository or archives
 .
 .

+ 13 - 2
docs/man/borg-diff.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-DIFF 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-DIFF 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-diff \- Diff contents of two archives
 borg-diff \- Diff contents of two archives
 .
 .
@@ -77,6 +77,9 @@ Override check of chunker parameters.
 .TP
 .TP
 .B \-\-sort
 .B \-\-sort
 Sort the output lines by file path.
 Sort the output lines by file path.
+.TP
+.B \-\-json\-lines
+Format output as JSON Lines.
 .UNINDENT
 .UNINDENT
 .SS Exclusion options
 .SS Exclusion options
 .INDENT 0.0
 .INDENT 0.0
@@ -111,6 +114,7 @@ $ chmod a+x file1
 $ echo "something" >> file2
 $ echo "something" >> file2
 $ borg create ../testrepo::archive2 .
 $ borg create ../testrepo::archive2 .
 
 
+$ echo "testing 123" >> file1
 $ rm file3
 $ rm file3
 $ touch file4
 $ touch file4
 $ borg create ../testrepo::archive3 .
 $ borg create ../testrepo::archive3 .
@@ -121,14 +125,21 @@ $ borg diff testrepo::archive1 archive2
    +135 B    \-252 B file2
    +135 B    \-252 B file2
 
 
 $ borg diff testrepo::archive2 archive3
 $ borg diff testrepo::archive2 archive3
+    +17 B      \-5 B file1
 added           0 B file4
 added           0 B file4
 removed         0 B file3
 removed         0 B file3
 
 
 $ borg diff testrepo::archive1 archive3
 $ borg diff testrepo::archive1 archive3
-[\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
+    +17 B      \-5 B [\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
    +135 B    \-252 B file2
    +135 B    \-252 B file2
 added           0 B file4
 added           0 B file4
 removed         0 B file3
 removed         0 B file3
+
+$ borg diff \-\-json\-lines testrepo::archive1 archive3
+{"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "\-rw\-r\-\-r\-\-", "new_mode": "\-rwxr\-xr\-x"}]}
+{"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]}
+{"path": "file4", "changes": [{"type": "added", "size": 0}]}
+{"path": "file3", "changes": [{"type": "removed", "size": 0}]
 .ft P
 .ft P
 .fi
 .fi
 .UNINDENT
 .UNINDENT

+ 1 - 1
docs/man/borg-export-tar.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-EXPORT-TAR 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-EXPORT-TAR 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-export-tar \- Export archive contents as a tarball
 borg-export-tar \- Export archive contents as a tarball
 .
 .

+ 7 - 1
docs/man/borg-extract.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-EXTRACT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-EXTRACT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-extract \- Extract archive contents
 borg-extract \- Extract archive contents
 .
 .
@@ -83,6 +83,12 @@ only obey numeric user and group identifiers
 .B \-\-nobsdflags
 .B \-\-nobsdflags
 do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)
 do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)
 .TP
 .TP
+.B \-\-noacls
+do not extract/set ACLs
+.TP
+.B \-\-noxattrs
+do not extract/set xattrs
+.TP
 .B \-\-stdout
 .B \-\-stdout
 write all extracted data to stdout
 write all extracted data to stdout
 .TP
 .TP

+ 1 - 1
docs/man/borg-info.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-INFO 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-INFO 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-info \- Show archive details such as disk space used
 borg-info \- Show archive details such as disk space used
 .
 .

+ 1 - 1
docs/man/borg-init.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-INIT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-INIT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-init \- Initialize an empty repository
 borg-init \- Initialize an empty repository
 .
 .

+ 1 - 1
docs/man/borg-key-change-passphrase.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-key-change-passphrase \- Change repository key file passphrase
 borg-key-change-passphrase \- Change repository key file passphrase
 .
 .

+ 1 - 1
docs/man/borg-key-export.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-KEY-EXPORT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-KEY-EXPORT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-key-export \- Export the repository key for backup
 borg-key-export \- Export the repository key for backup
 .
 .

+ 1 - 1
docs/man/borg-key-import.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-KEY-IMPORT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-KEY-IMPORT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-key-import \- Import the repository key from backup
 borg-key-import \- Import the repository key from backup
 .
 .

+ 1 - 1
docs/man/borg-key-migrate-to-repokey.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 .
 .

+ 1 - 1
docs/man/borg-key.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-KEY 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-KEY 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-key \- Manage a keyfile or repokey of a repository
 borg-key \- Manage a keyfile or repokey of a repository
 .
 .

+ 17 - 1
docs/man/borg-list.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-LIST 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-LIST 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-list \- List archive or repository contents
 borg-list \- List archive or repository contents
 .
 .
@@ -231,6 +231,10 @@ isoctime
 .IP \(bu 2
 .IP \(bu 2
 isoatime
 isoatime
 .IP \(bu 2
 .IP \(bu 2
+blake2b
+.IP \(bu 2
+blake2s
+.IP \(bu 2
 md5
 md5
 .IP \(bu 2
 .IP \(bu 2
 sha1
 sha1
@@ -241,8 +245,20 @@ sha256
 .IP \(bu 2
 .IP \(bu 2
 sha384
 sha384
 .IP \(bu 2
 .IP \(bu 2
+sha3_224
+.IP \(bu 2
+sha3_256
+.IP \(bu 2
+sha3_384
+.IP \(bu 2
+sha3_512
+.IP \(bu 2
 sha512
 sha512
 .IP \(bu 2
 .IP \(bu 2
+shake_128
+.IP \(bu 2
+shake_256
+.IP \(bu 2
 archiveid
 archiveid
 .IP \(bu 2
 .IP \(bu 2
 archivename
 archivename

+ 1 - 1
docs/man/borg-mount.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-MOUNT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-MOUNT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .
 .

+ 3 - 3
docs/man/borg-patterns.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-PATTERNS 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-PATTERNS 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-patterns \- Details regarding patterns
 borg-patterns \- Details regarding patterns
 .
 .
@@ -126,14 +126,14 @@ wildcards at most.
 .UNINDENT
 .UNINDENT
 .sp
 .sp
 Exclusions can be passed via the command line option \fB\-\-exclude\fP\&. When used
 Exclusions can be passed via the command line option \fB\-\-exclude\fP\&. When used
-from within a shell the patterns should be quoted to protect them from
+from within a shell, the patterns should be quoted to protect them from
 expansion.
 expansion.
 .sp
 .sp
 The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text
 The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text
 file with one pattern per line. Lines empty or starting with the number sign
 file with one pattern per line. Lines empty or starting with the number sign
 (\(aq#\(aq) after removing whitespace on both ends are ignored. The optional style
 (\(aq#\(aq) after removing whitespace on both ends are ignored. The optional style
 selector prefix is also supported for patterns loaded from a file. Due to
 selector prefix is also supported for patterns loaded from a file. Due to
-whitespace removal paths with whitespace at the beginning or end can only be
+whitespace removal, paths with whitespace at the beginning or end can only be
 excluded using regular expressions.
 excluded using regular expressions.
 .sp
 .sp
 To test your exclusion patterns without performing an actual backup you can
 To test your exclusion patterns without performing an actual backup you can

+ 1 - 1
docs/man/borg-placeholders.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-PLACEHOLDERS 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-PLACEHOLDERS 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-placeholders \- Details regarding placeholders
 borg-placeholders \- Details regarding placeholders
 .
 .

+ 1 - 1
docs/man/borg-prune.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-PRUNE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-prune \- Prune repository archives according to specified rules
 borg-prune \- Prune repository archives according to specified rules
 .
 .

+ 1 - 1
docs/man/borg-recreate.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-RECREATE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-RECREATE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-recreate \- Re-create archives
 borg-recreate \- Re-create archives
 .
 .

+ 1 - 1
docs/man/borg-rename.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-RENAME 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-RENAME 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-rename \- Rename an existing archive
 borg-rename \- Rename an existing archive
 .
 .

+ 1 - 1
docs/man/borg-serve.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-SERVE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-SERVE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-serve \- Start in server mode. This command is usually not used manually.
 borg-serve \- Start in server mode. This command is usually not used manually.
 .
 .

+ 1 - 1
docs/man/borg-umount.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-UMOUNT 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-UMOUNT 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-umount \- un-mount the FUSE filesystem
 borg-umount \- un-mount the FUSE filesystem
 .
 .

+ 1 - 1
docs/man/borg-upgrade.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-UPGRADE 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-UPGRADE 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-upgrade \- upgrade a repository from a previous version
 borg-upgrade \- upgrade a repository from a previous version
 .
 .

+ 1 - 1
docs/man/borg-with-lock.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORG-WITH-LOCK 1 "2020-12-24" "" "borg backup tool"
+.TH BORG-WITH-LOCK 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borg-with-lock \- run a user specified command with the repository lock held
 borg-with-lock \- run a user specified command with the repository lock held
 .
 .

+ 1 - 1
docs/man/borgfs.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" Man page generated from reStructuredText.
 .
 .
-.TH BORGFS 1 "2020-12-24" "" "borg backup tool"
+.TH BORGFS 1 "2021-03-22" "" "borg backup tool"
 .SH NAME
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
 .