key_import.rst.inc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_key_import:
  3. borg key import
  4. ---------------
  5. ::
  6. usage: borg key import [-h] [--critical] [--error] [--warning] [--info]
  7. [--debug] [--lock-wait N] [--show-rc]
  8. [--no-files-cache] [--umask M] [--remote-path PATH]
  9. [--paper]
  10. [REPOSITORY] [PATH]
  11. Import the repository key from backup
  12. positional arguments:
  13. REPOSITORY
  14. PATH path to the backup
  15. optional arguments:
  16. -h, --help show this help message and exit
  17. --critical work on log level CRITICAL
  18. --error work on log level ERROR
  19. --warning work on log level WARNING (default)
  20. --info, -v, --verbose
  21. work on log level INFO
  22. --debug work on log level DEBUG
  23. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  24. --show-rc show/log the return code (rc)
  25. --no-files-cache do not load/update the file metadata cache used to
  26. detect unchanged files
  27. --umask M set umask to M (local and remote, default: 0077)
  28. --remote-path PATH use PATH as borg executable on the remote (default:
  29. "borg")
  30. --paper interactively import from a backup done with --paper
  31. Description
  32. ~~~~~~~~~~~
  33. This command allows to restore a key previously backed up with the
  34. export command.
  35. If the ``--paper`` option is given, the import will be an interactive
  36. process in which each line is checked for plausibility before
  37. proceeding to the next line. For this format PATH must not be given.