qvm-backup.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .. program:: qvm-backup
  2. :program:`qvm-backup` -- Create a backup of Qubes
  3. =================================================
  4. Synopsis
  5. --------
  6. :command:`qvm-backup` [-h] [--verbose] [--quiet] [--profile *PROFILE*] [--exclude EXCLUDE_LIST] [--dest-vm *APPVM*] [--encrypt] [--passphrase-file PASSPHRASE_FILE] [--compress] [--compress-filter *COMPRESSION*] [--save-profile SAVE_PROFILE] backup_location [vms [vms ...]]
  7. Options
  8. -------
  9. .. option:: --profile
  10. Specify backup profile to use. This option is mutually exclusive with all
  11. other options. This is also the only working mode when running from non-dom0.
  12. .. option:: --save-profile
  13. Save backup profile based on given options. This is possible only when
  14. running in dom0. Otherwise, prepared profile is printed on standard output
  15. and user needs to manually place it into /etc/qubes/backup in dom0.
  16. .. option:: --help, -h
  17. show help message and exit
  18. .. option:: --verbose, -v
  19. increase verbosity
  20. .. option:: --quiet, -q
  21. decrease verbosity
  22. .. option:: --exclude, -x
  23. Exclude the specified VM from the backup (may be repeated)
  24. .. option:: --dest-vm, -d
  25. Specify the destination VM to which the backup will be sent (implies -e)
  26. .. option:: --encrypt, -e
  27. Ignored, backup is always encrypted
  28. .. option:: --passphrase-file, -p
  29. Read passphrase from a file, or use '-' to read from stdin
  30. .. option:: --compress, -z
  31. Compress the backup. This is default.
  32. .. option:: --no-compress
  33. Do not compress the backup.
  34. .. option:: --compress-filter, -Z
  35. Specify a non-default compression filter program (default: gzip)
  36. .. option:: --yes, -y
  37. Do not ask for confirmation
  38. Arguments
  39. ---------
  40. The first positional parameter is the backup location (absolute directory path,
  41. or command to pipe backup to). After that you may specify the qubes you'd
  42. like to backup. If not specified, all qubes are included.
  43. Authors
  44. -------
  45. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  46. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  47. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  48. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  49. .. vim: ts=3 sw=3 et tw=80