borg/docs/usage/debug-get-obj.rst.inc

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

.. _borg_debug-get-obj:

borg debug-get-obj
------------------
::

    borg debug-get-obj <options> REPOSITORY ID PATH

positional arguments
    REPOSITORY
        repository to use
    ID
        hex object ID to get from the repo
    PATH
        file to write object data into

`Common options`_
    |

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

This command gets an object from the repository.
update usage files 2016-07-05 21:30:08 +00:00			`.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!`

commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384 2015-11-13 15:42:16 +00:00			`.. _borg_debug-get-obj:`

			`borg debug-get-obj`
			`------------------`
			`::`

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			`borg debug-get-obj <options> REPOSITORY ID PATH`

			`positional arguments`
			`REPOSITORY`
			`repository to use`
			`ID`
			`hex object ID to get from the repo`
			`PATH`
			`file to write object data into`

			`Common options`_
			`\|`

commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384 2015-11-13 15:42:16 +00:00			`Description`
			`~~~~~~~~~~~`

			`This command gets an object from the repository.`