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
----------
::

    usage: borg serve [-h] [--critical] [--error] [--warning] [--info] [--debug]
                      [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
                      [--remote-path PATH] [--restrict-to-path PATH]
                      [--append-only]
    
    Start in server mode. This command is usually not used manually.
            
    
    optional arguments:
      -h, --help            show this help message and exit
      --critical            work on log level CRITICAL
      --error               work on log level ERROR
      --warning             work on log level WARNING (default)
      --info, -v, --verbose
                            work on log level INFO
      --debug               work on log level DEBUG
      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
      --show-rc             show/log the return code (rc)
      --no-files-cache      do not load/update the file metadata cache used to
                            detect unchanged files
      --umask M             set umask to M (local and remote, default: 0077)
      --remote-path PATH    set remote path to executable (default: "borg")
      --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
    
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`
			`----------`
			`::`

ran build_api build_usage 2016-04-08 21:38:46 +00:00			`usage: borg serve [-h] [--critical] [--error] [--warning] [--info] [--debug]`
			`[--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]`
			`[--remote-path PATH] [--restrict-to-path PATH]`
Documentation: Explicate that Fnmatch is default This fixes #1247. It also regenerates the usage documentation, so that styling fixex in that section (as well as other existing changes) make it into the files in docs/. 2016-07-03 14:27:02 +00:00			`[--append-only]`
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
			`Start in server mode. This command is usually not used manually.`


			`optional arguments:`
			`-h, --help show this help message and exit`
ran build_api build_usage 2016-04-08 21:38:46 +00:00			`--critical work on log level CRITICAL`
			`--error work on log level ERROR`
			`--warning work on log level WARNING (default)`
			`--info, -v, --verbose`
			`work on log level INFO`
			`--debug work on log level DEBUG`
ran build_usage 2015-12-08 09:21:20 +00:00			`--lock-wait N wait for the lock, but max. N seconds (default: 1).`
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			`--show-rc show/log the return code (rc)`
			`--no-files-cache do not load/update the file metadata cache used to`
			`detect unchanged files`
ran build_usage 2015-12-08 09:21:20 +00:00			`--umask M set umask to M (local and remote, default: 0077)`
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			`--remote-path PATH set remote path to executable (default: "borg")`
			`--restrict-to-path PATH`
ran build_usage 2016-10-17 01:39: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.`
Documentation: Explicate that Fnmatch is default This fixes #1247. It also regenerates the usage documentation, so that styling fixex in that section (as well as other existing changes) make it into the files in docs/. 2016-07-03 14:27:02 +00:00			`--append-only only allow appending to repository segment files`
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 starts a repository server process. This command is usually not used manually.`