[spice-streaming-agent,v2,2/3] Add a man page

Submitted by Uri Lublin on Oct. 3, 2019, 1:33 p.m.

Details

Message ID 20191003133305.12645-3-uril@redhat.com
State New
Headers show
Series "Get ready for v0.3 release" ( rev: 2 ) in Spice

Not browsing as part of any series.

Commit Message

Uri Lublin Oct. 3, 2019, 1:33 p.m.
Signed-off-by: Uri Lublin <uril@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
---
 Makefile.am                   |  2 +
 spice-streaming-agent.1       | 78 +++++++++++++++++++++++++++++++++++
 spice-streaming-agent.spec.in |  1 +
 3 files changed, 81 insertions(+)
 create mode 100644 spice-streaming-agent.1

Patch hide | download patch | download mbox

diff --git a/Makefile.am b/Makefile.am
index 99c1308..e57839d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,3 +25,5 @@  EXTRA_DIST = \
 	data/90-spice-guest-streaming.rules \
 	data/spice-streaming.desktop \
 	$(NULL)
+
+dist_man_MANS = spice-streaming-agent.1
diff --git a/spice-streaming-agent.1 b/spice-streaming-agent.1
new file mode 100644
index 0000000..81926fc
--- /dev/null
+++ b/spice-streaming-agent.1
@@ -0,0 +1,78 @@ 
+.TH SPICE-STREAMING-AGENT 1
+.SH NAME
+spice-streaming-agent \- An agent, running on a guest, sending video
+stream of X display to a remote client (over SPICE)
+
+.SH SYNOPSIS
+.B spice-streaming-agent [ <options> ]
+
+.SH DESCRIPTION
+.B spice-streaming-agent
+is an agent, running on a guest, sending video stream of X display to
+a remote client (over SPICE)
+
+The video stream itself depends on plugins/codecs installed on the guest
+(and the client).
+
+Currently only supports X display (Xorg/X11).
+
+Requires a virtio-port device to communicate and a recent enough
+spice-server.
+
+.B spice-streaming-agent
+should start automatically with your X session.
+
+.\" ToDo: add qemu-kvm command line option example
+.\"       or refer to README file
+
+.SH OPTIONS
+.TP
+.BR \-p " " \fIportname\fR
+The virtio-serial port to use
+(default is /dev/virtio-ports/org.spice-space.stream.0)
+.TP
+.BR \-l " " \fIfile\fR
+log frames to file
+
+.TP
+.BR \-\-log-binary
+log binary frames (following -l)
+
+.TP
+.BR \-\-log-categories
+log categories, separated by ':' (currently: frames)
+
+.TP
+.BR \-\-plugins-dir " " path
+change plugins directory
+
+.TP
+.BR \-d
+enable debug logs
+
+.TP
+.BR \-c  " " \fIvariable=value\fR
+A generic way to change plugins/codecs settings.
+This only affects plugins that support this variable
+and this value (and ignored otherwise).
+
+.TP
+.BR \-c  " " \fIframerate=1-100\fR
+
+.\" ToDo: more -c options related to plugins
+
+.SH EXAMPLES
+.TP
+run spice-streaming-agent with a framerate of 20 frames per second
+spice-streaming-agent -c framerate=20
+
+.TP
+run and log binary frames to /tmp/ssa.log
+spice-streaming-agent -l /tmp/ssa.log --log-binary
+
+.TP
+run and print a lot of debug information
+spice-streaming-agent -d
+
+.SH SEE ALSO
+qemu-kvm(1)
diff --git a/spice-streaming-agent.spec.in b/spice-streaming-agent.spec.in
index 299ea02..9ca6dc6 100644
--- a/spice-streaming-agent.spec.in
+++ b/spice-streaming-agent.spec.in
@@ -65,6 +65,7 @@  fi
 %{_bindir}/spice-streaming-agent
 %{_sysconfdir}/xdg/autostart/spice-streaming.desktop
 %{_datadir}/gdm/greeter/autostart/spice-streaming.desktop
+%{_mandir}/man1/spice-streaming-agent.1.gz
 
 %files devel
 %defattr(-,root,root,-)