[PATCH] docs: bhyve: document sound device and VNC bits

Roman Bogorodskiy bogorodskiy at gmail.com
Thu Sep 24 16:18:28 UTC 2020

 * Document sound device support,
 * Document VNC password configuration and framebuffer resolution.

Signed-off-by: Roman Bogorodskiy <bogorodskiy at gmail.com>
 docs/drvbhyve.html.in | 47 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index ca511eeccd..cffb63f1ad 100644
--- a/docs/drvbhyve.html.in
+++ b/docs/drvbhyve.html.in
@@ -389,6 +389,30 @@ it with the <code>port</code> attribute):</p>
     <graphics type='vnc' autoport='yes'>
+<p><span class="since">Since 6.8.0</span>, it's possible to set framebuffer resolution
+using the <code>resolution</code> sub-element:</p>
+   <video>
+     <model type='gop' heads='1' primary='yes'>
+       <resolution x='800' y='600'/>
+     </model>
+   </video>
+<p><span class="since">Since 6.8.0</span>, VNC server can be configured to use
+password based authentication:</p>
+  <graphics type='vnc' port='5904' passwd='foobar'>
+    <listen type='address' address=''/>
+  </graphics>
+<p>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.</p>
 <h3><a id="clockconfig">Clock configuration</a></h3>
 <p>Originally bhyve supported only localtime for RTC. Support for UTC time was introduced in
@@ -432,6 +456,29 @@ supports Intel e1000 network adapter emulation. It's supported in libvirt
+<h3><a id="sound">Sound device</a></h3>
+<p>As of <a href="https://svnweb.freebsd.org/changeset/base/349355">r349355</a> bhyve
+supports sound device emulation. It's supported in libvirt
+<span class="since">since 6.7.0</span>.</p>
+  <sound model='ich7'>
+    <audio id='1'/>
+  </sound>
+  <audio id='1' type='oss'>
+    <input dev='/dev/dsp0'/>
+    <output dev='/dev/dsp0'/>
+  </audio>
+<p>Here, the <code>sound</code> element specifies the sound device as it's exposed
+to the guest, with <code>ich7</code> being the only supported model now,
+and the <code>audio</code> element specifies how the guest device is mapped
+to the host sound device.</p>
 <h3><a id="wired">Wiring guest memory</a></h3>
 <p><span class="since">Since 4.4.0</span>, it's possible to specify that guest memory should

More information about the libvir-list mailing list