On Mon, Sep 21, 2009 at 03:31:44PM +0200, Florian Vichot wrote:

Hello

The title says it all. Here's some doc explaining the new syntax of the video and graphic elements in the domain XML. It (probably) won't get me any literary awards but, eh, it's a start :)

Florian

diff --git a/docs/formatdomain.html b/docs/formatdomain.html index a715457..f95f72b 100644 --- a/docs/formatdomain.html +++ b/docs/formatdomain.html @@ -175,6 +175,8 @@ </li><li> <a href="#elementsGraphics">Graphical framebuffers</a> </li><li> + <a href="#elementsVideo">Video devices</a> + </li><li> <a href="#elementsConsole">Consoles, serial & parallel devices</a> <ul><li> <a href="#elementsCharSTDIO">Domain logfile</a> @@ -758,23 +760,65 @@ qemu-kvm -net nic,model=? /dev/null </p> <pre> ... + <graphics type='sdl' display=':0.0'/> <graphics type='vnc' port='5904'/> + <graphics type='rdp' autoport='yes' multiUser='yes' /> + <graphics type='desktop' fullscreen='yes'/> ...</pre> <dl><dt><code>graphics</code></dt><dd>The <code>graphics</code> element has a mandatory <code>type</code> - attribute which takes the value "sdl" or "vnc". The former displays - a window on the host desktop, while the latter activates a VNC server. - The former accepts 3 optional arguments: a <code>display</code> - attribute for the display to use, an <code>xauth</code> attribute for - the authentication identifier, and an optional <code>fullscreen</code> - attribute accepting values 'yes' or 'no'. - If the latter is used the <code>port</code> attribute specifies the TCP - port number (with -1 as legacy syntax indicating that it should be - auto-allocated). The <code>autoport</code> attribute is the new - preferred syntax for indicating autoallocation of the TCP port to use. - The <code>listen</code> attribute is an IP address for the server to - listen on. The <code>passwd</code> attribute provides a VNC password - in clear text. The <code>keymap</code> attribute specifies the keymap - to use.</dd></dl> + attribute which takes the value "sdl", "vnc", "rdp" or "desktop": + <dl><dt><code>"sdl"</code></dt><dd> + This displays a window on the host desktop, it can take 3 optional arguments: + a <code>display</code> attribute for the display to use, an <code>xauth</code> + attribute for the authentication identifier, and an optional <code>fullscreen</code> + attribute accepting values 'yes' or 'no'. + </dd><dt><code>"vnc"</code></dt><dd> + Starts a VNC server. The <code>port</code> attribute specifies the TCP + port number (with -1 as legacy syntax indicating that it should be + auto-allocated). The <code>autoport</code> attribute is the new + preferred syntax for indicating autoallocation of the TCP port to use. + The <code>listen</code> attribute is an IP address for the server to + listen on. The <code>passwd</code> attribute provides a VNC password + in clear text. The <code>keymap</code> attribute specifies the keymap + to use. + </dd><dt><code>"rdp"</code></dt><dd> + Starts a RDP server. The <code>port</code> attribute + specifies the TCP port number (with -1 as legacy syntax indicating + that it should be auto-allocated). The <code>autoport</code> attribute + is the new preferred syntax for indicating autoallocation of the TCP + port to use. The <code>replaceUser</code> attribute is a boolean deciding + whether multiple simultaneous connections to the VM are permitted. + The <code>multiUser</code> whether the existing connection must be dropped + and a new connection must be established by the VRDP server, when a new + client connects in single connection mode. + + </dd><dt><code>"desktop"</code></dt><dd> + This value is reserved for VirtualBox domains for the moment. It displays + a window on the host desktop, similarly to "sdl", but using the VirtualBox + viewer. Just like "sdl", it accepts the optional attributes <code>display</code> + and <code>fullscreen</code>. + </dd></dl></dd></dl> + <h4> + <a name="elementsVideo" id="elementsVideo">Video devices</a> + </h4> + <p> + A video device. + </p> + <pre> + ... + <video type='vga' nvram='8192' heads='1'> + <acceleration accel3d='yes' accel3d='yes' /> + </video> + ... + </pre> + <dl><dt><code>video</code></dt><dd>The <code>video</code> element has a mandatory <code>type</code> + attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". + You can also provide the amount of video memory using <code>nvram</code>, + the number of screen with <code>heads</code>, and whether acceleration + should be enabled (if supported) using the <code>accel3d</code> and + <code>accel2d</code> attributes in the <code>acceleration</code> element. + + </dd></dl> <h4> <a name="elementsConsole" id="elementsConsole">Consoles, serial & parallel devices</a> </h4> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 915814d..ec4a6e4 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -687,28 +687,83 @@ qemu-kvm -net nic,model=? /dev/null

<pre> ... + <graphics type='sdl' display=':0.0'/> <graphics type='vnc' port='5904'/> + <graphics type='rdp' autoport='yes' multiUser='yes' /> + <graphics type='desktop' fullscreen='yes'/> ...</pre>

<dl> <dt><code>graphics</code></dt> <dd>The <code>graphics</code> element has a mandatory <code>type</code> - attribute which takes the value "sdl" or "vnc". The former displays - a window on the host desktop, while the latter activates a VNC server. - The former accepts 3 optional arguments: a <code>display</code> - attribute for the display to use, an <code>xauth</code> attribute for - the authentication identifier, and an optional <code>fullscreen</code> - attribute accepting values 'yes' or 'no'. - If the latter is used the <code>port</code> attribute specifies the TCP - port number (with -1 as legacy syntax indicating that it should be - auto-allocated). The <code>autoport</code> attribute is the new - preferred syntax for indicating autoallocation of the TCP port to use. - The <code>listen</code> attribute is an IP address for the server to - listen on. The <code>passwd</code> attribute provides a VNC password - in clear text. The <code>keymap</code> attribute specifies the keymap - to use.</dd> + attribute which takes the value "sdl", "vnc", "rdp" or "desktop": + <dl> + <dt><code>"sdl"</code></dt> + <dd> + This displays a window on the host desktop, it can take 3 optional arguments: + a <code>display</code> attribute for the display to use, an <code>xauth</code> + attribute for the authentication identifier, and an optional <code>fullscreen</code> + attribute accepting values 'yes' or 'no'. + </dd> + <dt><code>"vnc"</code></dt> + <dd> + Starts a VNC server. The <code>port</code> attribute specifies the TCP + port number (with -1 as legacy syntax indicating that it should be + auto-allocated). The <code>autoport</code> attribute is the new + preferred syntax for indicating autoallocation of the TCP port to use. + The <code>listen</code> attribute is an IP address for the server to + listen on. The <code>passwd</code> attribute provides a VNC password + in clear text. The <code>keymap</code> attribute specifies the keymap + to use. + </dd> + <dt><code>"rdp"</code></dt> + <dd> + Starts a RDP server. The <code>port</code> attribute + specifies the TCP port number (with -1 as legacy syntax indicating + that it should be auto-allocated). The <code>autoport</code> attribute + is the new preferred syntax for indicating autoallocation of the TCP + port to use. The <code>replaceUser</code> attribute is a boolean deciding + whether multiple simultaneous connections to the VM are permitted. + The <code>multiUser</code> whether the existing connection must be dropped + and a new connection must be established by the VRDP server, when a new + client connects in single connection mode. + + </dd> + <dt><code>"desktop"</code></dt> + <dd> + This value is reserved for VirtualBox domains for the moment. It displays + a window on the host desktop, similarly to "sdl", but using the VirtualBox + viewer. Just like "sdl", it accepts the optional attributes <code>display</code> + and <code>fullscreen</code>. + </dd> + </dl> + </dd> </dl>

+ <h4><a name="elementsVideo">Video devices</a></h4> + <p> + A video device. + </p> + + <pre> + ... + <video type='vga' nvram='8192' heads='1'> + <acceleration accel3d='yes' accel3d='yes' /> + </video> + ... + </pre> + + <dl> + <dt><code>video</code></dt> + <dd>The <code>video</code> element has a mandatory <code>type</code> + attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". + You can also provide the amount of video memory using <code>nvram</code>, + the number of screen with <code>heads</code>, and whether acceleration + should be enabled (if supported) using the <code>accel3d</code> and + <code>accel2d</code> attributes in the <code>acceleration</code> element. + + </dl> + <h4><a name="elementsConsole">Consoles, serial & parallel devices</a></h4>

<p>

ACK, any docs is better than no docs :-) Daniel -- |: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :| |: http://libvirt.org -o- http://virt-manager.org -o- http://ovirt.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|