docs: add vkb device to xl.cfg and xl
authorOleksandr Grytsov <oleksandr_grytsov@epam.com>
Tue, 17 Jul 2018 16:07:38 +0000 (19:07 +0300)
committerWei Liu <wei.liu2@citrix.com>
Wed, 25 Jul 2018 10:08:21 +0000 (11:08 +0100)
Signed-off-by: Oleksandr Grytsov <oleksandr_grytsov@epam.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
docs/man/xl.cfg.pod.5.in
docs/man/xl.pod.1.in

index 099a28dc7a889bf65a6a278ea0dccd5323c71ced..cc98b6003f2f8617cc672af03a86655b6e338f02 100644 (file)
@@ -1563,6 +1563,30 @@ I<EXAMPLE:>
         ]
     ]
 
+=item B<vkb=[ "VKB_SPEC_STRING", "VKB_SPEC_STRING", ...]>
+
+Specifies the virtual keyboard device to be provided to the guest.
+
+Each B<VKB_SPEC_STRING> is a comma-separated list of C<KEY=VALUE>
+settings from the following list:
+
+=over 4
+
+=item B<unique-id=STRING>
+
+Specifies the unique input device id.
+
+=item B<backend=domain-id>
+
+Specifies the backend domain name or id.
+
+=item B<backend-type=type>
+
+Specifies the backend type: qemu - for QEMU backend or linux - for Linux PV
+domain.
+
+=back
+
 =back
 
 =head2 Paravirtualised (PV) Guest Specific Options
index 90423bf3dfb00bb05b4abe38796078cefc0e3a5b..b74764dcd36fd6a54d49aed7148848e34155d694 100644 (file)
@@ -1522,6 +1522,28 @@ List vsnd devices for a domain.
 
 =back
 
+=head2 KEYBOARD DEVICES
+
+=over 4
+
+=item B<vkb-attach> I<domain-id> I<vkb-device>
+
+Creates a new keyboard device in the domain specified by I<domain-id>.
+I<vkb-device> describes the device to attach, using the same format as the
+B<VKB_SPEC_STRING> string in the domain config file. See L<xl.cfg(5)>
+for more informations.
+
+=item B<vkb-detach> I<domain-id> I<devid>
+
+Removes the keyboard device from the domain specified by I<domain-id>.
+I<devid> is the virtual interface device number within the domain
+
+=item B<vkb-list> I<domain-id>
+
+List virtual network interfaces for a domain.
+
+=back
+
 =head1 PCI PASS-THROUGH
 
 =over 4