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