virt-click.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 virt-click - Send mouse click and key press events to virtual machines
   6
   7 =head1 SYNOPSIS
   8
   9  virt-click --vnc hostname[:display] command [args...]
  10
  11  virt-click --spice-host hostname command [args...]
  12
  13 =head1 DESCRIPTION
  14
  15 Virt-click can be used to send simulated mouse clicks and key presses
  16 to virtual machines, or to any remote VNC or SPICE server.  It is a
  17 command line tool which does not require Gtk or X11.  However the
  18 virtual machine must be configured with a graphical console.
  19
  20 =head1 EXAMPLES
  21
  22 For the complete list of options, see L</OPTIONS>.  For the
  23 complete list of commands, see L</COMMANDS> below.
  24
  25  virt-click --vnc localhost:1 click 200 200 right
  26
  27 Connect directly to VNC port 5901 on the local machine.  Simulate a
  28 right mouse click at screen coordinates C<(200,200)>.
  29
  30  virt-click --spice-host localhost --spice-port 5901 click 200 200 right
  31
  32 Same as above, but for SPICE.
  33
  34 =head1 OPTIONS
  35
  36 =over 4
  37
  38 =item B<--help>
  39
  40 Display brief help.
  41
  42 =item B<--spice-uri uri>
  43
  44 =item B<--spice-host host>
  45
  46 =item B<--spice-port port>
  47
  48 =item B<--spice-secure-port port>
  49
  50 =item B<--spice-ca-file file>
  51
  52 =item B<--spice-password password>
  53
  54 =item B<--spice-host-subject host-subj>
  55
  56 Connect directly to a SPICE server.  Either I<--spice-uri> or
  57 I<--spice-host> must be specified.  The others are optional.
  58
  59 =item B<-v>
  60
  61 Enable verbose messages for debugging.
  62
  63 =item B<-V>
  64
  65 =item B<--version>
  66
  67 Display version number and exit.
  68
  69 =item B<--vnc hostname>
  70
  71 =item B<--vnc hostname:display>
  72
  73 Connect directly to a VNC server.  The hostname parameter can either
  74 be the name of the VNC server (meaning to connect to display 0) or can
  75 be C<hostname:display> to connect to a particular display.
  76
  77 The port number that we connect to is 5900 + display number.
  78
  79 If the server requires authentication, it is queried interactively.
  80
  81 =back
  82
  83 =head1 COMMANDS
  84
  85 =over 4
  86
  87 =item B<click x y>
  88
  89 =item B<click x y button>
  90
  91 Simulate a mouse click at screen coordinates C<(x,y)>.
  92
  93 If C<button> is omitted, then the left button is pressed.
  94
  95 C<button> can have one of the following values:
  96
  97 =over 4
  98
  99 =item B<left>
 100
 101 =item B<middle>
 102
 103 =item B<right>
 104
 105 Left, middle, right mouse buttons.
 106
 107 =item B<up>
 108
 109 =item B<down>
 110
 111 Up and down scroll wheel.
 112
 113 =item B<scrollleft>
 114
 115 =item B<scrollright>
 116
 117 Left and right scroll wheel (not widely supported).
 118
 119 =item B<1> ... B<8>
 120
 121 Buttons 1 through 8 (1 = left, 2 = middle, 3 = right, 4 = up, 5 = down,
 122 6 = scroll left, 7 = scroll right, 8 = unused).
 123
 124 =back
 125
 126 =back
 127
 128 =head1 SEE ALSO
 129
 130 L<virt-viewer(1)>,
 131 L<http://libvirt.org/>,
 132 L<https://live.gnome.org/gtk-vnc>,
 133 L<http://spice-space.org/>.
 134
 135 =head1 AUTHOR
 136
 137 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 138
 139 =head1 COPYRIGHT
 140
 141 Copyright (C) 2011 Red Hat Inc.
 142
 143 This program is free software; you can redistribute it and/or modify
 144 it under the terms of the GNU General Public License as published by
 145 the Free Software Foundation; either version 2 of the License, or
 146 (at your option) any later version.
 147
 148 This program is distributed in the hope that it will be useful,
 149 but WITHOUT ANY WARRANTY; without even the implied warranty of
 150 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 151 GNU General Public License for more details.
 152
 153 You should have received a copy of the GNU General Public License
 154 along with this program; if not, write to the Free Software
 155 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.