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
----------
.. code-block:: none

    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.
    ``--restrict-to-repository PATH``
        | restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
    ``--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.

:ref:`common_options`
    |

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

This command starts a repository server process. This command is usually not used manually.
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_serve:`

			`borg serve`
			`----------`
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`.. code-block:: none`
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
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00: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-09 23:28:18 +00:00
			`optional arguments`
			``--restrict-to-path PATH``
run setup.py build_usage 2016-12-14 02:42:38 +00: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.`
docs: split usage 2017-06-06 22:06:36 +00:00			``--restrict-to-repository PATH``
			`\| restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.`
Merge branch '1.0-maint' 2016-07-05 23:33:53 +00:00			``--append-only``
			`\| only allow appending to repository segment files`
Implement storage quotas 2017-05-24 22:59:39 +00: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-09 23:28:18 +00:00
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			`\|`

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`
			`~~~~~~~~~~~`

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