diff options
Diffstat (limited to 'usr/src')
28 files changed, 147 insertions, 494 deletions
diff --git a/usr/src/man/man3c/cset.3c b/usr/src/man/man3c/cset.3c index 5d6b7f8a39..58291d7cf0 100644 --- a/usr/src/man/man3c/cset.3c +++ b/usr/src/man/man3c/cset.3c @@ -3,11 +3,10 @@ .\" 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 CSET 3C "Nov 16, 2003" +.TH CSET 3C "June 18, 2021" .SH NAME cset, csetlen, csetcol, csetno, wcsetno \- get information on EUC codesets .SH SYNOPSIS -.LP .nf #include <euc.h> @@ -32,9 +31,7 @@ cset, csetlen, csetcol, csetno, wcsetno \- get information on EUC codesets .fi .SH DESCRIPTION -.sp -.LP -Both \fBcsetlen()\fR and \fBcsetcol()\fR take a code set number \fIcodeset\fR, +Both \fBcsetlen()\fR and \fBcsetcol()\fR take a code set number \fIcodeset\fR, which must be 0, 1, 2, or 3. The \fBcsetlen()\fR function returns the number of bytes needed to represent a character of the given Extended Unix Code (EUC) code set, excluding the single-shift characters SS2 and SS3 for codesets 2 and @@ -48,7 +45,7 @@ For example, .sp .in +2 .nf -#include<euc.h> +#include <euc.h> \|.\|.\|. x+=csetcol(csetno(c)); .fi @@ -66,8 +63,8 @@ example, .sp .in +2 .nf -#include<euc.h> -#include<widec.h> +#include <euc.h> +#include <widec.h> \|.\|.\|. x+=csetcol(wcsetno(pc)); .fi @@ -78,8 +75,6 @@ x+=csetcol(wcsetno(pc)); increments a counter "x" (such as the cursor position) by the width of the Process Code character \fIpc\fR. .SH USAGE -.sp -.LP These functions work only for the EUC locales. .sp .LP @@ -87,8 +82,6 @@ The \fBcset()\fR, \fBcsetlen()\fR, \fBcsetcol()\fR, \fBcsetno()\fR, and \fBwcsetno()\fR functions can be used safely in multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called to change the locale. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -103,6 +96,4 @@ MT-Level MT-Safe with exceptions .TE .SH SEE ALSO -.sp -.LP -\fBsetlocale\fR(3C) \fBeuclen\fR(3C), \fBattributes\fR(5) +\fBsetlocale\fR(3C), \fBeuclen\fR(3C), \fBattributes\fR(5) diff --git a/usr/src/man/man3c/mkfifo.3c b/usr/src/man/man3c/mkfifo.3c index 40e2927aa4..7c55928d76 100644 --- a/usr/src/man/man3c/mkfifo.3c +++ b/usr/src/man/man3c/mkfifo.3c @@ -45,11 +45,10 @@ .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved. .\" Copyright (c) 2014, Joyent, Inc. .\" -.TH MKFIFO 3C "Apr 24, 2002" +.TH MKFIFO 3C "June 18, 2021" .SH NAME mkfifo, mkfifoat \- make a FIFO special file .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/stat.h> @@ -62,7 +61,6 @@ mkfifo, mkfifoat \- make a FIFO special file .fi .SH DESCRIPTION -.LP The \fBmkfifo()\fR and \fBmkfifoat()\fR functions create a new FIFO special file named by the pathname pointed to by \fIpath\fR. The file permission bits of the new FIFO are initialized from \fImode\fR. The file permission bits of the @@ -96,11 +94,9 @@ the \fBst_atime\fR, \fBst_ctime\fR, and \fBst_mtime\fR fields of the file. Also, the \fBst_ctime\fR and \fBst_mtime\fR fields of the directory that contains the new entry are marked for update. .SH RETURN VALUES -.LP Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error. .SH ERRORS -.LP The \fBmkfifo()\fR and \fBmkfifoat()\fR functions will fail if: .sp .ne 2 @@ -217,7 +213,6 @@ component is longer than {\fBNAME_MAX\fR}. .RE .SH EXAMPLES -.LP \fBExample 1 \fRCreate a FIFO File .sp .LP @@ -228,8 +223,8 @@ permissions for the group and others. .sp .in +2 .nf -#include sys/types.h> -#include sys/stat.h> +#include <sys/types.h> +#include <sys/stat.h> int status; \&... status = mkfifo("/home/cnd/mod_done", S_IWUSR | S_IRUSR | @@ -238,7 +233,6 @@ status = mkfifo("/home/cnd/mod_done", S_IWUSR | S_IRUSR | .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -255,6 +249,5 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.LP \fBmkdir\fR(1), \fBchmod\fR(2), \fBexec\fR(2), \fBmknod\fR(2), \fBumask\fR(2), \fBstat.h\fR(3HEAD), \fBufs\fR(7FS), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3c/posix_openpt.3c b/usr/src/man/man3c/posix_openpt.3c index 716778eb21..16193b89f3 100644 --- a/usr/src/man/man3c/posix_openpt.3c +++ b/usr/src/man/man3c/posix_openpt.3c @@ -43,11 +43,10 @@ .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH POSIX_OPENPT 3C "Dec 1, 2003" +.TH POSIX_OPENPT 3C "June 18, 2021" .SH NAME posix_openpt \- open a pseudo terminal device .SH SYNOPSIS -.LP .nf #include <stdlib.h> #include <fcntl.h> @@ -56,8 +55,6 @@ posix_openpt \- open a pseudo terminal device .fi .SH DESCRIPTION -.sp -.LP The \fBposix_openpt()\fR function establishes a connection between a master device for a pseudo-terminal and a file descriptor. The file descriptor is used by other I/O functions that refer to that pseudo-terminal. @@ -92,15 +89,11 @@ controlling terminal for the process. .LP The behavior of other values for the \fIoflag\fR argument is unspecified. .SH RETURN VALUES -.sp -.LP Upon successful completion, the \fBposix_openpt()\fR function opens a master pseudo-terminal device and returns a non-negative integer representing the lowest numbered unused file descriptor. Otherwise, -1 is returned and \fBerrno\fR is set to indicate the error. .SH ERRORS -.sp -.LP The \fBposix_openpt()\fR function will fail if: .sp .ne 2 @@ -151,7 +144,6 @@ Out of STREAMS resources. .RE .SH EXAMPLES -.LP \fBExample 1 \fROpen a pseudo-terminal. .sp .LP @@ -161,8 +153,8 @@ device and a file descriptor. .sp .in +2 .nf -#include fcntl.h> -#include stdio.h> +#include <fcntl.h> +#include <stdio.h> int masterfd, slavefd; char *slavedevice; @@ -184,15 +176,11 @@ if (slavefd < 0) .in -2 .SH USAGE -.sp -.LP This function provides a method for portably obtaining a file descriptor of a master terminal device for a pseudo-terminal. The \fBgrantpt\fR(3C) and \fBptsname\fR(3C) functions can be used to manipulate mode and ownership permissions and to obtain the name of the slave device, respectively. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -209,7 +197,5 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBopen\fR(2), \fBgrantpt\fR(3C), \fBptsname\fR(3C), \fBunlockpt\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3c/setlabel.3c b/usr/src/man/man3c/setlabel.3c index dfb913dd52..72fcb15581 100644 --- a/usr/src/man/man3c/setlabel.3c +++ b/usr/src/man/man3c/setlabel.3c @@ -3,20 +3,17 @@ .\" 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 SETLABEL 3C "Dec 29, 1996" +.TH SETLABEL 3C "June 19, 2021" .SH NAME setlabel \- define the label for \fBpfmt()\fR and \fBlfmt()\fR .SH SYNOPSIS -.LP .nf -#include <pfmt..h> +#include <pfmt.h> \fBint\fR \fBsetlabel\fR(\fBconst char *\fR\fIlabel\fR); .fi .SH DESCRIPTION -.sp -.LP The \fBsetlabel()\fR function defines the label for messages produced in standard format by subsequent calls to \fBlfmt\fR(3C) and \fBpfmt\fR(3C). .sp @@ -27,15 +24,11 @@ length. .LP No label is defined before \fBsetlabel()\fR is called. The label should be set once at the beginning of a utility and remain constant. A null pointer or an -empty string passed as argument will reset the definition of the label. +empty string passed as argument will reset the definition of the label. .SH RETURN VALUE -.sp -.LP Upon successful completion, \fBsetlabel()\fR returns \fB0\fR; otherwise, it returns a non-zero value. .SH EXAMPLES -.sp -.LP The following code (without previous call to \fBsetlabel()\fR): .sp .in +2 @@ -58,8 +51,6 @@ UX:test: ERROR: Cannot open file .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -74,6 +65,4 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBgetopt\fR(3C), \fBlfmt\fR(3C), \fBpfmt\fR(3C), \fBattributes\fR(5) diff --git a/usr/src/man/man3c/uconv_u16tou32.3c b/usr/src/man/man3c/uconv_u16tou32.3c index 3508554f60..2223625ac1 100644 --- a/usr/src/man/man3c/uconv_u16tou32.3c +++ b/usr/src/man/man3c/uconv_u16tou32.3c @@ -3,12 +3,11 @@ .\" 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 UCONV_U16TOU32 3C "Sep 18, 2007" +.TH UCONV_U16TOU32 3C "June 19, 2021" .SH NAME uconv_u16tou32, uconv_u16tou8, uconv_u32tou16, uconv_u32tou8, uconv_u8tou16, uconv_u8tou32 \- Unicode encoding conversion functions .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -49,7 +48,6 @@ uconv_u8tou32 \- Unicode encoding conversion functions .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIutf16str\fR\fR @@ -220,8 +218,6 @@ character to indicate the byte ordering if the output parameter is in .RE .SH DESCRIPTION -.sp -.LP The \fBuconv_u16tou32()\fR function reads the given \fIutf16str\fR in \fBUTF-16\fR until \fBU+0000\fR (zero) in \fIutf16str\fR is encountered as a character or until the number of 16-bit unsigned integers specified in @@ -301,8 +297,6 @@ the specified number of input parameter elements at \fIutf16len\fR, As output parameters, \fIutf16len\fR, \fIutf32len\fR, and \fIutf8len\fR are not changed if conversion fails for any reason. .SH RETURN VALUES -.sp -.LP Upon successful conversion, the functions return \fB0\fR. Upon failure, the functions return one of the following \fBerrno\fR values: .sp @@ -345,7 +339,6 @@ Conflicting byte-ordering option \fIflag\fR values are detected. .RE .SH EXAMPLES -.LP \fBExample 1 \fRConvert a \fBUTF-16\fR string in little-endian byte ordering into \fBUTF-8\fR string. .sp @@ -435,7 +428,7 @@ parameter. .nf #include <sys/types.h> #include <sys/errno.h> -#include <sys/u8_textprep> +#include <sys/u8_textprep.h> \&. \&. \&. @@ -460,8 +453,6 @@ if (ret != 0) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -478,15 +469,11 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBuconv_u16tou32\fR(9F) .sp .LP The Unicode Standard (http://www.unicode.org) .SH NOTES -.sp -.LP Each \fBUTF-16\fR or \fBUTF-32\fR character maps to an \fBUTF-8\fR character that might need one to maximum of four bytes. .sp diff --git a/usr/src/man/man3c/wsscanf.3c b/usr/src/man/man3c/wsscanf.3c index 84b7e096ad..cd55f8776f 100644 --- a/usr/src/man/man3c/wsscanf.3c +++ b/usr/src/man/man3c/wsscanf.3c @@ -3,21 +3,18 @@ .\" 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 WSSCANF 3C "Dec 29, 1996" +.TH WSSCANF 3C "June 18, 2021" .SH NAME wsscanf \- formatted input conversion .SH SYNOPSIS -.LP .nf -#include<stdio.h> +#include <stdio.h> #include <widec.h> \fBint\fR \fBwsscanf\fR(\fBwchar_t *\fR\fIs\fR, \fBconst char *\fR\fIformat\fR, \fB/*\fR \fIpointer\fR */ ... ); .fi .SH DESCRIPTION -.sp -.LP The \fBwsscanf()\fR function reads Process Code characters from the Process Code string \fIs\fR, interprets them according to the \fIformat\fR, and stores the results in its arguments. It expects, as arguments, a control string @@ -32,13 +29,9 @@ the regular \fBsscanf\fR(3C) function except that the source is a Process Code string for \fBwsscanf()\fR and on Extended Unix Code (EUC) character string for \fBsscanf\fR(3C). .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBwsscanf()\fR returns the number of characters matched. Otherwise, it returns a negative value. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -53,6 +46,4 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBwsprintf\fR(3C), \fBprintf\fR(3C), \fBscanf\fR(3C), \fBattributes\fR(5) diff --git a/usr/src/man/man3commputil/sdp_add_origin.3commputil b/usr/src/man/man3commputil/sdp_add_origin.3commputil index 9083c5bb31..1613bb2e22 100644 --- a/usr/src/man/man3commputil/sdp_add_origin.3commputil +++ b/usr/src/man/man3commputil/sdp_add_origin.3commputil @@ -4,14 +4,13 @@ .\" 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_ADD_ORIGIN 3COMMPUTIL "Oct 12, 2007" +.TH SDP_ADD_ORIGIN 3COMMPUTIL "June 18, 2021" .SH NAME sdp_add_origin, sdp_add_name, sdp_add_information, sdp_add_uri, sdp_add_email, sdp_add_phone, sdp_add_connection, sdp_add_bandwidth, sdp_add_repeat, sdp_add_time, sdp_add_zone, sdp_add_key, sdp_add_attribute, sdp_add_media \- add specific SDP fields to the SDP session structure .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...] #include <sdp.h> @@ -97,8 +96,6 @@ add specific SDP fields to the SDP session structure .fi .SH DESCRIPTION -.sp -.LP The caller has to first call \fBsdp_new_session\fR(3COMMPUTIL) and get pointer to a session structure. Then that pointer is used as argument in the following functions and the session structure is constructed. Once the structure is built @@ -156,7 +153,7 @@ as the first argument. .sp .LP The \fBsdp_add_time()\fR function adds the TIME (t=) SDP field to the session -structure using \fIstartime\fR and \fIstoptime\fR. The pointer to the newly +structure using \fIstarttime\fR and \fIstoptime\fR. The pointer to the newly created time structure is returned in \fItime\fR. This pointer is then used in \fBsdp_add_repeat()\fR function. .sp @@ -195,14 +192,10 @@ possibly more than one value, for example, "0 31 32 97". The pointer to the newly created media structure is returned in \fImedia\fR. This pointer is then used to add SDP fields specific to that media section. .SH RETURN VALUES -.sp -.LP These functions return 0 on success and the appropriate error value on failure. The value of \fBerrno\fR is not changed by these calls in the event of an error. .SH ERRORS -.sp -.LP These functions will fail if: .sp .ne 2 @@ -223,7 +216,6 @@ The allocation of memory failed. .RE .SH EXAMPLES -.LP \fBExample 1 \fRBuild an SDP session structure .sp .LP @@ -262,10 +254,10 @@ a=rtpmap:99 h232-199/90000\er\en\e a=rtpmap:90 h263-1998/90000\er\en" */ -#include stdio.h> -#include string.h> -#include errno.h> -#include sdp.h> +#include <stdio.h> +#include <string.h> +#include <errno.h> +#include <sdp.h> int main () { @@ -348,8 +340,6 @@ err_ret: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -366,8 +356,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibcommputil\fR(3LIB), \fBsdp_new_session\fR(3COMMPUTIL), \fBsdp_parse\fR(3COMMPUTIL), \fBsdp_session_to_str\fR(3COMMPUTIL), \fBattributes\fR(5) diff --git a/usr/src/man/man3curses/curs_addwch.3curses b/usr/src/man/man3curses/curs_addwch.3curses index 04945396f2..d00e9b2af2 100644 --- a/usr/src/man/man3curses/curs_addwch.3curses +++ b/usr/src/man/man3curses/curs_addwch.3curses @@ -4,19 +4,18 @@ .\" 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 CURS_ADDWCH 3CURSES "Dec 31, 1996" +.TH CURS_ADDWCH 3CURSES "June 18, 2021" .SH NAME curs_addwch, addwch, waddwch, mvaddwch, mvwaddwch, echowchar, wechowchar \- add a wchar_t character (with attributes) to a curses window and advance cursor .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR]... \fIfile\fR... \fB-lcurses\fR [\fIlibrary\fR]... .fi .LP .nf -#include<curses.h> +#include <curses.h> \fBint\fR \fBaddwch\fR(\fBchtype\fR \fIwch\fR); .fi @@ -47,10 +46,8 @@ a wchar_t character (with attributes) to a curses window and advance cursor .fi .SH DESCRIPTION -.sp -.LP -The \fBaddwch()\fR,\fBwaddwch()\fR,\fBmvaddwch()\fR, and \fBmvwaddwch()\fR -routines put the character \fIwch\fR, holding a \fBwchar_t\fR character, into +The \fBaddwch()\fR, \fBwaddwch()\fR, \fBmvaddwch()\fR, and \fBmvwaddwch()\fR +routines put the character \fIwch\fR, holding a \fBwchar_t\fR character, into the window at the current cursor position of the window and advance the position of the window cursor. Their function is similar to that of \fBputwchar\fR(3C) in the C multibyte library. At the right margin, an @@ -58,34 +55,32 @@ automatic newline is performed. At the bottom of the scrolling region, if \fBscrollok\fR is enabled, the scrolling region is scrolled up one line. .sp .LP -If \fIwch\fR is a tab, newline, or backspace, the cursor is moved -appropriately within the window. A newline also does a \fBclrtoeol\fR(3CURSES) -before moving. Tabs are considered to be at every eighth column. If \fIwch\fR +If \fIwch\fR is a tab, newline, or backspace, the cursor is moved +appropriately within the window. A newline also does a \fBclrtoeol\fR(3CURSES) +before moving. Tabs are considered to be at every eighth column. If \fIwch\fR is another control character, it is drawn in the \fB^\fR\fIX\fR notation. -Calling \fBwinwch\fR(3CURSES) after adding a control character does not return +Calling \fBwinwch\fR(3CURSES) after adding a control character does not return the control character, but instead returns the representation of the control character. .sp .LP -Video attributes can be combined with a \fBwchar_t\fR character by OR-ing them +Video attributes can be combined with a \fBwchar_t\fR character by OR-ing them into the parameter. This results in these attributes also being set. (The intent here is that text, including attributes, can be copied from one place to -another using \fBinwch()\fR and \fBaddwch()\fR.) See +another using \fBinwch()\fR and \fBaddwch()\fR.) See \fBstandout\fR(3CURSES), predefined video attribute constants. .sp .LP -The \fBechowchar()\fR and \fBwechowchar()\fR routines are functionally -equivalent to a call to \fBaddwch()\fR followed by a call to -\fBrefresh\fR(3CURSES), or a call to \fBwaddwch()\fR followed by a call to +The \fBechowchar()\fR and \fBwechowchar()\fR routines are functionally +equivalent to a call to \fBaddwch()\fR followed by a call to +\fBrefresh\fR(3CURSES), or a call to \fBwaddwch()\fR followed by a call to \fBwrefresh\fR(3CURSES). The knowledge that only a single character is being output is taken into consideration and, for non-control characters, a considerable performance gain might be seen by using these routines instead of their equivalents. .SS "Line Graphics" -.sp -.LP The following variables may be used to add line drawing characters to the -screen with routines of the \fBaddwch()\fR family. When variables are defined +screen with routines of the \fBaddwch()\fR family. When variables are defined for the terminal, the \fBA_ALTCHARSET\fR bit is turned on. (See \fBcurs_attr\fR(3CURSES)). Otherwise, the default character listed below is stored in the variable. The names chosen are consistent with the VT100 @@ -151,14 +146,10 @@ ACS_BLOCK # solid square block .TE .SH RETURN VALUE -.sp -.LP All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion, unless otherwise noted in the preceding routine descriptions. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -173,20 +164,16 @@ MT-Level Unsafe .TE .SH SEE ALSO -.sp -.LP \fBputwchar\fR(3C), \fBclrtoeol\fR(3CURSES), \fBcurses\fR(3CURSES), \fBcurs_attr\fR(3CURSES), \fBcurs_inwch\fR(3CURSES), \fBcurs_outopts\fR(3CURSES), \fBrefresh\fR(3CURSES), \fBstandout\fR(3CURSES), \fBwinwch\fR(3CURSES), \fBwrefresh\fR(3CURSES), \fBattributes\fR(5) .SH NOTES -.sp -.LP The header file <\fBcurses.h\fR> automatically includes the header files <\fBstdio.h\fR>, <\fBunctrl.h\fR> and <\fBwidec.h\fR>. .sp .LP -Note that \fBaddwch()\fR,\fB mvaddwch()\fR, \fBmvwaddwch()\fR, and +Note that \fBaddwch()\fR,\fB mvaddwch()\fR, \fBmvwaddwch()\fR, and \fBechowchar()\fR may be macros. .sp .LP diff --git a/usr/src/man/man3curses/curs_addwchstr.3curses b/usr/src/man/man3curses/curs_addwchstr.3curses index 6eb3406248..66c9e25a79 100644 --- a/usr/src/man/man3curses/curs_addwchstr.3curses +++ b/usr/src/man/man3curses/curs_addwchstr.3curses @@ -4,20 +4,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 CURS_ADDWCHSTR 3CURSES "Dec 31, 1996" +.TH CURS_ADDWCHSTR 3CURSES "June 18, 2021" .SH NAME curs_addwchstr, addwchstr, addwchnstr, waddwchstr, waddwchnstr, mvaddwchstr, mvaddwchnstr, mvwaddwchstr, mvwaddwchnstr \- add string of wchar_t characters (and attributes) to a curses window .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR]... \fIfile\fR... \fB-lcurses\fR [\fIlibrary\fR]... .fi .LP .nf -#include<curses.h> +#include <curses.h> \fBint\fR \fBaddwchstr\fR(\fBchtype *\fR\fIwchstr\fR); .fi @@ -58,31 +57,25 @@ mvaddwchnstr, mvwaddwchstr, mvwaddwchnstr \- add string of wchar_t characters .fi .SH DESCRIPTION -.sp -.LP All of these routines copy \fIwchstr\fR, which points to a string of \fBwchar_t\fR characters, directly into the window image structure starting at -the current cursor position. The four routines with \fIn\fR as the last +the current cursor position. The four routines with \fIn\fR as the last argument copy at most \fIn\fR elements, but no more than will fit on the line. If \fIn\fR=\fB\(mi1\fR then the whole string is copied, to the maximum number that fit on the line. .sp .LP The position of the window cursor is not advanced. These routines work faster -than \fBwaddnwstr\fR(3CURSES) because they merely copy \fIwchstr\fR into the +than \fBwaddnwstr\fR(3CURSES) because they merely copy \fIwchstr\fR into the window image structure. On the other hand, care must be taken when using these functions because they don't perform any kind of checking (such as for the newline character), they do not advance the current cursor position, and they truncate the string, rather than wrapping it around to the new line. .SH RETURN VALUE -.sp -.LP All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion, unless otherwise noted in the preceding routine descriptions. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -97,17 +90,13 @@ MT-Level Unsafe .TE .SH SEE ALSO -.sp -.LP \fBcurses\fR(3CURSES), \fBwaddnwstr\fR(3CURSES), \fBattributes\fR(5) .SH NOTES -.sp -.LP The header file <\fBcurses.h\fR> automatically includes the header files <\fBstdio.h\fR>, <\fBunctrl.h\fR> and <\fBwidec.h\fR>. .sp .LP -Note that all routines except \fBwaddwchnstr()\fR may be macros. +Note that all routines except \fBwaddwchnstr()\fR may be macros. .sp .LP None of these routines can use the color attribute in \fBchtype\fR. diff --git a/usr/src/man/man3curses/curs_addwstr.3curses b/usr/src/man/man3curses/curs_addwstr.3curses index ea526df229..f2ce50d27d 100644 --- a/usr/src/man/man3curses/curs_addwstr.3curses +++ b/usr/src/man/man3curses/curs_addwstr.3curses @@ -4,20 +4,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 CURS_ADDWSTR 3CURSES "Dec 31, 1996" +.TH CURS_ADDWSTR 3CURSES "June 18, 2021" .SH NAME curs_addwstr, addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr, mvwaddwstr, mvwaddnwstr \- add a string of wchar_t characters to a curses window and advance cursor .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR]... \fIfile\fR... \fB-lcurses\fR [\fIlibrary\fR]... .fi .LP .nf -#include<curses.h> +#include <curses.h> \fBint\fR \fBaddwstr\fR(\fBwchar_t *\fR\fIwstr\fR); .fi @@ -58,22 +57,16 @@ window and advance cursor .fi .SH DESCRIPTION -.sp -.LP All of these routines write all the characters of the null-terminated -\fBwchar_t\fR character string \fBwstr\fR on the given window. The effect is -similar to calling \fBwaddwch\fR(3CURSES) once for each \fBwchar_t\fR +\fBwchar_t\fR character string \fBwstr\fR on the given window. The effect is +similar to calling \fBwaddwch\fR(3CURSES) once for each \fBwchar_t\fR character in the string. The four routines with \fIn\fR as the last argument write at most \fIn\fR \fBwchar_t\fR characters. If \fIn\fR is negative, then the entire string will be added. .SH RETURN VALUE -.sp -.LP All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -88,15 +81,11 @@ MT-Level Unsafe .TE .SH SEE ALSO -.sp -.LP \fBcurses\fR(3CURSES), \fBwaddwch\fR(3CURSES), \fBattributes\fR(5) .SH NOTES -.sp -.LP -The header file <\fBcurses.h\fR> automatically includes the header files +The header file <\fBcurses.h\fR> automatically includes the header files <\fBstdio.h\fR>, <\fBnctrl.h\fR> and <\fBwidec.h\fR>. .sp .LP -Note that all of these routines except \fBwaddwstr()\fR and \fBwaddnwstr()\fR +Note that all of these routines except \fBwaddwstr()\fR and \fBwaddnwstr()\fR may be macros. diff --git a/usr/src/man/man3ext/NOTE.3ext b/usr/src/man/man3ext/NOTE.3ext index f858dd9d19..acf8c8234b 100644 --- a/usr/src/man/man3ext/NOTE.3ext +++ b/usr/src/man/man3ext/NOTE.3ext @@ -3,11 +3,10 @@ .\" 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 NOTE 3EXT "Dec 31, 1996" +.TH NOTE 3EXT "June 18, 2021" .SH NAME NOTE, _NOTE \- annotate source code with info for tools .SH SYNOPSIS -.LP .nf #include <note.h> @@ -19,7 +18,7 @@ NOTE, _NOTE \- annotate source code with info for tools .LP .nf or -#include<sys/note.h> +#include <sys/note.h> @@ -27,8 +26,6 @@ or .fi .SH DESCRIPTION -.sp -.LP These macros are used to embed information for tools in program source. A use of one of these macros is called an "annotation". A tool may define a set of such annotations which can then be used to provide the tool with information @@ -101,8 +98,6 @@ particular type of annotation may only be allowed in a subset of those places. For example, a particular annotation may not be allowed inside a \fBstruct\fR or \fBunion\fR definition. .SS "NOTE vs _NOTE" -.sp -.LP Ordinarily, \fBNOTE\fR should be used rather than \fB_NOTE\fR, since use of \fB_NOTE\fR technically makes a program non-portable. However, it may be inconvenient to use \fBNOTE\fR for this purpose in existing code if \fBNOTE\fR @@ -127,8 +122,6 @@ Public header files which span projects should use \fB_NOTE\fR rather than \fBNOTE\fR, since \fBNOTE\fR may already be used by a program which needs to include such a header file. .SS "\fINoteInfo\fR\fB Argument\fR" -.sp -.LP The actual \fINoteInfo\fR used in an annotation should be specified by a tool that deals with program source (see the documentation for the tool to determine which annotations, if any, it understands). @@ -152,8 +145,6 @@ be compatible with an ANSI C tokenizer and that unquoted parentheses be balanced (so that the end of the annotation can be determined without intimate knowledge of any particular annotation). .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -168,6 +159,4 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBnote\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man3gen/bgets.3gen b/usr/src/man/man3gen/bgets.3gen index 9eb4f4b471..81a3f8f368 100644 --- a/usr/src/man/man3gen/bgets.3gen +++ b/usr/src/man/man3gen/bgets.3gen @@ -3,11 +3,10 @@ .\" 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 BGETS 3GEN "May 9, 2001" +.TH BGETS 3GEN "June 18, 2021" .SH NAME bgets \- read stream up to next delimiter .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ] #include <libgen.h> @@ -17,14 +16,12 @@ cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ] .fi .SH DESCRIPTION -.sp -.LP The \fBbgets()\fR function reads characters from \fIstream\fR into \fIbuffer\fR until either \fIcount\fR is exhausted or one of the characters in \fIbreakstring\fR is encountered in the stream. The read data is terminated with a null byte ('\fB\e0\fR\&') and a pointer to the trailing null is returned. If a \fIbreakstring\fR character is encountered, the last non-null is -the delimiter character that terminated the scan. +the delimiter character that terminated the scan. .sp .LP Note that, except for the fact that the returned value points to the \fBend\fR @@ -56,12 +53,9 @@ If \fIbreakstring\fR is a null pointer, the value of \fIbreakstring\fR from the previous call is used. If \fIbreakstring\fR is null at the first call, no characters will be used to delimit the string. .SH RETURN VALUES -.sp -.LP \fINULL\fR is returned on error or end-of-file. Reporting the condition is -delayed to the next call if any characters were read but not yet returned. +delayed to the next call if any characters were read but not yet returned. .SH EXAMPLES -.LP \fBExample 1 \fRExample of the \fBbgets()\fR function. .sp .LP @@ -72,7 +66,7 @@ The following example prints the name of the first user encountered in .in +2 .nf #include <stdio.h> -#include<libgen.h> +#include <libgen.h> int main() { @@ -94,8 +88,6 @@ int main() .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -110,12 +102,8 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBgets\fR(3C), \fBattributes\fR(5) .SH NOTES -.sp -.LP When compiling multithread applications, the \fB_REENTRANT\fR flag must be defined on the compile line. This flag should only be used in multithreaded applications. diff --git a/usr/src/man/man3gen/isencrypt.3gen b/usr/src/man/man3gen/isencrypt.3gen index dd95f4ddff..144acf38fb 100644 --- a/usr/src/man/man3gen/isencrypt.3gen +++ b/usr/src/man/man3gen/isencrypt.3gen @@ -3,25 +3,22 @@ .\" 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 ISENCRYPT 3GEN "Dec 29, 1996" +.TH ISENCRYPT 3GEN "June 18, 2021" .SH NAME isencrypt \- determine whether a buffer of characters is encrypted .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR]... [\fIfile\fR]... \fB-lgen\fR [\fIlibrary\fR]... .fi .LP .nf -#include<libgen.h> +#include <libgen.h> \fBint\fR \fBisencrypt\fR(\fBconst char *\fR\fIfbuf\fR, \fBsize_t\fR \fIninbuf\fR); .fi .SH DESCRIPTION -.sp -.LP \fBisencrypt()\fR uses heuristics to determine whether a buffer of characters is encrypted. It requires two arguments: a pointer to an array of characters and the number of characters in the buffer. @@ -40,15 +37,11 @@ determine if the buffer is encrypted. If \fIninbuf\fR has at least 64 characters, a chi-square test is used to determine if the bytes in the buffer have a uniform distribution; if it does, then \fBisencrypt()\fR assumes the buffer is encrypted. If the buffer has less than 64 characters, a check is -made for null characters and a terminating new-line to determine whether the +made for null characters and a terminating new-line to determine whether the buffer is encrypted. .SH RETURN VALUES -.sp -.LP -If the buffer is encrypted, \fB1\fR is returned; otherwise, zero is returned. +If the buffer is encrypted, \fB1\fR is returned; otherwise, zero is returned. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -63,12 +56,8 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBsetlocale\fR(3C), \fBattributes\fR(5) .SH NOTES -.sp -.LP When compiling multithreaded applications, the \fB_REENTRANT\fR flag must be defined on the compile line. This flag should only be used in multithreaded applications. diff --git a/usr/src/man/man3gen/regexpr.3gen b/usr/src/man/man3gen/regexpr.3gen index ba5a2e3f6d..1e348b6173 100644 --- a/usr/src/man/man3gen/regexpr.3gen +++ b/usr/src/man/man3gen/regexpr.3gen @@ -3,12 +3,11 @@ .\" 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 REGEXPR 3GEN "Dec 29, 1996" +.TH REGEXPR 3GEN "June 18, 2021" .SH NAME regexpr, compile, step, advance \- regular expression compile and match routines .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR]... [\fIfile\fR]... \fB-lgen\fR [\fIlibrary\fR]... .fi @@ -48,8 +47,6 @@ routines .fi .SH DESCRIPTION -.sp -.LP These routines are used to compile regular expressions and match the compiled expressions against lines. The regular expressions compiled are in the form used by \fBed\fR(1). @@ -74,7 +71,7 @@ compiled regular expression may be placed. This argument is ignored if \fBregerrno\fR (see below) is set to 50. .sp .LP -The parameter \fIstring\fR is a pointer to a string of characters to be +The parameter \fIstring\fR is a pointer to a string of characters to be checked for a match. This string should be null-terminated. .sp .LP @@ -85,7 +82,7 @@ call of the function \fBcompile()\fR. The function \fBstep()\fR returns non-zero if the given string matches the regular expression, and zero if the expressions do not match. If there is a match, two external character pointers are set as a side effect to the call to -\fBstep()\fR. The variables set in \fBstep()\fR are \fIloc1\fR and \fIloc2\fR. +\fBstep()\fR. The variables set in \fBstep()\fR are \fIloc1\fR and \fIloc2\fR. \fIloc1\fR is a pointer to the first character that matched the regular expression. The variable \fIloc2\fR points to the character after the last character that matches the regular expression. Thus if the regular expression @@ -99,8 +96,8 @@ expression begins with \fB^\fR, \fBstep()\fR tries to match the regular expression at the beginning of the string only. .sp .LP -The \fBadvance()\fR function is similar to \fBstep()\fR; but, it only sets the -variable \fIloc2\fR and always restricts matches to the beginning of the +The \fBadvance()\fR function is similar to \fBstep()\fR; but, it only sets the +variable \fIloc2\fR and always restricts matches to the beginning of the string. .sp .LP @@ -114,11 +111,11 @@ loop forever, and is \fINULL\fR by default. The external variable \fBnbra\fR is used to determine the number of subexpressions in the compiled regular expression. \fBbraslist\fR and \fBbraelist\fR are arrays of character pointers that point to the start and end -of the \fBnbra\fR subexpressions in the matched string. For example, after +of the \fBnbra\fR subexpressions in the matched string. For example, after calling \fBstep()\fR or \fBadvance()\fR with string \fBsabcdefg\fR and regular -expression \fB\e(abcdef\e)\fR, \fBbraslist[0]\fR will point at \fBa\fR and +expression \fB\e(abcdef\e)\fR, \fBbraslist[0]\fR will point at \fBa\fR and \fBbraelist[0]\fR will point at \fBg\fR. These arrays are used by commands like -\fBed\fR and \fBsed\fR for substitute replacement patterns that contain the +\fBed\fR and \fBsed\fR for substitute replacement patterns that contain the \fB\e\fR\fIn\fR notation for subexpressions. .sp .LP @@ -127,13 +124,12 @@ Note that it is not necessary to use the external variables \fBregerrno\fR, \fBbraslist\fR if one is only checking whether or not a string matches a regular expression. .SH EXAMPLES -.LP \fBExample 1 \fRThe following is similar to the regular expression code from \fBgrep\fR: .sp .in +2 .nf -#include<regexpr.h> +#include <regexpr.h> \&... if(compile(*argv, (char *)0, (char *)0) == (char *)0) regerr(regerrno); @@ -144,12 +140,10 @@ if (step(linebuf, expbuf)) .in -2 .SH RETURN VALUES -.sp -.LP If \fBcompile()\fR succeeds, it returns a non-\fINULL\fR pointer whose value depends on \fIexpbuf\fR. If \fIexpbuf\fR is non-\fINULL\fR, \fBcompile()\fR -returns a pointer to the byte after the last byte in the compiled regular -expression. The length of the compiled regular expression is stored in +returns a pointer to the byte after the last byte in the compiled regular +expression. The length of the compiled regular expression is stored in \fBreglength\fR. Otherwise, \fBcompile()\fR returns a pointer to the space allocated by \fBmalloc\fR(3C). .sp @@ -158,8 +152,6 @@ The functions \fBstep()\fR and \fBadvance()\fR return non-zero if the given string matches the regular expression, and zero if the expressions do not match. .SH ERRORS -.sp -.LP If an error is detected when compiling the regular expression, a \fINULL\fR pointer is returned from \fBcompile()\fR and \fBregerrno\fR is set to one of the non-zero error numbers indicated below: @@ -181,12 +173,10 @@ ERROR MEANING 45 } expected after \e. 46 First number exceeds second in \e{~\e}. 49 [] imbalance. -50 Regular expression overflow. +50 Regular expression overflow. .TE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -201,13 +191,9 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBed\fR(1), \fBgrep\fR(1), \fBsed\fR(1), \fBmalloc\fR(3C), \fBattributes\fR(5), \fBregexp\fR(5) .SH NOTES -.sp -.LP When compiling multi-threaded applications, the \fB_REENTRANT\fR flag must be defined on the compile line. This flag should only be used in multi-threaded applications. diff --git a/usr/src/man/man3gss/gss_release_name.3gss b/usr/src/man/man3gss/gss_release_name.3gss index 8590e7dfde..0693caed06 100644 --- a/usr/src/man/man3gss/gss_release_name.3gss +++ b/usr/src/man/man3gss/gss_release_name.3gss @@ -3,27 +3,22 @@ .\" 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 GSS_RELEASE_NAME 3GSS "Jan 15, 2003" +.TH GSS_RELEASE_NAME 3GSS "June 18, 2021" .SH NAME gss_release_name \- discard an internal-form name .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR] -#include <gssapi/gssapi.h +#include <gssapi/gssapi.h> \fBOM_uint32\fR \fBgss_release_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBgss_name_t *\fR\fIname\fR); .fi .SH DESCRIPTION -.sp -.LP The \fBgss_release_name()\fR function frees \fBGSS-API\fR-allocated storage associated with an internal-form name. The \fIname\fR is set to \fBGSS_C_NO_NAME\fR on successful completion of this call. .SH PARAMETERS -.sp -.LP The parameter descriptions for \fBgss_release_name()\fR follow: .sp .ne 2 @@ -44,8 +39,6 @@ The name to be deleted. .RE .SH ERRORS -.sp -.LP The \fBgss_release_name()\fR function may return the following status codes: .sp .ne 2 @@ -77,8 +70,6 @@ of the \fIminor_status\fR parameter details the error condition. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -93,8 +84,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3lib/libtsol.3lib b/usr/src/man/man3lib/libtsol.3lib index 119e57212e..072b52d2ae 100644 --- a/usr/src/man/man3lib/libtsol.3lib +++ b/usr/src/man/man3lib/libtsol.3lib @@ -1,26 +1,23 @@ '\" te -.\" Copyright (c) 2017 Peter Tribble. +.\" Copyright (c) 2021 Peter Tribble. .\" Copyright (c) 2007, Sun Microsystems, Inc. All rights reserved. .\" 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 LIBTSOL 3LIB "Dec 3, 2017" +.TH LIBTSOL 3LIB "June 19, 2021" .SH NAME libtsol \- Solaris Trusted Extensions library .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...] -#include <tsol.h> +#include <tsol/label.h> .fi .SH DESCRIPTION -.LP Functions in this library provide programmatic access to Solaris Trusted Extensions features such as labels and Mandatory Access Policy (MAC) on systems that are configured with Trusted Extensions software. .SH INTERFACES -.LP The shared object \fBlibtsol.so.2\fR provides the public interfaces that are defined below. See \fBIntro\fR(3) for additional information on shared object interfaces. @@ -42,7 +39,6 @@ l l . .TE .SS "Obsolete Functions" -.LP The following functions are preserved to aid porting. .sp @@ -88,7 +84,6 @@ shared object .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -107,9 +102,7 @@ MT-Level Safe .TE .SH SEE ALSO -.LP \fBIntro\fR(3), \fBlibtsnet\fR(3LIB), \fBattributes\fR(5) .SH NOTES -.LP The functionality described on this manual page is available only if the system has been configured with Trusted Extensions. diff --git a/usr/src/man/man3malloc/umem_cache_create.3malloc b/usr/src/man/man3malloc/umem_cache_create.3malloc index 03668b4096..4d64b744b3 100644 --- a/usr/src/man/man3malloc/umem_cache_create.3malloc +++ b/usr/src/man/man3malloc/umem_cache_create.3malloc @@ -3,12 +3,11 @@ .\" 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 UMEM_CACHE_CREATE 3MALLOC "Mar 24, 2008" +.TH UMEM_CACHE_CREATE 3MALLOC "June 18, 2021" .SH NAME umem_cache_create, umem_cache_destroy, umem_cache_alloc, umem_cache_free \- allocation cache manipulation .SH SYNOPSIS -.LP .nf cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lumem\fR [ \fIlibrary \&.\|.\|.\fR ] #include <umem.h> @@ -35,9 +34,7 @@ cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lumem\fR [ \fIlibrary \&.\|. .fi .SH DESCRIPTION -.sp -.LP -These functions create, destroy, and use an "object cache" An object cache is +These functions create, destroy, and use an "object cache". An object cache is a collection of buffers of a single size, with optional content caching enabled by the use of callbacks (see \fBCache Callbacks\fR). Object caches are MT-Safe. Multiple allocations and freeing of memory from different threads can @@ -53,8 +50,6 @@ been created, objects can be requested from and returned to the cache using \fBumem_cache_alloc()\fR and \fBumem_cache_free()\fR, respectively. A cache with no outstanding buffers can be destroyed with \fBumem_cache_destroy()\fR. .SS "Creating and Destroying Caches" -.sp -.LP The \fBumem_cache_create()\fR function creates a cache of objects and takes as arguments the following: .sp @@ -185,8 +180,6 @@ support. The \fBumem_cache_destroy()\fR function destroys an object cache. If the cache has any outstanding allocations, the behavior is undefined. .SS "Allocating Objects" -.sp -.LP The \fBumem_cache_alloc()\fR function takes as arguments: .sp .ne 2 @@ -262,8 +255,6 @@ information. .RE .SS "Freeing Objects" -.sp -.LP The \fBumem_cache_free()\fR function takes as arguments: .sp .ne 2 @@ -294,20 +285,14 @@ Undefined behavior results if an object is freed multiple times, if an object is modified after it is freed, or if an object is freed to a cache other than the one from which it was allocated. .SS "Caches with Constructors" -.sp -.LP When a constructor callback is in use, there is essentially a contract between the cache and its clients. The cache guarantees that all objects returned from \fBumem_cache_alloc()\fR will be in the constructed state, and the client guarantees that it will return the object to the constructed state before handing it to \fBumem_cache_free()\fR. .SH RETURN VALUES -.sp -.LP Upon failure, the \fBumem_cache_create()\fR function returns a null pointer. .SH ERRORS -.sp -.LP The \fBumem_cache_create()\fR function will fail if: .sp .ne 2 @@ -340,7 +325,6 @@ argument is too large and its use would cause integer overflow to occur. .RE .SH EXAMPLES -.LP \fBExample 1 \fRUse a fixed-size structure with no constructor callback. .sp .in +2 @@ -489,8 +473,8 @@ umem_cache_free(my_obj_cache, cur); .sp .in +2 .nf -#include assert.h> -#include umem.h> +#include <assert.h> +#include <umem.h> typedef struct my_obj { char *my_buffer; @@ -558,8 +542,6 @@ umem_cache_free(my_obj_8k_cache, my_obj_8k); See the \fBEXAMPLES\fR section of \fBumem_alloc\fR(3MALLOC) for examples involving the \fBUMEM_NOFAIL\fR flag. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -576,8 +558,6 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBsetcontext\fR(2), \fBatexit\fR(3C), \fBlibumem\fR(3LIB), \fBlongjmp\fR(3C), \fBswapcontext\fR(3C), \fBthr_exit\fR(3C), \fBumem_alloc\fR(3MALLOC), \fBumem_debug\fR(3MALLOC), \fBattributes\fR(5) @@ -591,8 +571,6 @@ Bonwick, Jeff and Jonathan Adams, "Magazines and vmem: Extending the Slab Allocator to Many CPUs and Arbitrary Resources", Proceedings of the Summer 2001 Usenix Conference. .SH WARNINGS -.sp -.LP Any of the following can cause undefined results: .RS +4 .TP @@ -651,8 +629,6 @@ Any allocations made with a different flags argument results in undefined behavior. The constructor must correctly handle the failure of any allocations it makes. .SH NOTES -.sp -.LP Object caches make the following guarantees about objects: .RS +4 .TP diff --git a/usr/src/man/man3nsl/gethostbyname.3nsl b/usr/src/man/man3nsl/gethostbyname.3nsl index 925f3ebb85..2468a6696b 100644 --- a/usr/src/man/man3nsl/gethostbyname.3nsl +++ b/usr/src/man/man3nsl/gethostbyname.3nsl @@ -44,12 +44,11 @@ .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH GETHOSTBYNAME 3NSL "Sep 10, 2013" +.TH GETHOSTBYNAME 3NSL "June 18, 2021" .SH NAME gethostbyname, gethostbyname_r, gethostbyaddr, gethostbyaddr_r, gethostent, gethostent_r, sethostent, endhostent \- get network host entry .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lnsl\fR [ \fIlibrary\fR... ] #include <netdb.h> @@ -99,7 +98,6 @@ gethostent_r, sethostent, endhostent \- get network host entry .fi .SH DESCRIPTION -.LP These functions are used to obtain entries describing hosts. An entry can come from any of the sources for \fBhosts\fR specified in the \fB/etc/nsswitch.conf\fR file. See \fBnsswitch.conf\fR(4). These functions have @@ -150,7 +148,6 @@ deallocate resources it was using. It is still allowed, but possibly less efficient, for the process to call more host retrieval functions after calling \fBendhostent()\fR. .SS "Reentrant Interfaces" -.LP The \fBgethostbyname()\fR, \fBgethostbyaddr()\fR, and \fBgethostent()\fR functions use static storage that is reused in each call, making these functions unsafe for use in multithreaded applications. @@ -194,7 +191,6 @@ Like their non-reentrant counterparts, \fBgethostbyname_r()\fR and \fBgethostbyaddr_r()\fR leave the enumeration position in an indeterminate state. .SH RETURN VALUES -.LP Host entries are represented by the \fBstruct hostent\fR structure defined in \fB<netdb.h>\fR: .sp @@ -241,7 +237,6 @@ always equal to the \fIresult\fR pointer that was supplied by the caller. The \fBsethostent()\fR and \fBendhostent()\fR functions return \fB0\fR on success. .SH ERRORS -.LP The reentrant functions \fBgethostbyname_r()\fR, \fBgethostbyaddr_r()\fR, and \fBgethostent_r()\fR will return \fINULL\fR and set \fIerrno\fR to \fBERANGE\fR if the length of the buffer supplied by caller is not large enough to store the @@ -268,7 +263,6 @@ returns an internal error with a value of \(mi1. The \fBgethostbyname()\fR function will set \fIh_errno\fR to \fBNETDB_INTERNAL\fR when it returns a \fINULL\fR value. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBgethostbyaddr()\fR .sp .LP @@ -280,7 +274,7 @@ address: .in +2 .nf #include <stdio.h> -#include <stdlib.h +#include <stdlib.h> #include <string.h> #include <sys/types.h> #include <sys/socket.h> @@ -353,7 +347,6 @@ configuration file for the name service switch .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -370,17 +363,14 @@ T} .TE .SH SEE ALSO -.LP \fBIntro\fR(2), \fBIntro\fR(3), \fBbyteorder\fR(3C), \fBinet\fR(3SOCKET), \fBnetdb.h\fR(3HEAD), \fBnetdir\fR(3NSL), \fBhosts\fR(4), \fBnetconfig\fR(4), \fBnss\fR(4), \fBnsswitch.conf\fR(4), \fBattributes\fR(5) .SH WARNINGS -.LP The reentrant interfaces \fBgethostbyname_r()\fR, \fBgethostbyaddr_r()\fR, and \fBgethostent_r()\fR are included in this release on an uncommitted basis only and are subject to change or removal in future minor releases. .SH NOTES -.LP To ensure that they all return consistent results, \fBgethostbyname()\fR, \fBgethostbyname_r()\fR, and \fBnetdir_getbyname()\fR are implemented in terms of the same internal library function. This function obtains the system-wide diff --git a/usr/src/man/man3nsl/t_rcvconnect.3nsl b/usr/src/man/man3nsl/t_rcvconnect.3nsl index f6a2b96cb5..ed1f1a48cf 100644 --- a/usr/src/man/man3nsl/t_rcvconnect.3nsl +++ b/usr/src/man/man3nsl/t_rcvconnect.3nsl @@ -44,11 +44,10 @@ .\" Copyright 1994, The X/Open Company Ltd. All Rights Reserved. .\" Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH T_RCVCONNECT 3NSL "May 7, 1998" +.TH T_RCVCONNECT 3NSL "June 18, 2021" .SH NAME t_rcvconnect \- receive the confirmation from a connection request .SH SYNOPSIS -.LP .nf #include <xti.h> @@ -58,13 +57,11 @@ t_rcvconnect \- receive the confirmation from a connection request .fi .SH DESCRIPTION -.sp -.LP This routine is part of the \fBXTI\fR interfaces which evolved from the \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the -\fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR +\fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR \fBCOMPATIBILITY\fR section for a description of differences between the two interfaces. .sp @@ -72,7 +69,7 @@ interfaces. This function enables a calling transport user to determine the status of a previously sent connection request and is used in conjunction with \fBt_connect\fR(3NSL) to establish a connection in asynchronous mode, and to -complete a synchronous \fBt_connect\fR(3NSL) call that was interrupted by a +complete a synchronous \fBt_connect\fR(3NSL) call that was interrupted by a signal. The connection will be established on successful completion of this function. .sp @@ -103,14 +100,14 @@ by the destination transport user during connection establishment, and The \fImaxlen\fR field of each argument must be set before issuing this function to indicate the maximum size of the buffer for each. However, \fImaxlen\fR can be set to zero, in which case no information to this specific -argument is given to the user on the return from \fBt_rcvconnect()\fR. If -\fIcall\fR is set to \fINULL,\fR no information at all is returned. By +argument is given to the user on the return from \fBt_rcvconnect()\fR. If +\fIcall\fR is set to \fINULL,\fR no information at all is returned. By default, \fBt_rcvconnect()\fR executes in synchronous mode and waits for the connection to be established before returning. On return, the \fIaddr\fR, \fIopt\fR and \fIudata\fR fields reflect values associated with the connection. .sp .LP -If \fBO_NONBLOCK\fR is set by means of \fBt_open\fR(3NSL) or \fBfcntl\fR(2), +If \fBO_NONBLOCK\fR is set by means of \fBt_open\fR(3NSL) or \fBfcntl\fR(2), \fBt_rcvconnect()\fR executes in asynchronous mode, and reduces to a poll for existing connection confirmations. If none are available, \fBt_rcvconnect()\fR fails and returns immediately without waiting for the connection to be @@ -118,17 +115,11 @@ established. See \fBTNODATA\fR below. In this case, \fBt_rcvconnect()\fR must be called again to complete the connection establishment phase and retrieve the information returned in \fIcall\fR. .SH RETURN VALUES -.sp -.LP -Upon successful completion, a value of \fB0\fR is returned. Otherwise, a -value of -1 is returned and \fBt_errno\fR is set to indicate an error. +Upon successful completion, a value of \fB0\fR is returned. Otherwise, a +value of -1 is returned and \fBt_errno\fR is set to indicate an error. .SH VALID STATES -.sp -.LP \fBT_OUTCON\fR. .SH ERRORS -.sp -.LP On failure, \fBt_errno\fR is set to one of the following: .sp .ne 2 @@ -146,7 +137,7 @@ The specified file descriptor does not refer to a transport endpoint. .ad .RS 15n The number of bytes allocated for an incoming argument \fI(maxlen)\fR is -greater than \fB0\fR but not sufficient to store the value of that argument, +greater than \fB0\fR but not sufficient to store the value of that argument, and the connection information to be returned in \fIcall\fR will be discarded. The provider's state, as seen by the user, will be changed to \fBT_DATAXFER.\fR @@ -186,7 +177,7 @@ This function is not supported by the underlying transport provider. \fB\fBTOUTSTATE\fR\fR .ad .RS 15n -The communications endpoint referenced by \fIfd\fR is not in one of the states +The communications endpoint referenced by \fIfd\fR is not in one of the states in which a call to this function is valid. .RE @@ -211,23 +202,17 @@ A system error has occurred during execution of this function. .RE .SH TLI COMPATIBILITY -.sp -.LP The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use different header files. This, and other semantic differences between the two interfaces are described in the subsections below. .SS "Interface Header" -.sp -.LP The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces should \fInot\fR use this header. They should use the header: .br .in +2 -#include<tiuser.h> +#include <tiuser.h> .in -2 .SS "Error Description Values" -.sp -.LP The \fBt_errno\fR value \fBTPROTO\fR can be set by the \fBXTI\fR interface but not by the \fBTLI\fR interface. .sp @@ -237,9 +222,7 @@ circumstances than its \fBXTI\fR counterpart is \fBTBUFOVFLW\fR. It can be returned even when the \fBmaxlen\fR field of the corresponding buffer has been set to zero. .SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: +See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp @@ -253,8 +236,6 @@ MT Level Safe .TE .SH SEE ALSO -.sp -.LP \fBfcntl\fR(2), \fBt_accept\fR(3NSL), \fBt_alloc\fR(3NSL), \fBt_bind\fR(3NSL), \fBt_connect\fR(3NSL), \fBt_listen\fR(3NSL), \fBt_open\fR(3NSL), \fBt_optmgmt\fR(3NSL), \fBattributes\fR(5) diff --git a/usr/src/man/man3nsl/t_rcvrel.3nsl b/usr/src/man/man3nsl/t_rcvrel.3nsl index 5589c63be7..6fd0601f17 100644 --- a/usr/src/man/man3nsl/t_rcvrel.3nsl +++ b/usr/src/man/man3nsl/t_rcvrel.3nsl @@ -44,11 +44,10 @@ .\" Copyright 1994, The X/Open Company Ltd. All Rights Reserved. .\" Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH T_RCVREL 3NSL "May 7, 1998" +.TH T_RCVREL 3NSL "June 18, 2021" .SH NAME t_rcvrel \- acknowledge receipt of an orderly release indication .SH SYNOPSIS -.LP .nf #include <xti.h> @@ -58,13 +57,11 @@ t_rcvrel \- acknowledge receipt of an orderly release indication .fi .SH DESCRIPTION -.sp -.LP This routine is part of the \fBXTI\fR interfaces which evolved from the \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the -\fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR +\fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR \fBCOMPATIBILITY\fR section for a description of differences between the two interfaces. .sp @@ -73,7 +70,7 @@ This function is used to receive an orderly release indication for the incoming direction of data transfer. The argument \fIfd\fR identifies the local transport endpoint where the connection exists. After receipt of this indication, the user may not attempt to receive more data by means of -\fBt_rcv\fR(3NSL) or \fBt_rcvv()\fR. Such an attempt will fail with +\fBt_rcv\fR(3NSL) or \fBt_rcvv()\fR. Such an attempt will fail with \fIt_error\fR set to \fBTOUTSTATE\fR. However, the user may continue to send data over the connection if \fBt_sndrel\fR(3NSL) has not been called by the user. This function is an optional service of the transport provider, and is @@ -82,17 +79,11 @@ on \fBt_open\fR(3NSL) or \fBt_getinfo\fR(3NSL). Any user data that may be associated with the orderly release indication is discarded when \fBt_rcvrel()\fR is called. .SH RETURN VALUES -.sp -.LP -Upon successful completion, a value of \fB0\fR is returned. Otherwise, a -value of -1 is returned and \fBt_errno\fR is set to indicate an error. +Upon successful completion, a value of \fB0\fR is returned. Otherwise, a +value of -1 is returned and \fBt_errno\fR is set to indicate an error. .SH VALID STATES -.sp -.LP \fBT_DATAXFER\fR, \fBT_OUTREL\fR. .SH ERRORS -.sp -.LP On failure, \fBt_errno\fR is set to one of the following: .sp .ne 2 @@ -138,7 +129,7 @@ This function is not supported by the underlying transport provider. \fB\fBTOUTSTATE\fR\fR .ad .RS 15n -The communications endpoint referenced by \fIfd\fR is not in one of the states +The communications endpoint referenced by \fIfd\fR is not in one of the states in which a call to this function is valid. .RE @@ -163,23 +154,17 @@ A system error has occurred during execution of this function. .RE .SH TLI COMPATIBILITY -.sp -.LP The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use different header files. This, and other semantic differences between the two interfaces are described in the subsections below. .SS "Interface Header" -.sp -.LP The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces should \fInot\fR use this header. They should use the header: .br .in +2 -#include<tiuser.h> +#include <tiuser.h> .in -2 .SS "Error Description Values" -.sp -.LP The \fBt_errno\fR values that can be set by the \fBXTI\fR interface and cannot be set by the \fBTLI\fR interface are: .br @@ -191,9 +176,7 @@ be set by the \fBTLI\fR interface are: \fBTOUTSTATE\fR .in -2 .SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: +See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp @@ -207,7 +190,5 @@ MT Level Safe .TE .SH SEE ALSO -.sp -.LP \fBt_getinfo\fR(3NSL), \fBt_open\fR(3NSL), \fBt_sndrel\fR(3NSL), \fBattributes\fR(5) diff --git a/usr/src/man/man3pool/pool_dynamic_location.3pool b/usr/src/man/man3pool/pool_dynamic_location.3pool index 99dc2e0852..996f06e078 100644 --- a/usr/src/man/man3pool/pool_dynamic_location.3pool +++ b/usr/src/man/man3pool/pool_dynamic_location.3pool @@ -3,12 +3,11 @@ .\" 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 POOL_DYNAMIC_LOCATION 3POOL "Sep 23, 2003" +.TH POOL_DYNAMIC_LOCATION 3POOL "June 18, 2021" .SH NAME pool_dynamic_location, pool_static_location, pool_version, pool_get_status, pool_set_status, pool_resource_type_list \- resource pool framework functions .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ] #include <pool.h> @@ -43,8 +42,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\| .fi .SH DESCRIPTION -.sp -.LP The \fBpool_dynamic_location()\fR function returns the location used by the pools framework to store the dynamic configuration. .sp @@ -81,8 +78,6 @@ maximum number of resource types the buffer can hold. On successful completion, the list of resource types up to the maximum buffer size is stored in the buffer pointed to by \fIreslist\fR. .SH RETURN VALUES -.sp -.LP The \fBpool_dynamic_location()\fR function returns the location used by the pools framework to store the dynamic configuration. .sp @@ -100,8 +95,6 @@ Upon successful completion, \fBpool_get_status()\fR, \fBpool_set_status()\fR, and \fBpool_resource_type_list()\fR all return 0. Otherwise, \(mi1 is returned and \fBpool_error\fR(3POOL) returns the pool specific error. .SH ERRORS -.sp -.LP No errors are defined for \fBpool_dynamic_location()\fR, \fBpool_static_location()\fR, and \fBpool_version()\fR. .sp @@ -141,12 +134,11 @@ The \fInumres\fR parameter was \fINULL\fR. .RE .SH EXAMPLES -.LP \fBExample 1 \fRGet the static location used by the pools framework. .sp .in +2 .nf -#include sys/types.h> +#include <sys/types.h> #include <unistd.h> #include <pool.h> @@ -181,8 +173,6 @@ const char *location = pool_dynamic_location(); .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -201,6 +191,4 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ufsdump.4 b/usr/src/man/man4/ufsdump.4 index e9073cb3bb..49d27c5fef 100644 --- a/usr/src/man/man4/ufsdump.4 +++ b/usr/src/man/man4/ufsdump.4 @@ -1,20 +1,9 @@ '\" te .\" Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.TH UFSDUMP 4 "Apr 9, 2003" +.TH UFSDUMP 4 "June 19, 2021" .SH NAME ufsdump, dumpdates \- incremental dump format .SH SYNOPSIS -.LP -.nf -\fB#include <sys/types.h>\fR -.fi - -.LP -.nf -\fB#include <sys/inode.h>\fR -.fi - -.LP .nf \fB#include <protocols/dumprestore.h>\fR .fi @@ -25,8 +14,6 @@ ufsdump, dumpdates \- incremental dump format .fi .SH DESCRIPTION -.sp -.LP Tapes used by \fBufsdump\fR(1M) and \fBufsrestore\fR(1M) contain: .RS +4 .TP @@ -735,8 +722,6 @@ The date of the incremental dump in the format generated by \fBctime\fR(3C). entry to \fB/etc/dumpdates\fR; \fBDUMPINFMT\fR is the format to use when using \fBscanf\fR(3C) to read an entry from \fB/etc/dumpdates\fR. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -751,7 +736,5 @@ Stability Level Unstable .TE .SH SEE ALSO -.sp -.LP \fBufsdump\fR(1M), \fBufsrestore\fR(1M), \fBctime\fR(3C), \fBprintf\fR(3C), \fBscanf\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), 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) diff --git a/usr/src/man/man7m/connld.7m b/usr/src/man/man7m/connld.7m index ea47583601..0dd38f1c0a 100644 --- a/usr/src/man/man7m/connld.7m +++ b/usr/src/man/man7m/connld.7m @@ -4,55 +4,45 @@ .\" 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 CONNLD 7M "May 3, 2004" +.TH CONNLD 7M "June 19, 2021" .SH NAME connld \- line discipline for unique stream connections .SH SYNOPSIS -.LP -.nf -\fB#include </sys/steam.h>\fR -.fi - -.LP .nf -\fBint ioctl(\fIfd\fR,I_PUSH,"connld");\fR +\fBint ioctl(\fIfd\fR, I_PUSH, "connld");\fR .fi .SH DESCRIPTION -.sp -.LP \fBconnld\fR is a STREAMS-based module that provides unique connections between -server and client processes. It can only be pushed (see \fBstreamio\fR(7I)) +server and client processes. It can only be pushed (see \fBstreamio\fR(7I)) onto one end of a STREAMS-based pipe that may subsequently be attached to a -name in the file system name space with \fBfattach\fR(3C). After the pipe end -is attached, a new pipe is created internally when an originating process -attempts to \fBopen\fR(2) or \fBcreat\fR(2) the file system name. A file +name in the file system name space with \fBfattach\fR(3C). After the pipe end +is attached, a new pipe is created internally when an originating process +attempts to \fBopen\fR(2) or \fBcreat\fR(2) the file system name. A file descriptor for one end of the new pipe is packaged into a message identical to -that for the ioctl \fBI_SENDFD\fR (see \fBstreamio\fR(7I)) and is transmitted -along the stream to the server process on the other end. The originating +that for the ioctl \fBI_SENDFD\fR (see \fBstreamio\fR(7I)) and is transmitted +along the stream to the server process on the other end. The originating process is blocked until the server responds. .sp .LP -The server responds to the \fBI_SENDFD\fR request by accepting the file -descriptor through the \fBI_RECVFD\fR ioctl message. When this happens, the +The server responds to the \fBI_SENDFD\fR request by accepting the file +descriptor through the \fBI_RECVFD\fR ioctl message. When this happens, the file descriptor associated with the other end of the new pipe is transmitted to -the originating process as the file descriptor returned from \fBopen\fR(2) or +the originating process as the file descriptor returned from \fBopen\fR(2) or \fBcreat\fR(2). .sp .LP -If the server does not respond to the \fBI_SENDFD\fR request, the stream that +If the server does not respond to the \fBI_SENDFD\fR request, the stream that the \fBconnld\fR module is pushed on becomes uni-directional because the server -will not be able to retrieve any data off the stream until the \fBI_RECVFD\fR +will not be able to retrieve any data off the stream until the \fBI_RECVFD\fR request is issued. If the server process exits before issuing the \fBI_RECVFD\fR request, the \fBopen\fR(2) or the \fBcreat\fR(2) invocation will fail and return -1 to the originating process. .sp .LP When the \fBconnld\fR module is pushed onto a pipe, it ignores messages going -back and forth through the pipe. +back and forth through the pipe. .SH ERRORS -.sp -.LP On success, an open of \fBconnld\fR returns 0. On failure, \fBerrno\fR is set to the following values: .sp @@ -100,7 +90,7 @@ An internal pipe could not be created. \fB\fBENXIO\fR \fR .ad .RS 11n -An \fBM_HANGUP\fR message is at the stream head of the pipe onto which +An \fBM_HANGUP\fR message is at the stream head of the pipe onto which \fBconnld\fR is being pushed. .RE @@ -123,8 +113,6 @@ A file table entry could not be allocated. .RE .SH SEE ALSO -.sp -.LP \fBcreat\fR(2), \fBopen\fR(2), \fBfattach\fR(3C), \fBstreamio\fR(7I) .sp .LP diff --git a/usr/src/man/man9e/devmap_dup.9e b/usr/src/man/man9e/devmap_dup.9e index 6b4b68088c..2c25511f02 100644 --- a/usr/src/man/man9e/devmap_dup.9e +++ b/usr/src/man/man9e/devmap_dup.9e @@ -3,13 +3,13 @@ .\" 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 DEVMAP_DUP 9E "Jan 21, 1997" +.TH DEVMAP_DUP 9E "June 18, 2021" .SH NAME devmap_dup \- device mapping duplication entry point .SH SYNOPSIS .nf #include <sys/ddi.h> -#include <sys/sunddi.h +#include <sys/sunddi.h> @@ -66,7 +66,7 @@ to set \fInew_pvtp\fR to point to it. \fInew_dhp\fR is the handle of the new mapped object. .sp .LP -A non-zero return value from \fBdevmap_dup()\fR will cause a corresponding +A non-zero return value from \fBdevmap_dup()\fR will cause a corresponding operation such as \fBfork()\fR to fail. .SH RETURN VALUES \fBdevmap_dup()\fR returns the following values: diff --git a/usr/src/man/man9f/ddi_fm_acc_err_clear.9f b/usr/src/man/man9f/ddi_fm_acc_err_clear.9f index e475f36ea4..55e8bb5c1a 100644 --- a/usr/src/man/man9f/ddi_fm_acc_err_clear.9f +++ b/usr/src/man/man9f/ddi_fm_acc_err_clear.9f @@ -3,13 +3,13 @@ .\" 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 DDI_FM_ACC_ERR_CLEAR 9F "May 10, 2007" +.TH DDI_FM_ACC_ERR_CLEAR 9F "June 19, 2021" .SH NAME ddi_fm_acc_err_clear, ddi_fm_dma_err_clear \- clear the error status for an access or DMA handle .SH SYNOPSIS .nf -#include <sys/ndifma.h> +#include <sys/ddifm.h> \fBvoid\fR \fBddi_fm_acc_err_clear\fR(\fBddi_acc_handle_t\fR \fIacc_handle\fR, \fBint\fR \fIversion\fR); diff --git a/usr/src/man/man9f/usb_reset_device.9f b/usr/src/man/man9f/usb_reset_device.9f index 5459f4d87d..236ad2fb89 100644 --- a/usr/src/man/man9f/usb_reset_device.9f +++ b/usr/src/man/man9f/usb_reset_device.9f @@ -3,12 +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 USB_RESET_DEVICE 9F "Sep 16, 2016" +.TH USB_RESET_DEVICE 9F "June 18, 2021" .SH NAME usb_reset_device \- reset a USB device according to the reset_level. .SH SYNOPSIS .nf -#include <sys/usb/usba.h +#include <sys/usb/usba.h> @@ -25,7 +25,7 @@ illumos DDI specific (illumos DDI) .ad .sp .6 .RS 4n -Pointer to the devices's \fBdev_info\fR structure. +Pointer to the device's \fBdev_info\fR structure. .RE .sp |