serve.rst.inc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_serve:
  3. borg serve
  4. ----------
  5. ::
  6. usage: borg serve [-h] [--critical] [--error] [--warning] [--info] [--debug]
  7. [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
  8. [--remote-path PATH] [--restrict-to-path PATH]
  9. [--append-only]
  10. Start in server mode. This command is usually not used manually.
  11. optional arguments:
  12. -h, --help show this help message and exit
  13. --critical work on log level CRITICAL
  14. --error work on log level ERROR
  15. --warning work on log level WARNING (default)
  16. --info, -v, --verbose
  17. work on log level INFO
  18. --debug work on log level DEBUG
  19. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  20. --show-rc show/log the return code (rc)
  21. --no-files-cache do not load/update the file metadata cache used to
  22. detect unchanged files
  23. --umask M set umask to M (local and remote, default: 0077)
  24. --remote-path PATH use PATH as borg executable on the remote (default:
  25. "borg")
  26. --restrict-to-path PATH
  27. restrict repository access to PATH. Can be specified
  28. multiple times to allow the client access to several
  29. directories. Access to all sub-directories is granted
  30. implicitly; PATH doesn't need to directly point to a
  31. repository.
  32. --append-only only allow appending to repository segment files
  33. Description
  34. ~~~~~~~~~~~
  35. This command starts a repository server process. This command is usually not used manually.