borg/docs/usage/diff.rst.inc

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!

.. _borg_diff:

borg diff
---------
.. code-block:: none

    borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 PATH

positional arguments
    REPO_ARCHIVE1
        repository location and ARCHIVE1 name
    ARCHIVE2
        ARCHIVE2 name (no repository location allowed)
    PATH
        paths of items inside the archives to compare; patterns are supported

optional arguments
    ``--numeric-owner``
        | only consider numeric user and group identifiers
    ``--same-chunker-params``
        | Override check of chunker parameters.
    ``--sort``
        | Sort the output lines by file path.

:ref:`common_options`
    |

Exclusion options
    ``-e PATTERN``, ``--exclude PATTERN``
        | exclude paths matching PATTERN
    ``--exclude-from EXCLUDEFILE``
        | read exclude patterns from EXCLUDEFILE, one per line
    ``--exclude-caches``
        | exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
    ``--exclude-if-present NAME``
        | exclude directories that are tagged by containing a filesystem object with the given NAME
    ``--keep-exclude-tags``, ``--keep-tag-files``
        | if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
    ``--pattern PATTERN``
        | include/exclude paths matching PATTERN
    ``--patterns-from PATTERNFILE``
        | read include/exclude patterns from PATTERNFILE, one per line

Description
~~~~~~~~~~~

This command finds differences (file contents, user/group/mode) between archives.

A repository location and an archive name must be specified for REPO_ARCHIVE1.
ARCHIVE2 is just another archive name in same repository (no repository location
allowed).

For archives created with Borg 1.1 or newer diff automatically detects whether
the archives are created with the same chunker params. If so, only chunk IDs
are compared, which is very fast.

For archives prior to Borg 1.1 chunk contents are compared by default.
If you did not create the archives with different chunker params,
pass --same-chunker-params.
Note that the chunker params changed from Borg 0.xx to 1.0.

See the output of the "borg help patterns" command for more help on exclude patterns.
Merge branch '1.0-maint' 2016-07-05 23:33:53 +00:00			`.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!`

add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00			`.. _borg_diff:`

			`borg diff`
			`---------`
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`.. code-block:: none`
add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 PATH`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00
			`positional arguments`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00			`REPO_ARCHIVE1`
			`repository location and ARCHIVE1 name`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00			`ARCHIVE2`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00			`ARCHIVE2 name (no repository location allowed)`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00			`PATH`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00			`paths of items inside the archives to compare; patterns are supported`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00
			`optional arguments`
			``--numeric-owner``
			`\| only consider numeric user and group identifiers`
			``--same-chunker-params``
			`\| Override check of chunker parameters.`
			``--sort``
			`\| Sort the output lines by file path.`

docs: split usage 2017-06-06 22:06:36 +00:00			:ref:`common_options`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00			`\|`

ran setup.py build_usage 2017-03-26 23:45:45 +00:00			`Exclusion options`
			``-e PATTERN``, ``--exclude PATTERN``
			`\| exclude paths matching PATTERN`
			``--exclude-from EXCLUDEFILE``
			`\| read exclude patterns from EXCLUDEFILE, one per line`
			``--exclude-caches``
			`\| exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)`
			``--exclude-if-present NAME``
			`\| exclude directories that are tagged by containing a filesystem object with the given NAME`
			``--keep-exclude-tags``, ``--keep-tag-files``
			`\| if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive`
			``--pattern PATTERN``
			`\| include/exclude paths matching PATTERN`
			``--patterns-from PATTERNFILE``
			`\| read include/exclude patterns from PATTERNFILE, one per line`

add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00			`Description`
			`~~~~~~~~~~~`

ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00			`This command finds differences (file contents, user/group/mode) between archives.`
add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00			`A repository location and an archive name must be specified for REPO_ARCHIVE1.`
			`ARCHIVE2 is just another archive name in same repository (no repository location`
			`allowed).`
add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00
borg diff help: clarify: for new archives different chunker params still require content compare 2016-03-18 14:42:32 +00:00			`For archives created with Borg 1.1 or newer diff automatically detects whether`
			`the archives are created with the same chunker params. If so, only chunk IDs`
Update borg diff help message regarding --same-chunker-params 2016-03-18 12:30:39 +00:00			`are compared, which is very fast.`

			`For archives prior to Borg 1.1 chunk contents are compared by default.`
			`If you did not create the archives with different chunker params,`
			`pass --same-chunker-params.`
			`Note that the chunker params changed from Borg 0.xx to 1.0.`
Update usage docs 2016-03-18 11:17:57 +00:00
ran setup.py build_usage 2017-03-26 23:45:45 +00:00			`See the output of the "borg help patterns" command for more help on exclude patterns.`