From: matt mooney Date: Sat, 14 May 2011 10:55:08 +0000 (-0700) Subject: staging: usbip: userspace: move manpages to separate directory X-Git-Tag: firefly_0821_release~7613^2~1326^2~169 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=7f27b199119980cba63c7968091d090beb6960cf;p=firefly-linux-kernel-4.4.55.git staging: usbip: userspace: move manpages to separate directory Signed-off-by: matt mooney Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/usbip/userspace/Makefile.am b/drivers/staging/usbip/userspace/Makefile.am index 964f005a4205..c0769526828b 100644 --- a/drivers/staging/usbip/userspace/Makefile.am +++ b/drivers/staging/usbip/userspace/Makefile.am @@ -2,6 +2,8 @@ SUBDIRS = lib cmd includedir=@includedir@/usbip include_HEADERS = lib/usbip.h lib/usbip_common.h lib/vhci_driver.h lib/stub_driver.h +dist_man_MANS := $(addprefix doc/, usbip.8 usbipd.8 usbip_bind_driver.8) + if INSTALL_USBIDS pkgdata_DATA = usb.ids EXTRA_DIST = $(pkgdata_DATA) diff --git a/drivers/staging/usbip/userspace/cmd/Makefile.am b/drivers/staging/usbip/userspace/cmd/Makefile.am index c923e49a7631..5cc50fc71de2 100644 --- a/drivers/staging/usbip/userspace/cmd/Makefile.am +++ b/drivers/staging/usbip/userspace/cmd/Makefile.am @@ -8,8 +8,6 @@ usbip_bind_driver_SOURCES = bind-driver.c \ utils.c utils.h \ usbip_network.h usbip_network.c -dist_man_MANS = usbip.8 usbipd.8 usbip_bind_driver.8 - #usbip_bind_driver_CFLAGS = -Wall -W -Wstrict-prototypes @PACKAGE_CFLAGS@ #usbip_bind_driver_LDADD = @PACKAGE_LIBS@ diff --git a/drivers/staging/usbip/userspace/cmd/usbip.8 b/drivers/staging/usbip/userspace/cmd/usbip.8 deleted file mode 100644 index 1653bb2cd7d1..000000000000 --- a/drivers/staging/usbip/userspace/cmd/usbip.8 +++ /dev/null @@ -1,71 +0,0 @@ -.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" -.SH NAME -usbip \- manage USB/IP devices -.SH SYNOPSIS -.B usbip -[\fIoptions\fR] - -.SH DESCRIPTION -Devices exported by USB/IP servers can be listed, attached and -detached using this program. - -.SH OPTIONS -.HP -\fB\-a\fR, \fB\-\-attach\fR -.IP -Attach a remote USB device. -.PP - -.HP -\fB\-x\fR, \fB\-\-attachall\fR -.IP -Attach all remote USB devices on the specific host. -.PP - -.HP -\fB\-d\fR, \fB\-\-detach\fR -.IP -Detach an imported USB device. -.PP - -.HP -\fB\-l\fR, \fB\-\-list\fR -.IP -List exported USB devices. -.PP - -.HP -\fB\-p\fR, \fB\-\-port\fR -.IP -List virtual USB port status. -.PP - -.HP -\fB\-D\fR, \fB\-\-debug\fR -.IP -Print debugging information. -.PP - -.HP -\fB\-v\fR, \fB\-\-version\fR -.IP -Show version. -.PP - -.SH EXAMPLES - - client:# usbip --list server - - List exportable usb devices on the server. - - client:# usbip --attach server 1-2 - - Connect the remote USB device. - - client:# usbip --port - - Show virtual port status. - - client:# usbip --detach 0 - - Detach the usb device. - -.SH "SEE ALSO" -\fBusbipd\fP\fB(8)\fB\fP, -\fBusbip_attach_driver\fP\fB(8)\fB\fP diff --git a/drivers/staging/usbip/userspace/cmd/usbip_bind_driver.8 b/drivers/staging/usbip/userspace/cmd/usbip_bind_driver.8 deleted file mode 100644 index 8a8972d5a93b..000000000000 --- a/drivers/staging/usbip/userspace/cmd/usbip_bind_driver.8 +++ /dev/null @@ -1,42 +0,0 @@ -.TH USBIP_BIND_DRIVER "8" "February 2009" "usbip" "System Administration Utilities" -.SH NAME -usbip_bind_driver \- change driver binding for USB/IP - -.SH SYNOPSIS -.B usbip_bind_driver -[\fIoptions\fR] - -.SH DESCRIPTION -Driver bindings for USB devices can be changed using -this program. It is used to export and unexport USB -devices over USB/IP. - -.SH OPTIONS -.TP -\fB\-u\fR, \fB\-\-usbip\fR -Make a device exportable -.TP -\fB\-o\fR, \fB\-\-other\fR -Use a device by a local driver -.TP -\fB\-l\fR, \fB\-\-list\fR -Print usb devices and their drivers -.TP -\fB\-L\fR, \fB\-\-list2\fR -Print usb devices and their drivers in parseable mode - -.SH EXAMPLES - - server:# usbip_bind_driver --list - - List driver assignments for usb devices. - - server:# usbip_bind_driver --usbip 1-2 - - Bind usbip.ko to the device of busid 1-2. - - A usb device 1-2 is now exportable to other hosts! - - server:# usbip_bind_driver --other 1-2 - - Shutdown exporting and use the device locally. - -.SH "SEE ALSO" -\fBusbip\fP\fB(8)\fB\fP, -\fBusbipd\fP\fB(8)\fB\fP diff --git a/drivers/staging/usbip/userspace/cmd/usbipd.8 b/drivers/staging/usbip/userspace/cmd/usbipd.8 deleted file mode 100644 index 3c39520901b9..000000000000 --- a/drivers/staging/usbip/userspace/cmd/usbipd.8 +++ /dev/null @@ -1,62 +0,0 @@ -.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" -.SH NAME -usbipd \- USB/IP server daemon -.SH SYNOPSIS -.B usbipd -[\fIoptions\fR] - -.SH DESCRIPTION -.B usbipd -provides USB/IP clients access to exported USB devices. - -Devices have to explicitly be exported using -.B usbip_bind_driver -before usbipd makes them available to other hosts. - -The daemon accepts connections from USB/IP clients -on TCP port 3240. - -.SH OPTIONS -.HP -\fB\-D\fR, \fB\-\-daemon\fR -.IP -Run as a daemon process. -.PP - -.HP -\fB\-d\fR, \fB\-\-debug\fR -.IP -Print debugging information. -.PP - -.HP -\fB\-v\fR, \fB\-\-version\fR -.IP -Show version. -.PP - -.SH LIMITATIONS - -.B usbipd -offers no authentication or authorization for USB/IP. Any -USB/IP client can connect and use exported devices. - -.SH EXAMPLES - - server:# modprobe usbip - - server:# usbipd -D - - Start usbip daemon. - - server:# usbip_bind_driver --list - - List driver assignments for usb devices. - - server:# usbip_bind_driver --usbip 1-2 - - Bind usbip.ko to the device of busid 1-2. - - A usb device 1-2 is now exportable to other hosts! - - Use 'usbip_bind_driver --other 1-2' when you want to shutdown exporting and use the device locally. - -.SH "SEE ALSO" -\fBusbip\fP\fB(8)\fB\fP, -\fBusbip_attach_driver\fP\fB(8)\fB\fP - diff --git a/drivers/staging/usbip/userspace/doc/usbip.8 b/drivers/staging/usbip/userspace/doc/usbip.8 new file mode 100644 index 000000000000..1653bb2cd7d1 --- /dev/null +++ b/drivers/staging/usbip/userspace/doc/usbip.8 @@ -0,0 +1,71 @@ +.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" +.SH NAME +usbip \- manage USB/IP devices +.SH SYNOPSIS +.B usbip +[\fIoptions\fR] + +.SH DESCRIPTION +Devices exported by USB/IP servers can be listed, attached and +detached using this program. + +.SH OPTIONS +.HP +\fB\-a\fR, \fB\-\-attach\fR +.IP +Attach a remote USB device. +.PP + +.HP +\fB\-x\fR, \fB\-\-attachall\fR +.IP +Attach all remote USB devices on the specific host. +.PP + +.HP +\fB\-d\fR, \fB\-\-detach\fR +.IP +Detach an imported USB device. +.PP + +.HP +\fB\-l\fR, \fB\-\-list\fR +.IP +List exported USB devices. +.PP + +.HP +\fB\-p\fR, \fB\-\-port\fR +.IP +List virtual USB port status. +.PP + +.HP +\fB\-D\fR, \fB\-\-debug\fR +.IP +Print debugging information. +.PP + +.HP +\fB\-v\fR, \fB\-\-version\fR +.IP +Show version. +.PP + +.SH EXAMPLES + + client:# usbip --list server + - List exportable usb devices on the server. + + client:# usbip --attach server 1-2 + - Connect the remote USB device. + + client:# usbip --port + - Show virtual port status. + + client:# usbip --detach 0 + - Detach the usb device. + +.SH "SEE ALSO" +\fBusbipd\fP\fB(8)\fB\fP, +\fBusbip_attach_driver\fP\fB(8)\fB\fP diff --git a/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8 b/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8 new file mode 100644 index 000000000000..8a8972d5a93b --- /dev/null +++ b/drivers/staging/usbip/userspace/doc/usbip_bind_driver.8 @@ -0,0 +1,42 @@ +.TH USBIP_BIND_DRIVER "8" "February 2009" "usbip" "System Administration Utilities" +.SH NAME +usbip_bind_driver \- change driver binding for USB/IP + +.SH SYNOPSIS +.B usbip_bind_driver +[\fIoptions\fR] + +.SH DESCRIPTION +Driver bindings for USB devices can be changed using +this program. It is used to export and unexport USB +devices over USB/IP. + +.SH OPTIONS +.TP +\fB\-u\fR, \fB\-\-usbip\fR +Make a device exportable +.TP +\fB\-o\fR, \fB\-\-other\fR +Use a device by a local driver +.TP +\fB\-l\fR, \fB\-\-list\fR +Print usb devices and their drivers +.TP +\fB\-L\fR, \fB\-\-list2\fR +Print usb devices and their drivers in parseable mode + +.SH EXAMPLES + + server:# usbip_bind_driver --list + - List driver assignments for usb devices. + + server:# usbip_bind_driver --usbip 1-2 + - Bind usbip.ko to the device of busid 1-2. + - A usb device 1-2 is now exportable to other hosts! + + server:# usbip_bind_driver --other 1-2 + - Shutdown exporting and use the device locally. + +.SH "SEE ALSO" +\fBusbip\fP\fB(8)\fB\fP, +\fBusbipd\fP\fB(8)\fB\fP diff --git a/drivers/staging/usbip/userspace/doc/usbipd.8 b/drivers/staging/usbip/userspace/doc/usbipd.8 new file mode 100644 index 000000000000..3c39520901b9 --- /dev/null +++ b/drivers/staging/usbip/userspace/doc/usbipd.8 @@ -0,0 +1,62 @@ +.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities" +.SH NAME +usbipd \- USB/IP server daemon +.SH SYNOPSIS +.B usbipd +[\fIoptions\fR] + +.SH DESCRIPTION +.B usbipd +provides USB/IP clients access to exported USB devices. + +Devices have to explicitly be exported using +.B usbip_bind_driver +before usbipd makes them available to other hosts. + +The daemon accepts connections from USB/IP clients +on TCP port 3240. + +.SH OPTIONS +.HP +\fB\-D\fR, \fB\-\-daemon\fR +.IP +Run as a daemon process. +.PP + +.HP +\fB\-d\fR, \fB\-\-debug\fR +.IP +Print debugging information. +.PP + +.HP +\fB\-v\fR, \fB\-\-version\fR +.IP +Show version. +.PP + +.SH LIMITATIONS + +.B usbipd +offers no authentication or authorization for USB/IP. Any +USB/IP client can connect and use exported devices. + +.SH EXAMPLES + + server:# modprobe usbip + + server:# usbipd -D + - Start usbip daemon. + + server:# usbip_bind_driver --list + - List driver assignments for usb devices. + + server:# usbip_bind_driver --usbip 1-2 + - Bind usbip.ko to the device of busid 1-2. + - A usb device 1-2 is now exportable to other hosts! + - Use 'usbip_bind_driver --other 1-2' when you want to shutdown exporting and use the device locally. + +.SH "SEE ALSO" +\fBusbip\fP\fB(8)\fB\fP, +\fBusbip_attach_driver\fP\fB(8)\fB\fP +