change-passphrase.rst.inc 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_change-passphrase:
  3. borg change-passphrase
  4. ----------------------
  5. ::
  6. usage: borg change-passphrase [-h] [--critical] [--error] [--warning] [--info]
  7. [--debug] [--lock-wait N] [--show-rc]
  8. [--no-files-cache] [--umask M]
  9. [--remote-path PATH]
  10. [REPOSITORY]
  11. Change repository key file passphrase
  12. positional arguments:
  13. REPOSITORY
  14. optional arguments:
  15. -h, --help show this help message and exit
  16. --critical work on log level CRITICAL
  17. --error work on log level ERROR
  18. --warning work on log level WARNING (default)
  19. --info, -v, --verbose
  20. work on log level INFO
  21. --debug work on log level DEBUG
  22. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  23. --show-rc show/log the return code (rc)
  24. --no-files-cache do not load/update the file metadata cache used to
  25. detect unchanged files
  26. --umask M set umask to M (local and remote, default: 0077)
  27. --remote-path PATH use PATH as borg executable on the remote (default:
  28. "borg")
  29. Description
  30. ~~~~~~~~~~~
  31. The key files used for repository encryption are optionally passphrase
  32. protected. This command can be used to change this passphrase.
  33. Please note that this command only changes the passphrase, but not any
  34. secret protected by it (like e.g. encryption/MAC keys or chunker seed).
  35. Thus, changing the passphrase after passphrase and borg key got compromised
  36. does not protect future (nor past) backups to the same repository.