Qubes/core-admin-client
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
8e7db06918
core-admin-client/doc/manpages/qubes-prefs.rst

102 lines
2.1 KiB
ReStructuredText
Raw Normal View History

doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. program:: qubes-prefs
:program:`qubes-prefs` -- List/set various global properties
============================================================
Synopsis
--------
tools: drop --delete and --unset aliases for --default option This may be confiusing, for example one may think that `qvm-prefs --unset vmname netvm` will make vmname network-disconnected. This type of mistakes may have severe security consequence, so better drop those option names. QubesOS/qubes-issues#3002 cc @rootkovska
2017-08-12 22:33:36 +02:00
:command:`qubes-prefs` [-h] [--verbose] [--quiet] [--force-root] [--help-properties] [*PROPERTY* [*VALUE*\|--default]]
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Options
-------
.. option:: --help, -h
Show help message and exit.
.. option:: --help-properties
List available properties with short descriptions and exit.
qvm-prefs: add --hide-default option
2019-05-29 20:32:13 +02:00
.. option:: --hide-default
Do not show properties that are set to the default value.
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --verbose, -v
Increase verbosity.
.. option:: --quiet, -q
Decrease verbosity.
tools: drop --delete and --unset aliases for --default option This may be confiusing, for example one may think that `qvm-prefs --unset vmname netvm` will make vmname network-disconnected. This type of mistakes may have severe security consequence, so better drop those option names. QubesOS/qubes-issues#3002 cc @rootkovska
2017-08-12 22:33:36 +02:00
.. option:: --default, -D
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
tools: drop --delete and --unset aliases for --default option This may be confiusing, for example one may think that `qvm-prefs --unset vmname netvm` will make vmname network-disconnected. This type of mistakes may have severe security consequence, so better drop those option names. QubesOS/qubes-issues#3002 cc @rootkovska
2017-08-12 22:33:36 +02:00
Reset propety to default value.
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --get, -g
Ignored; for compatibility with older scripts.
.. option:: --set, -s
Ignored; for compatibility with older scripts.
Common properties
=================
This list is non-exhaustive. For authoritative listing, see
:option:`--help-properties` and documentation of the source code.
doc: update list of properties in qvm-prefs/qubes-prefs man pages Fixes QubesOS/qubes-issues#3011
2017-08-12 22:37:59 +02:00
clockvm
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
doc: update list of properties in qvm-prefs/qubes-prefs man pages Fixes QubesOS/qubes-issues#3011
2017-08-12 22:37:59 +02:00
Qube used as a time source for dom0
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
doc: update list of properties in qvm-prefs/qubes-prefs man pages Fixes QubesOS/qubes-issues#3011
2017-08-12 22:37:59 +02:00
default_template
Default template for newly created qubes
default_fw_netvm
Default netvm for qubes providing network (with `provides_network` property
set to `True`).
default_netvm
Default netvm for qubes not providing network
default_kernel
Default value for `kernel` property, see :manpage:`qvm-prefs(1)` for
details.
default_pool
Default storage pool for new qubes.
default_pool_kernel, default_pool_private, default_pool_root, default_pool_volatile
Default storage pool for particular volume for new qubes. Defaults to value
of `default_pool`.
stats_interval
Interval (in seconds) at which VM statistics are sent. This is for example
used by domains widget - this often memory usage will be refreshed.
updatevm
Qube used to download dom0 updates
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Authors
-------
| Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
| Marek Marczykowski <marmarek at invisiblethingslab dot com>
| Wojtek Porczyk <woju at invisiblethingslab dot com>
.. vim: ts=3 sw=3 et tw=80
Reference in New Issue Copy Permalink