[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [libvirt-virshcmdref 13/14] update documentation for command sendkey



---
 common.sh           |    2 +-
 source/send-key.xml |   80 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 81 insertions(+), 1 deletions(-)
 create mode 100644 source/send-key.xml

diff --git a/common.sh b/common.sh
index 13e8995..51dc3e1 100755
--- a/common.sh
+++ b/common.sh
@@ -6,7 +6,7 @@ DOMAIN_COMMANDS="attach-device attach-disk attach-interface autostart
   hostname managedsave managedsave-remove maxvcpus memtune migrate
   migrate-setmaxdowntime reboot restore resume save schedinfo setmaxmem
   setmem setvcpus shutdown start suspend ttyconsole undefine update-device
-  vcpucount vcpuinfo vcpupin version vncdisplay blkiotune"
+  vcpucount vcpuinfo vcpupin version vncdisplay blkiotune send-key"
 
 MONITOR_COMMANDS="domblkinfo domblkstat domifstat dominfo dommemstat
   domstate list"
diff --git a/source/send-key.xml b/source/send-key.xml
new file mode 100644
index 0000000..03369b4
--- /dev/null
+++ b/source/send-key.xml
@@ -0,0 +1,80 @@
+<?xml version='1.0' encoding='utf-8' ?>
+
+<command>
+  <name>send-key</name>
+
+  <description>
+    <text>
+      Send keycodes to the guest
+    </text>
+  </description>
+
+  <options>
+    <parameter requirement="required">
+      <keyword requirement="optional">--domain</keyword>
+      <value type="string" requirement="required">domain</value>
+      <description>
+        <text>
+          domain name, id or uuid
+        </text>
+        <text>
+          "--domain" itself is optional
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--codeset</keyword>
+      <description>
+        <text>
+          the codeset of keycodes, possible values are: linux, xt, atset1,
+          atset2, atset3, os_x, xt_kbd, usb and win32, default:linux
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--holdtime</keyword>
+      <description>
+        <text>
+          the time (in millisecond) the keys will be held for
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="required">
+      <value type="string" requirement="required">keycode</value>
+      <description>
+        <text>
+          key codes to send to domain
+        </text>
+      </description>
+    </parameter>
+  </options>
+
+  <availability from="0.9.4" />
+ 
+  <notes />
+ 
+  <examples type="usage">
+    <example>
+      <terminal>virsh # <bold>send-key</bold> <value>example-domain</value> <value>37 18 21</value></terminal>
+      <text>
+        sends keys 'k', 'e' and 'y' to domain <value>example-domain</value>.
+      </text>
+    </example>
+    <example>
+      <terminal>virsh # <bold>send-key</bold> <value>example-domain</value> <value>KEY_RIGHTCTRL KEY_C</value></terminal>
+      <text>
+        sends keys right CTRL and 'c' to domain <value>example-domain</value>.
+      </text>
+    </example>
+    <example>
+      <terminal>virsh # <bold>send-key</bold> <value>example-domain</value> <italic>--holdtime</italic> 1000 <value>0x15 18 0xf</value></terminal>
+      <text>
+        sends keys 'y', 'e' and TAB to domain <value>example-domain</value>, holding them for 1 second.
+      </text>
+    </example>
+  </examples>
+
+  <examples type="fullcontext" />
+
+  <reference type="seealso" />
+</command>
-- 
1.7.3.1


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]