borg/docs/usage/serve.rst.inc

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

.. _borg_serve:

borg serve
----------
::

    borg [common options] serve <options>

optional arguments
    ``--restrict-to-path PATH``
        | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
    ``--append-only``
        | only allow appending to repository segment files
    ``--storage-quota``
        | Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.

`Common options`_
    |

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

This command starts a repository server process. This command is usually not used manually.
update usage files 2016-07-05 23:30:08 +02: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 10:42:16 -05:00			`.. _borg_serve:`

			`borg serve`
			`----------`
			`::`

docs: ran build_man, build_usage 2017-05-17 11:52:48 +02:00			`borg [common options] serve <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-10 01:28:18 +02:00
			`optional arguments`
			``--restrict-to-path PATH``
run setup.py build_usage 2016-12-14 03:42:38 +01:00			`\| restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.`
Merge branch '1.0-maint' 2016-07-06 01:33:53 +02:00			``--append-only``
			`\| only allow appending to repository segment files`
Implement storage quotas 2017-05-25 00:59:39 +02:00			``--storage-quota``
			`\| Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.`
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-10 01:28:18 +02:00
			`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 10:42:16 -05:00			`Description`
			`~~~~~~~~~~~`

ran setup.py build_usage 2017-03-27 01:45:45 +02:00			`This command starts a repository server process. This command is usually not used manually.`