Browse Source

build_usage

Thomas Waldmann 4 years ago
parent
commit
fcf62872fb

+ 6 - 0
docs/usage/create.rst.inc

@@ -79,6 +79,10 @@ borg create
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--nobsdflags``                                  | do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive                                                                                 |
     |                                                       | ``--nobsdflags``                                  | do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive                                                                                 |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noacls``                                      | do not read and store ACLs into archive                                                                                                              |
+    +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noxattrs``                                    | do not read and store xattrs into archive                                                                                                            |
+    +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--ignore-inode``                                | ignore inode data in the file metadata cache used to detect unchanged files.                                                                         |
     |                                                       | ``--ignore-inode``                                | ignore inode data in the file metadata cache used to detect unchanged files.                                                                         |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--files-cache MODE``                            | operate files cache in MODE. default: ctime,size,inode                                                                                               |
     |                                                       | ``--files-cache MODE``                            | operate files cache in MODE. default: ctime,size,inode                                                                                               |
@@ -149,6 +153,8 @@ borg create
         --noctime                 do not store ctime into archive
         --noctime                 do not store ctime into archive
         --nobirthtime             do not store birthtime (creation date) into archive
         --nobirthtime             do not store birthtime (creation date) into archive
         --nobsdflags              do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive
         --nobsdflags              do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive
+        --noacls                  do not read and store ACLs into archive
+        --noxattrs                do not read and store xattrs into archive
         --ignore-inode            ignore inode data in the file metadata cache used to detect unchanged files.
         --ignore-inode            ignore inode data in the file metadata cache used to detect unchanged files.
         --files-cache MODE        operate files cache in MODE. default: ctime,size,inode
         --files-cache MODE        operate files cache in MODE. default: ctime,size,inode
         --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.
         --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.

+ 3 - 0
docs/usage/diff.rst.inc

@@ -29,6 +29,8 @@ borg diff
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     |                                                       | ``--sort``                            | Sort the output lines by file path.                                        |
     |                                                       | ``--sort``                            | Sort the output lines by file path.                                        |
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
+    |                                                       | ``--json-lines``                      | Format output as JSON Lines.                                               |
+    +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     | .. class:: borg-common-opt-ref                                                                                                                                             |
     | .. class:: borg-common-opt-ref                                                                                                                                             |
     |                                                                                                                                                                            |
     |                                                                                                                                                                            |
     | :ref:`common_options`                                                                                                                                                      |
     | :ref:`common_options`                                                                                                                                                      |
@@ -66,6 +68,7 @@ borg diff
         --numeric-owner    only consider numeric user and group identifiers
         --numeric-owner    only consider numeric user and group identifiers
         --same-chunker-params    Override check of chunker parameters.
         --same-chunker-params    Override check of chunker parameters.
         --sort     Sort the output lines by file path.
         --sort     Sort the output lines by file path.
+        --json-lines    Format output as JSON Lines. 
 
 
 
 
     :ref:`common_options`
     :ref:`common_options`

+ 6 - 0
docs/usage/extract.rst.inc

@@ -29,6 +29,10 @@ borg extract
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``--nobsdflags``                      | do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)                                                      |
     |                                                       | ``--nobsdflags``                      | do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)                                                      |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noacls``                          | do not extract/set ACLs                                                                                   |
+    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noxattrs``                        | do not extract/set xattrs                                                                                 |
+    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``--stdout``                          | write all extracted data to stdout                                                                        |
     |                                                       | ``--stdout``                          | write all extracted data to stdout                                                                        |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``--sparse``                          | create holes in output sparse file from all-zero chunks                                                   |
     |                                                       | ``--sparse``                          | create holes in output sparse file from all-zero chunks                                                   |
@@ -71,6 +75,8 @@ borg extract
         -n, --dry-run     do not actually change any files
         -n, --dry-run     do not actually change any files
         --numeric-owner    only obey numeric user and group identifiers
         --numeric-owner    only obey numeric user and group identifiers
         --nobsdflags      do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)
         --nobsdflags      do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)
+        --noacls          do not extract/set ACLs
+        --noxattrs        do not extract/set xattrs
         --stdout          write all extracted data to stdout
         --stdout          write all extracted data to stdout
         --sparse          create holes in output sparse file from all-zero chunks
         --sparse          create holes in output sparse file from all-zero chunks
 
 

+ 2 - 2
docs/usage/help.rst.inc

@@ -95,14 +95,14 @@ Path full-match, selector `pf:`
     wildcards at most.
     wildcards at most.
 
 
 Exclusions can be passed via the command line option ``--exclude``. When used
 Exclusions can be passed via the command line option ``--exclude``. 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.
 
 
 The ``--exclude-from`` option permits loading exclusion patterns from a text
 The ``--exclude-from`` 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
 ('#') after removing whitespace on both ends are ignored. The optional style
 ('#') 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.
 
 
 To test your exclusion patterns without performing an actual backup you can
 To test your exclusion patterns without performing an actual backup you can

+ 8 - 0
docs/usage/list.rst.inc

@@ -161,12 +161,20 @@ Keys for listing archive files:
 - isoctime
 - isoctime
 - isoatime
 - isoatime
 
 
+- blake2b
+- blake2s
 - md5
 - md5
 - sha1
 - sha1
 - sha224
 - sha224
 - sha256
 - sha256
 - sha384
 - sha384
+- sha3_224
+- sha3_256
+- sha3_384
+- sha3_512
 - sha512
 - sha512
+- shake_128
+- shake_256
 
 
 - archiveid
 - archiveid
 - archivename
 - archivename