summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorCole Robinson <crobinso@redhat.com>2020-09-14 19:05:58 -0400
committerCole Robinson <crobinso@redhat.com>2020-09-14 20:15:20 -0400
commit17f47a44c5514dd43136d6cbaccbebc1643f84c5 (patch)
tree724f6707175c1ad478138da0557bde79bc6b4509 /man
parent67703ec7a51d5de15b9d6b5002d695d72d6cd565 (diff)
downloadvirt-manager-17f47a44c5514dd43136d6cbaccbebc1643f84c5.tar.gz
cli: --os-variant: add explicit suboptions
This adds the following --os-variant suboptions * name=, short-id= * id= * detect=on|off Functionally this does not change behavior, just adds explicit sub options for behavior we already support Signed-off-by: Cole Robinson <crobinso@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/virt-install.rst25
-rw-r--r--man/virt-xml.rst2
2 files changed, 21 insertions, 6 deletions
diff --git a/man/virt-install.rst b/man/virt-install.rst
index f2741f65..9cc43360 100644
--- a/man/virt-install.rst
+++ b/man/virt-install.rst
@@ -969,20 +969,33 @@ GUEST OS OPTIONS
``--os-variant``, ``--osinfo``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**Syntax:** ``--os-variant`` OS_VARIANT
+**Syntax:** ``--os-variant`` [OS_VARIANT|OPT1=VAL1,...]
Optimize the guest configuration for a specific operating system (ex.
'fedora29', 'rhel7', 'win10'). While not required, specifying this
options is HIGHLY RECOMMENDED, as it can greatly increase performance
by specifying virtio among other guest tweaks.
-By default, virt-install will attempt to auto detect this value from
-the install media (currently only supported for URL installs). Autodetection
-can be disabled with the special value 'none'. Autodetection can be
-forced with the special value 'auto'.
+The simplest usage is ``--os-variant OS-NAME``, for example
+``--os-variant fedora32``. ``--os-variant`` supports explicit suboption
+syntax as well:
+
+``name=``, ``short-id=``
+ The OS name/short-id from libosinfo. Examples: ``fedora32``, ``win10``
+
+``id=``
+ The full URL style libosinfo ID. For example, ``name=win10`` is
+ the same as ``id=http://microsoft.com/win/10``
+
+``detect=on|off``
+ Whether virt-install should attempt OS detection from the specified
+ install media. Detection is presently only attempted for URL and
+ CDROM installs, and is not 100% reliable.
+
+By default, virt-install will use ``--os-variant detect=on``.
Use the command "osinfo-query os" to get the list of the accepted OS
-variants.
+variant names.
diff --git a/man/virt-xml.rst b/man/virt-xml.rst
index bb521cd4..7ff7ceca 100644
--- a/man/virt-xml.rst
+++ b/man/virt-xml.rst
@@ -194,6 +194,8 @@ GUEST OS OPTIONS
Use the command "osinfo-query os" to get the list of the accepted OS
variants.
+ See virt-install(1) documentation for more details about ``--os-variant``
+
XML OPTIONS
===========