qvm-backup.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. .. program:: qvm-backup
  2. :program:`qvm-backup` -- Create a backup of Qubes
  3. =================================================
  4. .. warning::
  5. This page was autogenerated from command-line parser. It shouldn't be 1:1
  6. conversion, because it would add little value. Please revise it and add
  7. more descriptive help, which normally won't fit in standard ``--help``
  8. option.
  9. After rewrite, please remove this admonition.
  10. Synopsis
  11. --------
  12. :command:`qvm-backup` [-h] [--verbose] [--quiet] [--force-root] [--exclude EXCLUDE_LIST] [--dest-vm *APPVM*] [--encrypt] [--no-encrypt] [--passphrase-file PASS_FILE] [--enc-algo CRYPTO_ALGORITHM] [--hmac-algo HMAC_ALGORITHM] [--compress] [--compress-filter COMPRESS_FILTER] [--tmpdir *TMPDIR*] backup_location [vms [vms ...]]
  13. Options
  14. -------
  15. .. option:: --help, -h
  16. show this help message and exit
  17. .. option:: --verbose, -v
  18. increase verbosity
  19. .. option:: --quiet, -q
  20. decrease verbosity
  21. .. option:: --force-root
  22. force to run as root
  23. .. option:: --exclude, -x
  24. Exclude the specified VM from the backup (may be repeated)
  25. .. option:: --dest-vm, -d
  26. Specify the destination VM to which the backup will be sent (implies -e)
  27. .. option:: --encrypt, -e
  28. Encrypt the backup
  29. .. option:: --no-encrypt
  30. Skip encryption even if sending the backup to a VM
  31. .. option:: --passphrase-file, -p
  32. Read passphrase from a file, or use '-' to read from stdin
  33. .. option:: --enc-algo, -E
  34. Specify a non-default encryption algorithm. For a list of supported algorithms, execute 'openssl list-cipher-algorithms' (implies -e)
  35. .. option:: --hmac-algo, -H
  36. Specify a non-default HMAC algorithm. For a list of supported algorithms, execute 'openssl list-message-digest-algorithms'
  37. .. option:: --compress, -z
  38. Compress the backup
  39. .. option:: --compress-filter, -Z
  40. Specify a non-default compression filter program (default: gzip)
  41. .. option:: --tmpdir
  42. Specify a temporary directory (if you have at least 1GB free RAM in dom0, use of /tmp is advised) (default: /var/tmp)
  43. Arguments
  44. ---------
  45. The first positional parameter is the backup location (directory path, or
  46. command to pipe backup to). After that you may specify the qubes you'd like to
  47. backup. If not specified, all qubes with `include_in_backups` property set are
  48. included.
  49. Authors
  50. -------
  51. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  52. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  53. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  54. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  55. .. vim: ts=3 sw=3 et tw=80