qvm-create.rst 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .. program:: qvm-create
  2. :program:`qvm-create` -- create new domain
  3. ==========================================
  4. Synopsis
  5. --------
  6. :command:`qvm-create` [-h] [--verbose] [--quiet] [--force-root] [--class *CLS*] [--property *NAME*=*VALUE*] [--pool *POOL_NAME:VOLUME_NAME*] [--template *VALUE*] --label *VALUE* [--root-copy-from *FILENAME* | --root-move-from *FILENAME*] *VMNAME*
  7. :command:`qvm-create` --help-classes
  8. Options
  9. -------
  10. .. option:: --help, -h
  11. show help message and exit
  12. .. option:: --verbose, -v
  13. Increase verbosity.
  14. .. option:: --quiet, -q
  15. Decrease verbosity.
  16. .. option:: --help-classes
  17. List available qube classes and exit. See below for short description.
  18. .. option:: --class, -C
  19. The new domain class name (default: **AppVM** for
  20. :py:class:`qubes.vm.appvm.AppVM`).
  21. .. option:: --prop=NAME=VALUE, --property=NAME=VALUE
  22. Set domain's property, like "internal", "memory" or "vcpus". Any property may
  23. be set this way, even "qid".
  24. .. option:: --template=VALUE, -t VALUE
  25. Specify the TemplateVM to use, when applicable. This is an alias for
  26. ``--property template=VALUE``.
  27. .. option:: --label=VALUE, -l VALUE
  28. Specify the label to use for the new domain (e.g. red, yellow, green, ...).
  29. This in an alias for ``--property label=VALUE``.
  30. .. option:: --root-copy-from=FILENAME, -r FILENAME
  31. Use provided :file:`root.img` instead of default/empty one (file will be
  32. *copied*). This option is mutually exclusive with :option:`--root-move-from`.
  33. .. option:: --root-move-from=FILENAME, -R FILENAME
  34. Use provided :file:`root.img` instead of default/empty one (file will be
  35. *moved*). This option is mutually exclusive with :option:`--root-copy-from`.
  36. .. option:: -P POOL
  37. Pool to use for the new domain. All volumes besides snapshots volumes are
  38. imported in to the specified POOL. ~HIS IS WHAT YOU WANT TO USE NORMALLY.
  39. .. option:: --pool=POOL:VOLUME, -p POOL:VOLUME
  40. Specify the pool to use for the specific volume
  41. Qube classes
  42. ------------
  43. Qube class (or type) specify basic features of it, mostly what data persists
  44. across reboots and what properties qube have.
  45. AppVM
  46. ^^^^^
  47. Default qube class, for template-based qubes. In this type, root volume is used
  48. from its template and changes made to it are discarded at qube restart. Changes
  49. in qube's private volume are persistent.
  50. StandaloneVM
  51. ^^^^^^^^^^^^
  52. This qube class have both root and private volumes persistent. This qube type
  53. does not have template property.
  54. TemplateVM
  55. ^^^^^^^^^^
  56. A qube that can be used as a template for `AppVM`. Otherwise very similar to
  57. `StandaloneVM`.
  58. DispVM
  59. ^^^^^^
  60. A disposable qube - no data persists across qube restarts. It must have template
  61. set to an `AppVM` instance that have `dispvm_allowed` property set to true (see
  62. :manpage:`qvm-prefs(1)`).
  63. Authors
  64. -------
  65. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  66. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  67. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  68. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  69. | Bahtiar `kalkin-` Gadimov <bahtiar at gadimov dot de>
  70. .. vim: ts=3 sw=3 et tw=80