summaryrefslogtreecommitdiff
path: root/data
diff options
context:
space:
mode:
authorHans de Goede <hdegoede@redhat.com>2013-04-12 14:33:24 +0200
committerHans de Goede <hdegoede@redhat.com>2013-04-12 15:37:53 +0200
commitf55ecd9647c2dc5f69901c45e994021bf8059b2f (patch)
tree74b6ae85994b07cd4f6818a0aecd0d8dadaa0513 /data
parent243ed32ac77730a256651f48ad08b0e759b2ce32 (diff)
Add manpages for spice-vdagent and spice-vdagentd (rhbz#948511)
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Diffstat (limited to 'data')
-rw-r--r--data/spice-vdagent.1.in60
-rw-r--r--data/spice-vdagentd.1.in60
2 files changed, 120 insertions, 0 deletions
diff --git a/data/spice-vdagent.1.in b/data/spice-vdagent.1.in
new file mode 100644
index 0000000..f8547d4
--- /dev/null
+++ b/data/spice-vdagent.1.in
@@ -0,0 +1,60 @@
+.TH spice-vdagent "1" "April 2013" "@PACKAGE_STRING@"
+.SH NAME
+spice-vdagent \- Spice guest agent X11 session agent
+.SH SYNOPSIS
+\fBspice-vdagent\fR [\fIOPTIONS\fR]
+.SH DESCRIPTION
+The spice guest agent for Linux consists of 2 parts, a system wide daemon
+\fBspice-vdagentd\fR and a X11 session agent \fBspice-vdagent\fR of which
+there is one per X11 session.
+.br
+\fBspice-vdagent\fR gets automatically started in desktop environments which
+honor /etc/xdg/autostart, and under gdm.
+.SH FEATURES
+The spice guest agent adds the following features to spice Linux guests:
+.P
+Client mouse mode (no need to grab mouse by client, no mouse lag)
+.P
+Automatic adjustment of the X11 session's number of virtual monitors, and their
+resolution, to the number of client windows and their resolution
+.P
+Support of copy and paste (text and images) between the active X11 session
+and the client, this supports both the primary selection and the clipboard
+.P
+Support for transfering files from the client to the agent
+.SH OPTIONS
+.TP
+\fB-h\fP
+Print a short description of all command line options
+.TP
+\fB-d\fP
+Log debug messages
+.TP
+\fB-s\fP \fIport\fR
+Set virtio serial \fIport\fR (default: /dev/virtio-ports/com.redhat.spice.0)
+.TP
+\fB-x\fP
+Don't daemonize
+.TP
+\fB-f\fP \fIdir|xdg-desktop|xdg-download\fR
+Set directory where to save files send from the client, this can be either
+an arbitrary \fIdir\fR or one of the special values of \fIxdg-desktop\fR or
+\fIxdg-download\fR to select the default xdg Desktop resp. xdg Download
+directory. If no value is specified the default is \fIxdg-desktop\fR when
+running under a Desktop Environment which has icons on the desktop and
+\fIxdg-download\fR under other Desktop Environments
+.TP
+\fB-o\fP \fI0|1\fR
+Disable/enable opening the file save directory with xdg-open (showing the
+directory in the file manager) when a file transfer from the client
+completes. If no value is specified the default is \fI0\fR when running under
+a Desktop Environment which has icons on the desktop and \fI1\fR under other
+Desktop Environments
+.SH SEE ALSO
+\fBspice-vdagentd\fR(1)
+.SH COPYRIGHT
+Copyright 2010-2013 Red Hat, Inc. License GPLv3+: GNU GPL version 3 or later
+<http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
diff --git a/data/spice-vdagentd.1.in b/data/spice-vdagentd.1.in
new file mode 100644
index 0000000..0647585
--- /dev/null
+++ b/data/spice-vdagentd.1.in
@@ -0,0 +1,60 @@
+.TH spice-vdagentd "1" "April 2013" "@PACKAGE_STRING@"
+.SH NAME
+spice-vdagentd \- Spice guest agent daemon
+.SH SYNOPSIS
+\fBspice-vdagent\fR [\fIOPTIONS\fR]
+.SH DESCRIPTION
+The spice guest agent for Linux consists of 2 parts, a system wide daemon
+\fBspice-vdagentd\fR and a X11 session agent \fBspice-vdagent\fR of which
+there is one per X11 session.
+.br
+\fBspice-vdagentd\fR gets started through a Sys-V initscript or a systemd unit.
+.SH FEATURES
+The spice guest agent adds the following features to spice Linux guests:
+.P
+Client mouse mode (no need to grab mouse by client, no mouse lag)
+.P
+Automatic adjustment of the X11 session's number of virtual monitors, and their
+resolution, to the number of client windows and their resolution
+.P
+Support of copy and paste (text and images) between the active X11 session
+and the client, this supports both the primary selection and the clipboard
+.P
+Support for transfering files from the client to the agent
+.SH OPTIONS
+.TP
+\fB-h\fP
+Print a short description of all command line options
+.TP
+\fB-d\fP
+Log debug messages (use twice for extra info)
+.TP
+\fB-s\fP \fIport\fR
+Set virtio serial \fIport\fR (default: /dev/virtio-ports/com.redhat.spice.0)
+.TP
+\fB-u\fP \fIdevice\fR
+Set uinput \fIdevice\fR (default: /dev/uinput)
+.TP
+\fB-x\fP
+Don't daemonize
+.TP
+\fB-X\fP
+Disable session info usage, \fBspice-vdagentd\fR needs to know which
+\fBspice-vdagent\fR is in the currently active X11 session.
+\fBspice-vdagentd\fR uses console kit or systemd-logind (compile time option)
+for this; The \fB-X\fP option disables this, if no session info is available
+only one \fBspice-vdagent\fR is allowed
+.SH FILES
+The Sys-V initscript or systemd unit parses the following files:
+.TP
+/etc/sysconfig/spice-vdagentd
+Default cmdline options can be passed to \fBspice-vdagentd\fR by setting
+them in the \fISPICE_VDAGENTD_EXTRA_ARGS\fR variable in this file
+.SH SEE ALSO
+\fBspice-vdagent\fR(1)
+.SH COPYRIGHT
+Copyright 2010-2013 Red Hat, Inc. License GPLv3+: GNU GPL version 3 or later
+<http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.