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] ARCHIVE1 ARCHIVE2 [PATH...]

.. only:: html

    .. class:: borg-options-table

    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    | **positional arguments**                                                                                                                                              |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``ARCHIVE1``                          | ARCHIVE1 name                                                         |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``ARCHIVE2``                          | ARCHIVE2 name                                                         |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``PATH``                              | paths of items inside the archives to compare; patterns are supported |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    | **options**                                                                                                                                                           |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--numeric-ids``                     | only consider numeric user and group identifiers                      |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--same-chunker-params``             | Override check of chunker parameters.                                 |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--sort``                            | Sort the output lines by file path.                                   |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--json-lines``                      | Format output as JSON Lines.                                          |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    | .. class:: borg-common-opt-ref                                                                                                                                        |
    |                                                                                                                                                                       |
    | :ref:`common_options`                                                                                                                                                 |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    | **Exclusion options**                                                                                                                                                 |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN                                        |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--exclude-from EXCLUDEFILE``        | read exclude patterns from EXCLUDEFILE, one per line                  |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--pattern PATTERN``                 | include/exclude paths matching PATTERN                                |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
    |                                                       | ``--patterns-from PATTERNFILE``       | read include/exclude patterns from PATTERNFILE, one per line          |
    +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+

    .. raw:: html

        <script type='text/javascript'>
        $(document).ready(function () {
            $('.borg-options-table colgroup').remove();
        })
        </script>

.. only:: latex

    ARCHIVE1
        ARCHIVE1 name
    ARCHIVE2
        ARCHIVE2 name
    PATH
        paths of items inside the archives to compare; patterns are supported


    options
        --numeric-ids    only consider numeric user and group identifiers
        --same-chunker-params    Override check of chunker parameters.
        --sort     Sort the output lines by file path.
        --json-lines    Format output as JSON Lines. 


    :ref:`common_options`
        |

    Exclusion options
        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
        --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.

For more help on include/exclude patterns, see the :ref:`borg_patterns` command output.