data/spice-vdagent.1.in

   1 .TH spice-vdagent "1" "April 2013" "@PACKAGE_STRING@"
   2 .SH NAME
   3 spice-vdagent \- Spice guest agent X11 session agent
   4 .SH SYNOPSIS
   5 \fBspice-vdagent\fR [\fIOPTIONS\fR]
   6 .SH DESCRIPTION
   7 The spice guest agent for Linux consists of 2 parts, a system wide daemon
   8 \fBspice-vdagentd\fR and a X11 session agent \fBspice-vdagent\fR of which
   9 there is one per X11 session.
  10 .br
  11 \fBspice-vdagent\fR gets automatically started in desktop environments which
  12 honor /etc/xdg/autostart, and under gdm.
  13 .SH FEATURES
  14 The spice guest agent adds the following features to spice Linux guests:
  15 .P
  16 Client mouse mode (no need to grab mouse by client, no mouse lag)
  17 .P
  18 Automatic adjustment of the X11 session's number of virtual monitors, and their
  19 resolution, to the number of client windows and their resolution
  20 .P
  21 Support of copy and paste (text and images) between the active X11 session
  22 and the client, this supports both the primary selection and the clipboard
  23 .P
  24 Support for transfering files from the client to the agent
  25 .SH OPTIONS
  26 .TP
  27 \fB-h\fP
  28 Print a short description of all command line options
  29 .TP
  30 \fB-d\fP
  31 Log debug messages
  32 .TP
  33 \fB-s\fP \fIport\fR
  34 Set virtio serial \fIport\fR (default: /dev/virtio-ports/com.redhat.spice.0)
  35 .TP
  36 \fB-x\fP
  37 Don't daemonize
  38 .TP
  39 \fB-f\fP \fIdir|xdg-desktop|xdg-download\fR
  40 Set directory where to save files send from the client, this can be either
  41 an arbitrary \fIdir\fR or one of the special values of \fIxdg-desktop\fR or
  42 \fIxdg-download\fR to select the default xdg Desktop resp. xdg Download
  43 directory. If no value is specified the default is \fIxdg-desktop\fR when
  44 running under a Desktop Environment which has icons on the desktop and
  45 \fIxdg-download\fR under other Desktop Environments
  46 .TP
  47 \fB-o\fP \fI0|1\fR
  48 Disable/enable opening the file save directory with xdg-open (showing the
  49 directory in the file manager) when a file transfer from the client
  50 completes. If no value is specified the default is \fI0\fR when running under
  51 a Desktop Environment which has icons on the desktop and \fI1\fR under other
  52 Desktop Environments
  53 .SH SEE ALSO
  54 \fBspice-vdagentd\fR(1)
  55 .SH COPYRIGHT
  56 Copyright 2010-2013 Red Hat, Inc. License GPLv3+: GNU GPL version 3 or later
  57 <http://gnu.org/licenses/gpl.html>.
  58 .br
  59 This is free software: you are free to change and redistribute it.
  60 There is NO WARRANTY, to the extent permitted by law.