]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: bhyve: document VNC's wait attribute
authorRoman Bogorodskiy <bogorodskiy@gmail.com>
Fri, 21 Nov 2025 17:21:44 +0000 (18:21 +0100)
committerRoman Bogorodskiy <bogorodskiy@gmail.com>
Mon, 24 Nov 2025 17:01:38 +0000 (18:01 +0100)
Document the new VNC's 'wait' attribute in formatdomain.rst and
drvbhyve.rst.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
docs/drvbhyve.rst
docs/formatdomain.rst

index 73372ff7cf7d825d1f938b2cd8907d81a19eb370..c0f4cd8a1fb3925ad4581ba530287b7b8a827aa3 100644 (file)
@@ -429,6 +429,16 @@ Note: VNC password authentication is known to be cryptographically weak.
 Additionally, the password is passed as a command line argument in clear text.
 Make sure you understand the risks associated with this feature before using it.
 
+:since:`Since 11.10.0`, the guest can be configured to wait for an incoming
+VNC connection before booting:
+
+::
+
+    <graphics type='vnc' port='5904' wait='yes'>
+      <listen type='address' address='127.0.0.1'/>
+    </graphics>
+
+
 Clock configuration
 ~~~~~~~~~~~~~~~~~~~
 
index eb1536df7b0a31ac9f6585e9cd638e3e89a59f8c..1467fc7e10f459f1ad7ff7eeb97d077349bdb7ec 100644 (file)
@@ -6907,6 +6907,10 @@ interaction with the admin.
       ID is specified, then the default audio backend will be used.
       :since:`Since 7.2.0, qemu`.
 
+      The optional ``wait`` attribute, when set to ``yes``, causes the guest
+      to wait for an incoming VNC connection before booting.
+      :since:`Since 11.10.0, bhyve`.
+
    ``spice`` :since:`Since 0.8.6`
       Starts a SPICE server. The ``port`` attribute specifies the TCP port
       number (with -1 as legacy syntax indicating that it should be