diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2021-06-21 19:28:47 +0100 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2021-06-22 19:26:46 +0100 |
commit | e9a9d42d6b4da41cc01b726a4d919abc09841750 (patch) | |
tree | b6d31534c2355ea7690fc4d056b6576506859f04 /usr/src/man/man7d | |
parent | c432de9c6e1189ea0aa9b0fe1c35c18427653f27 (diff) | |
download | illumos-gate-e9a9d42d6b4da41cc01b726a4d919abc09841750.tar.gz |
13888 Some #include statements in the manual refer to nonexistent files
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Reviewed by: Andy Fiddaman <andy@omnios.org>
Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man7d')
-rw-r--r-- | usr/src/man/man7d/hid.7d | 29 | ||||
-rw-r--r-- | usr/src/man/man7d/sdp.7d | 63 |
2 files changed, 17 insertions, 75 deletions
diff --git a/usr/src/man/man7d/hid.7d b/usr/src/man/man7d/hid.7d index e6538e34a0..6601f7997b 100644 --- a/usr/src/man/man7d/hid.7d +++ b/usr/src/man/man7d/hid.7d @@ -3,21 +3,19 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HID 7D "May 13, 2017" +.TH HID 7D "June 19, 2021" .SH NAME hid \- Human interface device (HID) class driver .SH SYNOPSIS -.LP .nf \fBkeyboard@unit-address\fR \fBmouse@unit-address\fR \fBinput@unit-address:consumer_control\fR -\fB#include <sys/hid.h>\fR +\fB#include <sys/usb/clients/hid/hid.h>\fR \fBint ioctl(int fildes, int command, ... /*arg*/);\fR .fi .SH DESCRIPTION -.LP The \fBhid\fR driver is a USBA (Solaris USB Architecture) compliant client driver that supports the \fIHuman Interface Device Class (HID) 1.0\fR specification. The Human Interface Device (HID) class encompasses devices @@ -79,16 +77,6 @@ gets the input. .SH FILES .ne 2 .na -\fB\fB/kernel/drv/hid\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel hid module -.RE - -.sp -.ne 2 -.na \fB\fB/kernel/drv/amd64/hid\fR\fR .ad .sp .6 @@ -109,16 +97,6 @@ gets the input. .sp .ne 2 .na -\fB\fB/kernel/misc/hidparser\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel hidparser module -.RE - -.sp -.ne 2 -.na \fB\fB/kernel/misc/amd64/hidparser\fR\fR .ad .sp .6 @@ -137,7 +115,6 @@ gets the input. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -152,7 +129,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.LP \fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D), \fBvirtualkm\fR(7D) .sp .LP @@ -244,7 +220,6 @@ The device cannot be supported by this version of the HID driver. .RE .SH NOTES -.LP The hid driver currently supports only keyboard, mouse and audio HID control devices. .sp diff --git a/usr/src/man/man7d/sdp.7d b/usr/src/man/man7d/sdp.7d index ee91ffc27c..2f7411761c 100644 --- a/usr/src/man/man7d/sdp.7d +++ b/usr/src/man/man7d/sdp.7d @@ -3,13 +3,12 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SDP 7D "Nov 13, 2006" +.TH SDP 7D "June 19, 2021" .SH NAME sdp \- Sockets Direct Protocol driver .SH SYNOPSIS -.LP .nf -#include <socket.h> +#include <sys/socket.h> .fi .LP @@ -28,8 +27,6 @@ sdp \- Sockets Direct Protocol driver .fi .SH DESCRIPTION -.sp -.LP The Sockets Direct Protocol (\fBSDP\fR) is a transport protocol layered over the \fIInfiniband Transport Framework\fR (\fBIBTF\fR). \fBSDP\fR is a standard implementation based on Annex 4 of the \fIInfiniband Architecture Specification @@ -59,56 +56,51 @@ have their local IP or IPv6 address and \fBSDP\fR port number bound with the \fBSDP\fR sockets are active. A passive socket is created by calling the \fBlisten\fR(3SOCKET) system call after binding the socket with bind(). This process establishes a queueing parameter for the passive socket. Connections to -the passive socket can be received with the \fBaccept\fR(3SOCKET) system call. +the passive socket can be received with the \fBaccept\fR(3SOCKET) system call. Active sockets use the \fBconnect\fR(3SOCKET) call after binding to initiate connections. .sp .LP In most cases, \fBSDP\fR sends data when it is presented. When outstanding data is not yet acknowledged, \fBSDP\fR gathers small amounts of output to be -sent in a single packet once an acknowledgement is received. For a small +sent in a single packet once an acknowledgement is received. For a small number of clients this packetization may cause significant delays. To -circumvent this problem, \fBSDP\fR provided by the driver supplies +circumvent this problem, \fBSDP\fR provided by the driver supplies SDP_NODELAY, a socket-level boolean option. Note that this behavior is similar to the TCP_NODELAY option. .sp .LP \fBSDP\fR provides an urgent data mechanism that can be invoked using the -out-of-band provisions of \fBsend\fR(3SOCKET). The out-of-band delivery +out-of-band provisions of \fBsend\fR(3SOCKET). The out-of-band delivery behavior is identical to TCP. The caller may mark one byte as "urgent" with the -MSG_OOB flag to \fBsend\fR(3SOCKET). This sets an "urgent pointer" pointing to +MSG_OOB flag to \fBsend\fR(3SOCKET). This sets an "urgent pointer" pointing to the byte in the \fBSDP\fR stream. The receiver of the stream is notified of the -urgent data by a \fBSIGURG\fR signal. The SIOCATMARK \fBioctl\fR(2) request +urgent data by a \fBSIGURG\fR signal. The SIOCATMARK \fBioctl\fR(2) request returns a value indicating whether the stream is at the urgent mark. Because -the system never returns data across the urgent mark in a single \fBread\fR(2) +the system never returns data across the urgent mark in a single \fBread\fR(2) call, it is possible to advance to the urgent data in a simple loop which reads -data, testing the socket with the \fBSIOCATMARK\fR ioctl() request until it +data, testing the socket with the \fBSIOCATMARK\fR ioctl() request until it reaches the mark. .SH ADDRESS FORMATS -.sp -.LP -\fBSDP\fR uses IP/IPv6 addresses to refer to local and remote devices and +\fBSDP\fR uses IP/IPv6 addresses to refer to local and remote devices and opens a reliable connected IB connection between two end points. The \fBsdp\fR driver supports a point-to-point connection, however broadcasting and multicasting are not supported. .SH SOCKET OPTIONS -.sp -.LP \fBSDP\fR supports setsockopt and getsockopt to set and read socket options. Very few socket options affect \fBSDP\fR protocol operations. Other common -socket options are processed but do not affect SDP protocol operation. All +socket options are processed but do not affect SDP protocol operation. All socket options are checked for validity. A getsockopt returns the values set or toggled by setsockopt. Socket options that affect protocol operations are SO_LINGER, SO_DEBUG, SO_REUSEADDR and SO_OOBINLINE. .SH ERRORS -.sp .ne 2 .na \fB\fBEISCONN\fR\fR .ad .RS 28n A connect() operation was attempted on a socket on which a connect() operation -had already been performed. +had already been performed. .RE .sp @@ -137,7 +129,7 @@ because no process is listening to the port. \fB\fBEADDRINUSE\fR\fR .ad .RS 28n -A bind() operation was attempted on a socket with a network address/port pair +A bind() operation was attempted on a socket with a network address/port pair that has already been bound to another socket. .RE @@ -157,7 +149,7 @@ no network interface exists. \fB\fBEACCES\fR\fR .ad .RS 28n -A bind() operation was attempted with a reserved port number and the effective +A bind() operation was attempted with a reserved port number and the effective user ID of the process was not the privileged user. .RE @@ -171,17 +163,6 @@ The system ran out of memory for internal data structures. .RE .SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sdp\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp .ne 2 .na \fB\fB/kernel/drv/amd64/sdp\fR\fR @@ -204,16 +185,6 @@ The system ran out of memory for internal data structures. .sp .ne 2 .na -\fB\fB/kernel/drv/sdpib\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na \fB\fB/kernel/drv/amd64/sdpib\fR\fR .ad .sp .6 @@ -232,8 +203,6 @@ The system ran out of memory for internal data structures. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attribute: .sp @@ -248,8 +217,6 @@ Architecture x86, SPARC .TE .SH SEE ALSO -.sp -.LP \fBread\fR(2), \fBgetsockopt\fR(3XNET), \fBsocket.h\fR(3HEAD), \fBaccept\fR(3SOCKET), \fBbind\fR(3SOCKET), \fBconnect\fR(3SOCKET), \fBsend\fR(3SOCKET), \fBattributes\fR(5), \fBstandards\fR(5) |