diff options
author | Hans de Goede <hdegoede@redhat.com> | 2012-04-02 11:32:11 +0200 |
---|---|---|
committer | Hans de Goede <hdegoede@redhat.com> | 2012-04-02 11:43:34 +0200 |
commit | 2e27877fd7a577d3afdeb29a3d6105bd3150816b (patch) | |
tree | 02efe1f270c9403f7eabd84f1ea8ed3d395079d3 /usbredirserver | |
parent | 0c6cea986b1cf6a5d20778842043475042e1716d (diff) |
usbredirserver: Add a manpage
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Diffstat (limited to 'usbredirserver')
-rw-r--r-- | usbredirserver/Makefile.am | 2 | ||||
-rw-r--r-- | usbredirserver/usbredirserver.1 | 38 |
2 files changed, 40 insertions, 0 deletions
diff --git a/usbredirserver/Makefile.am b/usbredirserver/Makefile.am index 6d059f5..bcfc23d 100644 --- a/usbredirserver/Makefile.am +++ b/usbredirserver/Makefile.am @@ -6,3 +6,5 @@ usbredirserver_LDADD = $(LIBUSB_LIBS) \ usbredirserver_CFLAGS = $(LIBUSB_CFLAGS) \ -I$(top_srcdir)/usbredirhost \ -I$(top_srcdir)/usbredirparser + +dist_man_MANS = usbredirserver.1 diff --git a/usbredirserver/usbredirserver.1 b/usbredirserver/usbredirserver.1 new file mode 100644 index 0000000..6ae78bc --- /dev/null +++ b/usbredirserver/usbredirserver.1 @@ -0,0 +1,38 @@ +.TH USBREDIRSERVER "1" "April 2012" "usbredirserver 0.4.3" "User Commands" +.SH NAME +usbredirserver \- manual page for usbredirserver 0.4.3 +.SH SYNOPSIS +.B usbredirserver +[\fI-p|--port <port>\fR] [\fI-v|--verbose <0-5>\fR] \fI<usbbus-usbaddr|vendorid:prodid>\fR +.SH DESCRIPTION +usbredirserver is a small standalone server for exporting an USB device for +use from another (virtual) machine through the usbredir protocol. +.PP +You can specify the USB device to export either by USB id in the form of +\fI<vendorid>:<prodid>\fR, or by USB bus number and device address in the form +of \fI<usbbus>-<usbaddr>\fR. +.PP +Notice that an instance of usbredirserver can only be used to export a +single USB device. If you want to export multiple devices you can start +multiple instances listening on different TCP ports. +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-port\fR=\fIPORT\fR +Set the TCP port to listen on to \fIPORT\fR +.TP +\fB\-v\fR, \fB\-\-verbose\fR=\fIVERBOSE\fR +Set usbredirserver's verbosity level to \fIVERBOSE\fR, this mostly affects USB +redirection related messages. Valid values are 0-5: +.br +0:Silent 1:Errors 2:Warnings 3:Info 4:Debug 5:Debug++ +.SH AUTHOR +Written by Hans de Goede <hdegoede@redhat.com> +.SH REPORTING BUGS +Report bugs to the spice-devel mailinglist: +http://lists.freedesktop.org/mailman/listinfo/spice-devel +.SH COPYRIGHT +Copyright 2010-2012 Red Hat, Inc. +License GPLv2+: GNU GPL version 2 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. |