init.rst.inc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_init:
  3. borg init
  4. ---------
  5. ::
  6. usage: borg init [-h] [--critical] [--error] [--warning] [--info] [--debug]
  7. [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
  8. [--remote-path PATH] [-e {none,keyfile,repokey}] [-a]
  9. [REPOSITORY]
  10. Initialize an empty repository
  11. positional arguments:
  12. REPOSITORY repository to create
  13. optional arguments:
  14. -h, --help show this help message and exit
  15. --critical work on log level CRITICAL
  16. --error work on log level ERROR
  17. --warning work on log level WARNING (default)
  18. --info, -v, --verbose
  19. work on log level INFO
  20. --debug work on log level DEBUG
  21. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  22. --show-rc show/log the return code (rc)
  23. --no-files-cache do not load/update the file metadata cache used to
  24. detect unchanged files
  25. --umask M set umask to M (local and remote, default: 0077)
  26. --remote-path PATH use PATH as borg executable on the remote (default:
  27. "borg")
  28. -e {none,keyfile,repokey}, --encryption {none,keyfile,repokey}
  29. select encryption key mode (default: "repokey")
  30. -a, --append-only create an append-only mode repository
  31. Description
  32. ~~~~~~~~~~~
  33. This command initializes an empty repository. A repository is a filesystem
  34. directory containing the deduplicated data from zero or more archives.
  35. Encryption can be enabled at repository init time.