build-sys: get rid of noinst_HEADERS
[vd_agent.git] / data / spice-vdagentd.1.in
blob045b36c286d9bc10cc0df0e6788df266c66a4a7c
1 .TH spice-vdagentd "1" "April 2013" "@PACKAGE_STRING@"
2 .SH NAME
3 spice-vdagentd \- Spice guest agent daemon
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-vdagentd\fR gets started through a Sys-V initscript or a systemd unit.
12 .SH FEATURES
13 The spice guest agent adds the following features to spice Linux guests:
15 Client mouse mode (no need to grab mouse by client, no mouse lag)
17 Automatic adjustment of the X11 session's number of virtual monitors, and their
18 resolution, to the number of client windows and their resolution
20 Support of copy and paste (text and images) between the active X11 session
21 and the client, this supports both the primary selection and the clipboard
23 Support for transfering files from the client to the agent
24 .SH OPTIONS
25 .TP
26 \fB-h\fP
27 Print a short description of all command line options
28 .TP
29 \fB-d\fP
30 Log debug messages (use twice for extra info)
31 .TP
32 \fB-f\fP
33 Treat uinput device as fake; no ioctls.
34 This is useful in combination with Xspice.
35 .TP
36 \fB-o\fP
37 The daemon will exit after processing a single session.
38 .TP
39 \fB-s\fP \fIport\fR
40 Set virtio serial \fIport\fR (default: /dev/virtio-ports/com.redhat.spice.0)
41 .TP
42 \fB-u\fP \fIdevice\fR
43 Set uinput \fIdevice\fR (default: /dev/uinput)
44 .TP
45 \fB-x\fP
46 Don't daemonize
47 .TP
48 \fB-X\fP
49 Disable session info usage, \fBspice-vdagentd\fR needs to know which
50 \fBspice-vdagent\fR is in the currently active X11 session.
51 \fBspice-vdagentd\fR uses console kit or systemd-logind (compile time option)
52 for this; The \fB-X\fP option disables this, if no session info is available
53 only one \fBspice-vdagent\fR is allowed
54 .SH FILES
55 The Sys-V initscript or systemd unit parses the following files:
56 .TP
57 /etc/sysconfig/spice-vdagentd
58 Default cmdline options can be passed to \fBspice-vdagentd\fR by setting
59 them in the \fISPICE_VDAGENTD_EXTRA_ARGS\fR variable in this file
60 .SH SEE ALSO
61 \fBspice-vdagent\fR(1)
62 .SH COPYRIGHT
63 Copyright 2010-2013 Red Hat, Inc. License GPLv3+: GNU GPL version 3 or later
64 <http://gnu.org/licenses/gpl.html>.
65 .br
66 This is free software: you are free to change and redistribute it.
67 There is NO WARRANTY, to the extent permitted by law.