qvm-features.rst 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. program:: qvm-features
  2. :program:`qvm-features` -- manage domain's features
  3. ===================================================
  4. Synopsis
  5. --------
  6. :command:`qvm-features` [-h] [--verbose] [--quiet] *VMNAME* [*FEATURE* [*VALUE*]]
  7. Options
  8. -------
  9. .. option:: --help, -h
  10. show this help message and exit
  11. .. option:: --verbose, -v
  12. increase verbosity
  13. .. option:: --quiet, -q
  14. decrease verbosity
  15. .. option:: --unset, --default, --delete, -D
  16. Unset the feature.
  17. Description
  18. -----------
  19. This command is used to manually manage the *features* of the domain. The
  20. features are key-value pairs with both key and value being strings. They are
  21. used by extensions to store information about the domain and make policy
  22. decisions based on them. For example, they may indicate that some specific
  23. software package was installed inside the template and the domains based on it
  24. have some specific capability.
  25. .. warning::
  26. The features are normally managed by the extensions themselves and you should
  27. not change them directly. Strange things might happen otherwise.
  28. Some extensions interpret the values as boolean. In this case, the empty string
  29. means :py:obj:`False` and non-empty string (commonly ``'1'``) means
  30. :py:obj:`True`. An absence of the feature means "default", which is
  31. extension-dependent.
  32. Authors
  33. -------
  34. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  35. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  36. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  37. .. vim: ts=3 sw=3 et tw=80