diff options
| author | Dan McDonald <danmcd@joyent.com> | 2021-06-15 11:02:10 -0400 |
|---|---|---|
| committer | Dan McDonald <danmcd@joyent.com> | 2021-06-15 11:02:10 -0400 |
| commit | 8e22e6a144951e89f25db37f754117a8404d5b97 (patch) | |
| tree | ecba4cc28282bb4b9194fa778d23589daff9e561 | |
| parent | 5131583e981e0157b76ee89799b6f9fdff4077a4 (diff) | |
| parent | ceab728f83b0af9260d2d3fb69014f3781af2101 (diff) | |
| download | illumos-joyent-8e22e6a144951e89f25db37f754117a8404d5b97.tar.gz | |
[illumos-gate merge]
commit ceab728f83b0af9260d2d3fb69014f3781af2101
13872 Multiple errors in section 3mpapi of the manual
commit 9514bcf4c37a9b87200462594803414d12cdd29d
13871 Missing spaces in several manual pages
29 files changed, 106 insertions, 418 deletions
diff --git a/usr/src/man/man1/awk.1 b/usr/src/man/man1/awk.1 index b2983dada4..2b86e7e8b0 100644 --- a/usr/src/man/man1/awk.1 +++ b/usr/src/man/man1/awk.1 @@ -45,7 +45,7 @@ .\" Portions Copyright (c) 2005, 2006 Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2020 Joyent, Inc. .\" -.TH AWK 1 "Apr 20, 2020" +.TH AWK 1 "June 13, 2021" .SH NAME awk \- pattern scanning and processing language .SH SYNOPSIS @@ -192,10 +192,10 @@ the \fB=\fR represent the name of a \fBawk\fR variable. If that name is a \fBawk\fR reserved word, the behavior is undefined. The characters following the equal sign is interpreted as if they appeared in the \fBawk\fR program preceded and followed by a double-quote (\fB"\fR) character, as a \fBSTRING\fR -token , except that if the last character is an unescaped backslash, it is +token, except that if the last character is an unescaped backslash, it is interpreted as a literal backslash rather than as the first character of the sequence \fB\e\fR\&.. The variable is assigned the value of that \fBSTRING\fR -token. If the value is considered a \fInumeric\fRstring\fI,\fR the variable is +token. If the value is considered a \fInumeric\fR string, the variable is assigned its numeric value. Each such variable assignment is performed just before the processing of the following \fIfile\fR, if any. Thus, an assignment before the first \fBfile\fR argument is executed after the \fBBEGIN\fR actions diff --git a/usr/src/man/man1/kmfcfg.1 b/usr/src/man/man1/kmfcfg.1 index c42643c270..6c6d812976 100644 --- a/usr/src/man/man1/kmfcfg.1 +++ b/usr/src/man/man1/kmfcfg.1 @@ -3,18 +3,15 @@ .\" 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 KMFCFG 1 "Feb 3, 2009" +.TH KMFCFG 1 "June 13, 2021" .SH NAME kmfcfg \- Key Management Policy and Plugin Configuration Utility .SH SYNOPSIS -.LP .nf \fBkmfcfg\fR \fIsubcommand\fR [\fIoption\fR ...] .fi .SH DESCRIPTION -.sp -.LP The \fBkmfcfg\fR command allows users to configure Key Management Framework (KMF) policy databases. The KMF policy database (DB) restricts the use of keys and certificates that are managed through the KMF framework. @@ -28,8 +25,6 @@ export policy definitions either in the system default database file For plugin configuration, \fBkmfcfg\fR allows users to display plugin information, install or uninstall a KMF plugin, and modify the plugin option. .SH SUBCOMMANDS -.sp -.LP The following subcommands are supported: .sp .ne 2 @@ -400,7 +395,7 @@ The \fBdelete\fR subcommand supports the following options: .ad .RS 21n Read policy definitions from the indicated file. If \fIdbfile\fR is not -specified, , the default is the system KMF policy database file: +specified, the default is the system KMF policy database file: \fB/etc/security/kmfpolicy.xml\fR. .RE @@ -699,7 +694,6 @@ The \fBdefault\fR policy in the system KMF policy database cannot be modified. .RE .SS "Plugin Subcommands" -.sp .ne 2 .na \fB\fBinstall keystore=\fR\fIkeystore_name\fR \fBmodulepath=\fR\fIpathname\fR\e @@ -724,7 +718,7 @@ the calling program's instruction set architecture. .RS 4n Display KMF plugin information. .sp -Without the \fBplugin\fRkeyword, \fBkmfcfg list\fR shows the policy information +Without the \fBplugin\fR keyword, \fBkmfcfg list\fR shows the policy information as described in the \fBSUBCOMMANDS\fR section. .RE @@ -755,7 +749,6 @@ Uninstall the plugin with the \fIkeystore_name\fR. .RE .SH EXAMPLES -.LP \fBExample 1 \fRCreating a New Policy .sp .LP @@ -774,8 +767,6 @@ ekuname=ipsecTunnel,ipsecUser .sp .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -796,7 +787,6 @@ An error occurred. .RE .SH FILES -.sp .ne 2 .na \fB\fB/etc/security/kmfpolicy.xml\fR\fR @@ -807,8 +797,6 @@ Default system policy database .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -823,6 +811,4 @@ Interface Stability Uncommitted .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5) diff --git a/usr/src/man/man1/pax.1 b/usr/src/man/man1/pax.1 index 46d4aa4a77..f86373c431 100644 --- a/usr/src/man/man1/pax.1 +++ b/usr/src/man/man1/pax.1 @@ -43,7 +43,7 @@ .\" Copyright (c) 1992, X/Open Company Limited All. Rights Reserved. .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved .\" -.TH PAX 1 "September 22, 2020" +.TH PAX 1 "June 13, 2021" .SH NAME pax \- portable archive interchange .SH SYNOPSIS @@ -540,7 +540,7 @@ variable. If \fBTMPDIR\fR is not set, \fBpax\fR uses \fB/tmp\fR. This keyword is applicable only to the \fB-x\fR \fBpax\fR format. This keyword allows user control over the action \fBpax\fR takes upon encountering values in an extended header record that, in \fBread\fR or \fBcopy\fR mode, are invalid -in the destination hierarchy or, in \fBlist\fR mode , cannot be written in the +in the destination hierarchy or, in \fBlist\fR mode, cannot be written in the codeset and current locale of the implementation. The following are invalid values that are recognized by \fBpax\fR: .RS +4 @@ -1309,7 +1309,7 @@ where <\fIls\fR \fB-l\fR \fIlisting\fR> is the format specified by the \fBls\fR command with the \fB-l\fR option. When writing path names in this format, it is unspecified what is written for fields for which the underlying archive format does not have the correct information, although the correct number of -blank-character-separated fields is written. +blank-character-separated fields are written. .RE .sp .LP @@ -1361,7 +1361,7 @@ When \fBpax\fR is in \fBread\fR mode or \fBlist\fR mode, using the \fB-x\fR field in an extended header record cannot be translated from the \fBpax\fR UTF-8 codeset format to the codeset and current locale of the implementation, \fBpax\fR writes a diagnostic message to standard error, processes the file as -described for the \fB-o\fR \fBinvalid=\fRoption, and then processes the next +described for the \fB-o\fR \fBinvalid=\fR option, and then processes the next file in the archive. .SS "Output Files" In \fBread\fR mode, the extracted output files are of the archived file type. @@ -1449,7 +1449,7 @@ extended header record when the file is archived. If this extended header record is associated with a file in the archive, those holes are recreated whenever that file is extracted from the archive. See the \fBSEEK_DATA\fR and \fBSEEK_HOLE\fR whence values in \fBlseek\fR(2). In all other cases, any -\fBNUL\fR (\fB\e0\fR) characters found in the archive is written to the file +\fBNUL\fR (\fB\e0\fR) characters found in the archive are written to the file when it is extracted. .sp .LP @@ -2407,7 +2407,7 @@ A Solaris extension to \fBpax\fR extended header keywords. Specifies the data and hole pairs for a sparse file. .sp In write or copy modes and when the \fBxustar\fR or \fBpax\fR format (see \fB-x -format\fR) is specified, \fBpax\fR includes a \fBSUN.holesdate\fR extended +format\fR) is specified, \fBpax\fR includes a \fBSUN.holesdata\fR extended header record if the underlying file system supports the detection of files with holes (see \fBfpathconf\fR(2)) and reports that there is at least one hole in the file being archived. \fIvalue\fR consists of two or more consecutive @@ -2702,7 +2702,7 @@ character set as octets with the most significant bit zero. If an implementation supports the use of characters outside the portable filename character set in names for files, users, and groups, one or more implementation-defined encodings of these characters are provided for -interchange purposes.\fBpax\fR does not create filenames on the local system +interchange purposes. \fBpax\fR does not create filenames on the local system that cannot be accessed by way of the procedures described in volume \fIIEEE Std 1003.1-200x\fR. If a filename is found on the medium that would create an invalid filename, it is implementation-defined whether the data from the file diff --git a/usr/src/man/man1/strings.1 b/usr/src/man/man1/strings.1 index 745be6b5f3..ac310ea457 100644 --- a/usr/src/man/man1/strings.1 +++ b/usr/src/man/man1/strings.1 @@ -44,19 +44,16 @@ .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .\" -.TH STRINGS 1 "Apr 13, 2007" +.TH STRINGS 1 "June 13, 2021" .SH NAME strings \- find printable strings in an object or binary file .SH SYNOPSIS -.LP .nf \fBstrings\fR [\fB-a\fR | \fB-\fR] [\fB-t\fR \fIformat\fR | \fB-o\fR] [\fB-n\fR \fInumber\fR | \fB-number\fR] [\fB-N\fR \fIname\fR] [\fIfile\fR]... .fi .SH DESCRIPTION -.sp -.LP The \fBstrings\fR utility looks for \fBASCII\fR strings in a binary file. A string is any sequence of 4 or more printing characters ending with a NEWLINE or a \fBNULL\fR character. @@ -76,8 +73,6 @@ for a file. All sections can be inspected with the \fB-a\fR option. Individual sections can be inspected with the \fB-N\fR option. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -107,7 +102,7 @@ is \fB4\fR. Look only in ELF section name. See \fBelfdump\fR(1). Multiple \fB-N\fR options can be specified to inspect multiple sections. .sp -If the \fB-a\fR or \fB-\fRoption is specified, all \fB-N\fR options are +If the \fB-a\fR or \fB-\fR option is specified, all \fB-N\fR options are ignored . .RE @@ -159,8 +154,6 @@ The offset is written in hexadecimal. .RE .SH OPERANDS -.sp -.LP The following operand is supported: .sp .ne 2 @@ -173,14 +166,10 @@ specified, the \fBstrings\fR utility reads from the standard input. .RE .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBstrings\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -201,8 +190,6 @@ An error occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -224,13 +211,9 @@ The \fBstrings\fR utility, including all options except \fB-N\fR, are specified by standards. See \fBstandards\fR(5). The \fB-N\fR option is not currently specified by any standard. .SH SEE ALSO -.sp -.LP \fBelfdump\fR(1), \fBod\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP The algorithm for identifying strings is extremely primitive. .sp .LP diff --git a/usr/src/man/man1/touch.1 b/usr/src/man/man1/touch.1 index e64678ac7d..81191a19d5 100644 --- a/usr/src/man/man1/touch.1 +++ b/usr/src/man/man1/touch.1 @@ -42,13 +42,12 @@ .\" .\" Copyright 1989 AT&T .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved -.\" Portions Copyright (c) 2009, Sun Mricrosystems, Inc. All Rights Reserved +.\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved .\" -.TH TOUCH 1 "Sep 9, 2009" +.TH TOUCH 1 "June 13, 2021" .SH NAME touch, settime \- change file access and modification times .SH SYNOPSIS -.LP .nf \fBtouch\fR [\fB-acm\fR] [\fB-r\fR \fIref_file\fR | \fB-t\fR \fItime\fR | \fB-d\fR \fIdate_time\fR] \fIfile\fR... .fi @@ -64,8 +63,6 @@ touch, settime \- change file access and modification times .fi .SH DESCRIPTION -.sp -.LP The \fBtouch\fR utility sets the access and modification times of each file. The \fIfile\fR operand is created if it does not already exist. .sp @@ -89,13 +86,9 @@ an error. The \fBsettime\fR utility is equivalent to \fBtouch\fR \fB-c\fR [\fItime_spec\fR] \fIfile\fR. .SH OPTIONS -.sp -.LP The following options are supported in the \fBtouch\fR and \fBsettime\fR utilities: .SS "touch" -.sp -.LP The following options are supported for the \fBtouch\fR utility: .sp .ne 2 @@ -323,8 +316,6 @@ it is assumed to be 0. .RE .SS "settime" -.sp -.LP The following option is supported for the \fBsettime\fR utility: .sp .ne 2 @@ -338,8 +329,6 @@ current time. .RE .SH OPERANDS -.sp -.LP The following operands are supported for the \fBtouch\fR and \fBsettime\fR utilities: .sp @@ -436,20 +425,16 @@ YY Corresponding Year 39-68 ERROR .TE -If no \fB-d\fR, \fB-r\fR, or \fB-t\fRoption is specified, at least two operands +If no \fB-d\fR, \fB-r\fR, or \fB-t\fR option is specified, at least two operands are specified, and the first operand is an eight- or ten-digit decimal integer, the first operand is assumed to be a \fItime_spec\fR operand. Otherwise, the first operand is assumed to be a \fIfile\fR operand. .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBtouch\fR when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes). .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBtouch\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLANG\fR, \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. @@ -465,8 +450,6 @@ Determine the timezone to be used for interpreting the \fItime\fR or .RE .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -491,8 +474,6 @@ which the times could not be successfully modified. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -511,13 +492,9 @@ Standard See \fBstandards\fR(5). .TE .SH SEE ALSO -.sp -.LP \fBfutimens\fR(2), \fBstat\fR(2), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP Users familiar with the BSD environment find that for the \fBtouch\fR utility, the \fB-f\fR option is accepted but ignored. The \fB-f\fR option is unnecessary because \fBtouch\fR succeeds for all files owned by the user regardless of the diff --git a/usr/src/man/man1/tr.1 b/usr/src/man/man1/tr.1 index a331448112..a64186b42d 100644 --- a/usr/src/man/man1/tr.1 +++ b/usr/src/man/man1/tr.1 @@ -44,11 +44,10 @@ .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH TR 1 "Mar 3, 2009" +.TH TR 1 "June 13, 2021" .SH NAME tr \- translate characters .SH SYNOPSIS -.LP .nf \fB/usr/bin/tr\fR [\fB-cds\fR] [\fIstring1\fR [\fIstring2\fR]] .fi @@ -89,15 +88,11 @@ tr \- translate characters .fi .SH DESCRIPTION -.sp -.LP The \fBtr\fR utility copies the standard input to the standard output with substitution or deletion of selected characters. The options specified and the \fIstring1\fR and \fIstring2\fR operands control translations that occur while copying characters and single-character collating elements. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -244,8 +239,6 @@ appropriate. (See \fBtoupper\fR(3C) and \fBtolower\fR(3C)). An empty string used for \fIstring1\fR or \fIstring2\fR produces undefined results. .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -305,7 +298,6 @@ unspecified. .RE .SS "/usr/xpg4/bin/tr" -.sp .ne 2 .na \fB\fIc-c\fR\fR @@ -315,7 +307,6 @@ unspecified. .RE .SS "/usr/bin/tr" -.sp .ne 2 .na \fB[\fIc-c\fR]\fR @@ -364,10 +355,10 @@ names \fBlower\fR or \fBupper\fR are valid in \fIstring2\fR and then only if the corresponding character class \fBupper\fR and \fBlower\fR, respectively, is specified in the same relative position in \fIstring1\fR. Such a specification is interpreted as a request for case conversion. When \fB[:lower:]\fR appears -in \fIstring1\fR and \fB[:upper:]\fR appears in \fIstring2,\fR the arrays +in \fIstring1\fR and \fB[:upper:]\fR appears in \fIstring2\fR, the arrays contain the characters from the \fBtoupper\fR mapping in the \fBLC_CTYPE\fR category of the current locale. When \fB[:upper:]\fR appears in \fIstring1\fR -and \fB[:lower:]\fR appears in \fIstring2,\fR the arrays contain the characters +and \fB[:lower:]\fR appears in \fIstring2\fR, the arrays contain the characters from the \fBtolower\fR mapping in the \fBLC_CTYPE\fR category of the current locale. The first character from each mapping pair is in the array for \fIstring1\fR and the second character from each mapping pair is in the array @@ -407,17 +398,14 @@ as an octal value. Otherwise, it is interpreted as a decimal value. .sp If \fIn\fR is omitted or is \fB0\fR, \fB/usr/bin/tr\fR interprets this as huge; \fB/usr/xpg4/bin/tr\fR and \fB/usr/xpg6/bin/tr\fR interprets this as large -enough to extend the\fIstring2\fR-based sequence to the length of the +enough to extend the \fIstring2\fR-based sequence to the length of the \fIstring1\fR-based sequence. .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBtr\fR when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes). .SH EXAMPLES -.LP \fBExample 1 \fRCreating a list of words .sp .LP @@ -471,14 +459,10 @@ and written to \fBfile2\fR. .sp .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBtr\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -499,13 +483,8 @@ An error occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .SS "/usr/bin/tr" -.sp - -.sp .TS box; c | c @@ -516,9 +495,6 @@ CSI Enabled .TE .SS "/usr/xpg4/bin/tr" -.sp - -.sp .TS box; c | c @@ -533,9 +509,6 @@ Standard See \fBstandards\fR(5). .TE .SS "/usr/xpg6/bin/tr" -.sp - -.sp .TS box; c | c @@ -550,14 +523,10 @@ Standard See \fBstandards\fR(5). .TE .SH SEE ALSO -.sp -.LP \fBed\fR(1), \fBsed\fR(1), \fBsh\fR(1), \fBtolower\fR(3C), \fBtoupper\fR(3C), \fBascii\fR(5), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBregex\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP Unlike some previous versions, \fB/usr/xpg4/bin/tr\fR correctly processes \fBNUL\fR characters in its input stream. \fBNUL\fR characters can be stripped by using \fBtr\fR \fB-d\fR \fB\&'\e000'\fR. diff --git a/usr/src/man/man1m/ifconfig.1m b/usr/src/man/man1m/ifconfig.1m index 0de64da068..83547719d3 100644 --- a/usr/src/man/man1m/ifconfig.1m +++ b/usr/src/man/man1m/ifconfig.1m @@ -1,13 +1,12 @@ '\" te -.\" Copyright (C) 2012, Darren Reed. All rights reserved +.\" Copyright (C) 2012, Darren Reed. All rights reserved .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 1989 AT&T .\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.TH IFCONFIG 1M "July 23, 2012" +.TH IFCONFIG 1M "June 13, 2021" .SH NAME ifconfig \- configure network interface parameters .SH SYNOPSIS -.LP .nf \fBifconfig\fR \fIinterface\fR [\fIaddress_family\fR] [\fIaddress\fR [\fI/prefix_length\fR] [\fIdest_address\fR]] [\fBaddif\fR \fIaddress\fR [\fI/prefix_length\fR]] @@ -37,8 +36,6 @@ ifconfig \- configure network interface parameters .fi .SH DESCRIPTION -.sp -.LP The command \fBifconfig\fR is used to assign an address to a network interface and to configure network interface parameters. The \fBifconfig\fR command must be used at boot time to define the network address of each interface present on @@ -50,8 +47,6 @@ specific to that address family. Only privileged users may modify the configuration of a network interface. Options appearing within braces (\fB{\|}\fR) indicate that one of the options must be specified. .SS Network Interface Observability -.sp -.LP Network interface observability with \fBifconfig\fR is limited to those network interfaces that have been prepared for use with the IP protocol suite. The preferred method for configuring a network @@ -60,8 +55,6 @@ with the use of the \fBplumb\fR option as documented below. Network interfaces that have not been configured for use with the IP protocol suite can only be observed by using the \fBdladm\fR command. .SS DHCP Configuration -.sp -.LP The forms of \fBifconfig\fR that use the \fBauto-dhcp\fR or \fBdhcp\fR arguments are used to control the Dynamic Host Configuration Protocol ("\fBDHCP\fR") configuration of the interface. In this mode, \fBifconfig\fR is @@ -72,8 +65,6 @@ address or characteristics of the interface. If the address of an interface under \fBDHCP\fR is changed, \fBdhcpagent\fR will remove the interface from its control. .SH OPTIONS -.sp -.LP When the \fBifconfig\fR command is executed without any options its behavior is the same as when the \fB\-a\fR option is supplied with no other options or arguments. @@ -1136,7 +1127,7 @@ receive packets. .RS 4n Place the logical interface in zone \fIzonename\fR. The named zone must be active in the kernel in the ready or running state. The interface is unplumbed -when the zone is halted or rebooted. The zone must be configure to be an +when the zone is halted or rebooted. The zone must be configured to be an shared-IP zone. \fBzonecfg\fR(1M) is used to assign network interface names to exclusive-IP zones. .RE @@ -1152,8 +1143,6 @@ Place IP interface in the global zone. This is the default. .RE .SH OPERANDS -.sp -.LP The \fIinterface\fR operand, as well as address parameters that affect it, are described below. .sp @@ -1353,8 +1342,6 @@ configured "up" with \fBifconfig\fR. .RE .SH INTERFACE FLAGS -.sp -.LP The \fBifconfig\fR command supports the following interface flags. The term "address" in this context refers to a logical interface, for example, \fBeri0:0\fR, while "interface" refers to the physical interface, for example, @@ -1574,7 +1561,7 @@ interface. .ad .sp .6 .RS 4n -The interface has no address , just an on-link subnet. +The interface has no address, just an on-link subnet. .RE .sp @@ -1768,8 +1755,6 @@ Indicates that the interface uses an IPv6 external resolver. .RE .SH LOGICAL INTERFACES -.sp -.LP Solaris \fBTCP/IP\fR allows multiple logical interfaces to be associated with a physical network interface. This allows a single machine to be assigned multiple \fBIP\fR addresses, even though it may have only one network @@ -1817,8 +1802,8 @@ allocates the next available logical unit number on the \fBeri0\fR physical interface and assigns an \fIaddress\fR and \fIprefix_length\fR. .sp .LP -A logical interface can be configured with parameters ( -\fIaddress\fR,\fIprefix_length\fR, and so on) different from the physical +A logical interface can be configured with parameters (\fIaddress\fR, +\fIprefix_length\fR, and so on) different from the physical interface with which it is associated. Logical interfaces that are associated with the same physical interface can be given different parameters as well. Each logical interface must be associated with an existing and "up" physical @@ -1840,8 +1825,6 @@ example% \fBifconfig eri0:1 down unplumb\fR .LP will delete the logical interface \fBeri0:1\fR. .SH IP MULTIPATHING GROUPS -.sp -.LP Physical interfaces that share the same link-layer broadcast domain \fBmust\fR be collected into a single IP Multipathing (IPMP) group using the \fBgroup\fR subcommand. Each IPMP group has an associated IPMP IP interface, which can @@ -1919,8 +1902,6 @@ For more background on IPMP, please see the IPMP-related chapters of the \fISystem Administration Guide: Network Interfaces and Network Virtualization\fR. .SH CONFIGURING IPV6 INTERFACES -.sp -.LP When an IPv6 physical interface is plumbed and configured "up" with \fBifconfig\fR, it is automatically assigned an IPv6 link-local address for which the last 64 bits are calculated from the \fBMAC\fR address of the @@ -1993,8 +1974,6 @@ addif 2001:0db8:3c4d:55:a00:20ff:fe8e:f3ad/64 up .in -2 .SS "Configuring IP-over-IP Tunnel Interfaces" -.sp -.LP An IP tunnel is conceptually comprised of two parts: a virtual link between two or more IP nodes, and an IP interface above this link which allows the system to transmit and receive IP packets encapsulated by the underlying link. @@ -2078,8 +2057,6 @@ The \fBtsrc\fR, \fBtdst\fR, \fBencaplim\fR, and \fBhoplimit\fR options to \fBifconfig\fR are obsolete and maintained only for backward compatibility. They are equivalent to their \fBdladm\fR(1M) counterparts. .SS "Display of Tunnel Security Settings" -.sp -.LP The \fBifconfig\fR output for IP tunnel interfaces indicates whether IPsec policy is configured for the underlying IP tunnel link. For example, a line of the following form will be displayed if IPsec policy is present: @@ -2096,7 +2073,6 @@ tunnel security settings --> use 'ipsecconf -ln -i ip.tun1' If you do net set security policy, using either \fBifconfig\fR or \fBipsecconf\fR(1M), there is no tunnel security setting displayed. .SH EXAMPLES -.LP \fBExample 1 \fRUsing the \fBifconfig\fR Command .sp .LP @@ -2475,7 +2451,6 @@ example% \fBifconfig hme0 dhcp release\fR .sp .SH FILES -.sp .ne 2 .na \fB\fB/etc/netmasks\fR\fR @@ -2496,8 +2471,6 @@ Default Internet protocol type. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -2516,8 +2489,6 @@ Interface Stability for command output Uncommitted .TE .SH SEE ALSO -.sp -.LP \fBdhcpinfo\fR(1), \fBcfgadm\fR(1M), \fBdhcpagent\fR(1M), \fBdladm\fR(1M), \fBif_mpadm\fR(1M), \fBin.mpathd\fR(1M), \fBin.ndpd\fR(1M), \fBin.routed\fR(1M), \fBipmpstat\fR(1M), \fBipsecconf\fR(1M), \fBndd\fR(1M), @@ -2530,8 +2501,6 @@ Interface Stability for command output Uncommitted .LP \fISystem Administration Guide: IP Services\fR .SH DIAGNOSTICS -.sp -.LP \fBifconfig\fR sends messages that indicate if: .RS +4 .TP @@ -2552,8 +2521,6 @@ the requested address is unknown the user is not privileged and tried to alter an interface's configuration .RE .SH NOTES -.sp -.LP Do not select the names \fBbroadcast\fR, \fBdown\fR, \fBprivate\fR, \fBtrailers\fR, \fBup\fR or other possible option names when you choose host names. If you choose any one of these names as host names, it can cause unusual diff --git a/usr/src/man/man1m/swap.1m b/usr/src/man/man1m/swap.1m index b0fb586f59..e89d02c4d8 100644 --- a/usr/src/man/man1m/swap.1m +++ b/usr/src/man/man1m/swap.1m @@ -4,11 +4,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 SWAP 1M "Apr 11, 2008" +.TH SWAP 1M "June 13, 2021" .SH NAME swap \- swap administrative interface .SH SYNOPSIS -.LP .nf \fB/usr/sbin/swap\fR \fB-a\fR \fIswapname\fR [\fIswaplow\fR] [\fIswaplen\fR] .fi @@ -29,13 +28,9 @@ swap \- swap administrative interface .fi .SH DESCRIPTION -.sp -.LP The \fBswap\fR utility provides a method of adding, deleting, and monitoring the system swap areas used by the memory manager. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -239,7 +234,7 @@ The list does not include swap space in the form of physical memory because this space is not associated with a particular swap area. .sp If \fBswap\fR \fB-l\fR is run while \fIswapname\fR is in the process of being -deleted (by \fBswap\fR\fB-d\fR), the string \fBINDEL\fR will appear in a sixth +deleted (by \fBswap\fR \fB-d\fR), the string \fBINDEL\fR will appear in a sixth column of the swap stats. .RE @@ -295,33 +290,20 @@ reservation and allocation. .RE These numbers include swap space from all configured swap areas as listed by -the \fB-l\fR option, as well swap space in the form of physical memory. +the \fB-l\fR option, as well as swap space in the form of physical memory. .RE .SH USAGE -.sp -.LP -On the 32-bit operating system, only the first 2 Gbytes -1 are used for swap -devices greater than or equal to 2 Gbytes in size. On the 64-bit operating -system, a block device larger than 2 Gbytes can be fully utilized for swap up -to 2^63 \(mi1 bytes. +A block device up to 2^63 \(mi1 bytes can be fully utilized for swap. .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBswap\fR: \fBLC_CTYPE\fR and \fBLC_MESSAGE\fR. .SH SEE ALSO -.sp -.LP \fBpagesize\fR(1), \fBmkfile\fR(1M), \fBshareall\fR(1M), \fBgetpagesize\fR(3C), \fBvfstab\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5) .SH NOTES -.sp -.LP For information about setting up a swap area with \fBZFS\fR, see the \fIZFS Administration Guide\fR. .SH WARNINGS -.sp -.LP No check is done to determine if a swap area being added overlaps with an existing file system. diff --git a/usr/src/man/man1m/traceroute.1m b/usr/src/man/man1m/traceroute.1m index dee89c9620..abc2dfbf65 100644 --- a/usr/src/man/man1m/traceroute.1m +++ b/usr/src/man/man1m/traceroute.1m @@ -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 TRACEROUTE 1M "Dec 11, 2015" +.TH TRACEROUTE 1M "June 13, 2021" .SH NAME traceroute \- print the route packets take to network host .SH SYNOPSIS -.LP .nf \fBtraceroute\fR [\fB-adFIlnSvx\fR] [\fB-A\fR \fIaddr_family\fR] [\fB-c\fR \fItraffic_class\fR] [\fB-f\fR \fIfirst_hop\fR] [\fB-g\fR \fIgateway\fR [\fB-g\fR \fIgateway\fR...] | \fB-r\fR] @@ -18,7 +17,6 @@ traceroute \- print the route packets take to network host .fi .SH DESCRIPTION -.LP The Internet is a large and complex aggregation of network hardware, connected by gateways. Tracking the route a packet follows can be difficult. The utility \fBtraceroute\fR traces the route that an \fBIP\fR packet follows to another @@ -300,7 +298,7 @@ bit is always set in this case. .ad .sp .6 .RS 4n -Set the starting \fIttl\fR ( \fIhop limit\fR) value to \fIfirst_hop\fR, to +Set the starting \fIttl\fR (\fIhop limit\fR) value to \fIfirst_hop\fR, to override the default value \fB1\fR. \fBtraceroute\fR skips processing for those intermediate gateways which are less than \fIfirst_hop\fR hops away. .RE @@ -413,7 +411,7 @@ received a reply. Note that \fIpause_sec\fR is a real number. .RS 4n Set the base \fBUDP\fR \fIport\fR number used in probes.The default is 33434. \fBtraceroute\fR hopes that nothing is listening on \fBUDP\fR \fIports\fR -\fB(base+(nhops-1)*nqueries)\fR to \fB(base+(nhops*nqueries)-1)\fRat the +\fB(base+(nhops-1)*nqueries)\fR to \fB(base+(nhops*nqueries)-1)\fR at the destination host, so that an \fBICMP\fR (\fBICMP6\fR) \fBPORT_UNREACHABLE\fR message will be returned to terminate the route tracing. If something is listening on a \fIport\fR in the default range, this option can be used to @@ -538,7 +536,6 @@ checksum is always calculated by the operating system in this case. .RE .SH OPERANDS -.LP The following operands are supported: .sp .ne 2 @@ -551,7 +548,6 @@ The network host. .RE .SH EXAMPLES -.LP \fBExample 1 \fRSample Output From the \fBtraceroute\fR Utility .sp .LP @@ -642,7 +638,6 @@ traceroute to sanfrancisco (172.29.64.39), 30 hops max, 56 byte packets .sp .SH EXIT STATUS -.LP The following exit values are returned: .sp .ne 2 @@ -665,11 +660,9 @@ An error occurred. .RE .SH SEE ALSO -.LP \fBnetstat\fR(1M), \fBsignal\fR(3C), \fBping\fR(1M), \fBattributes\fR(5), \fBprivileges\fR(5), \fBzones\fR(5) .SH WARNINGS -.LP This utility is intended for use in network testing, measurement and management. It should be used primarily for manual fault isolation. Because of the load it could impose on the network, it is unwise to use diff --git a/usr/src/man/man2/stat.2 b/usr/src/man/man2/stat.2 index 831c592df0..5dabfe0d5e 100644 --- a/usr/src/man/man2/stat.2 +++ b/usr/src/man/man2/stat.2 @@ -4,7 +4,7 @@ .\" 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 STAT 2 "Mar 15, 2021" +.TH STAT 2 "June 13, 2021" .SH NAME stat, lstat, fstat, fstatat \- get file status .SH SYNOPSIS @@ -247,7 +247,7 @@ disk. This field is not defined for block special or character special files. \fB\fBst_fstype\fR\fR .ad .RS 14n -A null-teminated string that uniquely identifies the type of the filesystem +A null-terminated string that uniquely identifies the type of the filesystem that contains the file. .RE @@ -432,7 +432,7 @@ resolution of the \fIpath\fR argument. \fB\fBENAMETOOLONG\fR\fR .ad .RS 16n -As a result of encountering a symbolic link in resolution of the\fIpath\fR +As a result of encountering a symbolic link in resolution of the \fIpath\fR argument, the length of the substituted pathname strings exceeds {\fBPATH_MAX\fR}. .RE diff --git a/usr/src/man/man3lib/libMPAPI.3lib b/usr/src/man/man3lib/libMPAPI.3lib index 7e7f5d2cbf..2f834806e9 100644 --- a/usr/src/man/man3lib/libMPAPI.3lib +++ b/usr/src/man/man3lib/libMPAPI.3lib @@ -4,24 +4,21 @@ .\" 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 LIBMPAPI 3LIB "Nov 26, 2017" +.TH LIBMPAPI 3LIB "June 13, 2021" .SH NAME libMPAPI, libmpapi \- Common Multipath Management library .SH SYNOPSIS -.LP .nf -cc [ \fIflag\fR... ] \fIfile\fR... \fB-lMPAPI\fR [ \fIlibrary\fR... ] +cc [ \fIflag\fR... ] \fIfile\fR... \fB-lMPAPI\fR [ \fIlibrary\fR... ] #include <\fBmpapi.h\fR> -#include <\fBmpapi_sun.h\fR> +#include <\fBmpapi-sun.h\fR> .fi .SH DESCRIPTION -.LP The functions in this library allow a management application to administer the multipath devices and associated resources through standard interfaces, independent of a vendor-unique multipathing solution. .SH INTERFACES -.LP The shared object \fBlibMPAPI.so.1\fR provides the public interfaces defined below. See \fBIntro\fR(3) for additional information on shared object interfaces. @@ -206,9 +203,8 @@ interfaces. \fBSun_MP_SendScsiCmd\fR .in -2 .SH USAGE -.LP Client applications link with the Common Library (using \fB-lMPAPI\fR) to -access the interfaces. The Common Library dynamically loads an individual +access the interfaces. The Common Library dynamically loads an individual vendor-provided plugin library that is available through \fBMP_RegisterPlugin\fR(3MPAPI) on the host system. .sp @@ -236,7 +232,7 @@ of the plugin library. .TP 4. Retrieve discovery information and property information on multipath devices -and associated resources by calling the following: +and associated resources by calling the following: .RS +4 .TP .ie t \(bu @@ -467,7 +463,6 @@ resources by calling: .RE .RE .SH ERRORS -.LP Errors are generally returned from the underlying VSL and can include any of the following values: .sp @@ -491,7 +486,7 @@ carried out. This status value is returned when parameters passed to an API are detected to be invalid or inappropriate for a particular API parameter. If the parameter is an object ID, this status indicates that the object type subfield is defined in -this specification, but is not appropriate for this API +this specification, but is not appropriate for this API. .RE .sp @@ -637,7 +632,6 @@ shared object .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -657,7 +651,6 @@ T} .TE .SH SEE ALSO -.LP \fBIntro\fR(3), \fBMP_RegisterPlugin\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi index 14124e6463..ab6c4b6c61 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi @@ -4,12 +4,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 MP_DEREGISTERFOROBJECTPROPERTYCHANGES 3MPAPI "Feb 15, 2006" +.TH MP_DEREGISTERFOROBJECTPROPERTYCHANGES 3MPAPI "June 13, 2021" .SH NAME MP_DeregisterForObjectPropertyChanges \- deregister a previously registered client function .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -20,7 +19,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpClientFn\fR\fR @@ -54,8 +52,6 @@ that plugin. If this is zero, then registration is removed for all plugins. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_DeregisterForObjectPropertyChanges()\fR function deregisters a previously registered client function that is to be invoked whenever an object's property changes. @@ -68,7 +64,6 @@ The function specified by \fIpClientFn\fR takes a single parameter of type The function specified by \fIpClientFn\fR will no longer be called whenever an object's property changes. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -86,7 +81,7 @@ most likely to happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpluginOid\fR parmeter is not zero and has a type subfield other than +The \fIpluginOid\fR parameter is not zero and has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR. .RE @@ -107,7 +102,7 @@ The \fIpluginOid\fR owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter is not the same as the previously registered +The \fIpClientFn\fR parameter is not the same as the previously registered function. .RE @@ -118,7 +113,7 @@ function. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter is deregistered successfully. +The \fIpClientFn\fR parameter is deregistered successfully. .RE .sp @@ -128,12 +123,10 @@ The \fIpClientFn\fR parmeter is deregistered successfully. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter deregistration is not possible. +The \fIpClientFn\fR parameter deregistration is not possible. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -152,8 +145,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi index fc4e7f1f4f..7b1b5acfd3 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi @@ -4,11 +4,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 MP_DEREGISTERFOROBJECTVISIBILITYCHANGES 3MPAPI "Feb 15, 2006" +.TH MP_DEREGISTERFOROBJECTVISIBILITYCHANGES 3MPAPI "June 13, 2021" .SH NAME MP_DeregisterForObjectVisibilityChanges \- deregister a client function .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -19,7 +18,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpClientFn\fR\fR @@ -27,7 +25,7 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .RS 14n A pointer to an object ID that has type \fBMP_OBJECT_VISIBILITY_FN\fR function defined by the client that was previously registered using the -\fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI) API. With a successful +\fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI) API. With a successful return this function will no longer be called to inform the client of object visibility changes. .RE @@ -53,9 +51,7 @@ that plugin. If this is zero, then registration is removed for all plugins. .RE .SH DESCRIPTION -.sp -.LP -The \fBMP_DeregisterForObjectVisibilityChanges()\fR function deregistesr a +The \fBMP_DeregisterForObjectVisibilityChanges()\fR function deregisters a client function to be called whenever a high level object appears or disappears. .sp @@ -67,7 +63,6 @@ MP_OBJECT_VISIBILITY_FN. The function specified by \fIpClientFn\fR will no longer be called whenever high level objects appear or disappear. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -131,8 +126,6 @@ The \fIpClientFn\fR parameter deregistration is not possible at this time. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -151,8 +144,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi index e9939d1fa4..e563547f34 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi @@ -4,11 +4,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 MP_DEREGISTERPLUGIN 3MPAPI "Feb 15, 2006" +.TH MP_DEREGISTERPLUGIN 3MPAPI "June 13, 2021" .SH NAME MP_DeregisterPlugin \- deregister a plugin .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpPluginId\fR\fR @@ -28,8 +26,6 @@ A pointer to a Plugin ID previously registered using the .RE .SH DESCRIPTION -.sp -.LP The \fBMP_DeregisterPlugin()\fR function deregisters a plugin from the common library. .sp @@ -40,7 +36,6 @@ prevents an application that is currently not using a plugin from accessing the plugin. This is generally the behavior expected from dynamically loaded modules. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -79,11 +74,10 @@ The \fIpPluginId\fR parameter is deregistered successfully. .ad .sp .6 .RS 4n -The \fIpPluginId\fRparameter deregistration is not possible at this time +The \fIpPluginId\fR parameter deregistration is not possible at this time .RE .SH FILES -.sp .ne 2 .na \fB\fB/etc/mpapi.conf\fR\fR @@ -93,8 +87,6 @@ MPAPI library configuration file .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -113,8 +105,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi index 9c251838a2..92bb3c2afb 100644 --- a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi +++ b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi @@ -4,11 +4,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 MP_DISABLEAUTOFAILBACK 3MPAPI "Feb 15, 2006" +.TH MP_DISABLEAUTOFAILBACK 3MPAPI "June 13, 2021" .SH NAME MP_DisableAutoFailback \- disable auto-failback .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,12 +25,9 @@ The object ID of the plugin or the multipath logical unit. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_DisableAutoFailback()\fR function disables auto-failback for the specified plugin or multipath logical unit. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -50,7 +45,7 @@ happen if an uninitialized object ID is passed to the AP I. .ad .sp .6 .RS 4n -The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE @@ -85,8 +80,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -105,8 +98,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi index e92ef943f2..42304f17d4 100644 --- a/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi +++ b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi @@ -4,11 +4,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 MP_DISABLEAUTOPROBING 3MPAPI "Feb 15, 2006" +.TH MP_DISABLEAUTOPROBING 3MPAPI "June 13, 2021" .SH NAME MP_DisableAutoProbing \- disable auto-probing .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,12 +25,9 @@ The object ID of the plugin or the multipath logical unit. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_DisableAutoProbing()\fR function disables auto-probing for the -specified plugin or multipath logical unit. +specified plugin or multipath logical unit. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -50,7 +45,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE @@ -85,8 +80,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -105,8 +98,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoProbing\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi index f2cf43c60d..0633159b62 100644 --- a/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi +++ b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi @@ -4,11 +4,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 MP_ENABLEAUTOFAILBACK 3MPAPI "Feb 15, 2006" +.TH MP_ENABLEAUTOFAILBACK 3MPAPI "June 13, 2021" .SH NAME MP_EnableAutoFailback \- enable auto-failback .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,19 +25,16 @@ The object ID of the plugin or multipath logical unit. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_EnableAutoFailback()\fR function enables auto-failback. .SH RETURN VALUES -.sp .ne 2 .na -\fB\fBMP_STATUS_INVALID_OBJECT_TYPEkkk\fR\fR +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR .ad .sp .6 .RS 4n -The \fIoid\fR parameter does not specify any valid object type . This is most -likely to happen if an uninitialized object ID is passed to the AP I. +The \fIoid\fR parameter does not specify any valid object type. This is most +likely to happen if an uninitialized object ID is passed to the API. .RE .sp @@ -49,8 +44,8 @@ likely to happen if an uninitialized object ID is passed to the AP I. .ad .sp .6 .RS 4n -The \fIoid\fR parameter has a type subfield other than \fBMP_OBJE -CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +The \fIoid\fR parameter has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE .sp @@ -60,7 +55,7 @@ CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .ad .sp .6 .RS 4n -The \fIoid\fR parameter owner ID or object sequence number is invalid. +The \fIoid\fR parameter owner ID or object sequence number is invalid. .RE .sp @@ -70,7 +65,7 @@ The \fIoid\fR parameter owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The operation is successful +The operation is successful. .RE .sp @@ -84,8 +79,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -104,8 +97,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_DisableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi index 184fcc67ab..241e2df9e7 100644 --- a/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi @@ -4,11 +4,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 MP_GETASSOCIATEDPATHOIDLIST 3MPAPI "Feb 15, 2006" +.TH MP_GETASSOCIATEDPATHOIDLIST 3MPAPI "June 13, 2021" .SH NAME MP_GetAssociatedPathOidList \- get a list of object IDs .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,29 +31,26 @@ The object ID of the multipath logical unit, initiator port, or target port. \fB\fIppList\fR\fR .ad .RS 10n -A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR structure. With a successful return, this will contain a pointer to an object ID that has type \fBMP_OID_LIST\fR that contains the object IDs of all the paths associated with the specified (multipath) logical unit, initiator port, -or target port \fIoid\fR. +or target port \fIoid\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetAssociatedPathOidList()\fR function gets a list of oid object IDs -for all the path logica l units associated with the specified multipath logical -unit , initiator port, or target port. +for all the path logical units associated with the specified multipath logical +unit, initiator port, or target port. .sp .LP -Returns a list of object IDs for all the path logical units associated with -the specified mult ipath logical unit, initiator port, or target port. +Returns a list of object IDs for all the path logical units associated with +the specified multipath logical unit, initiator port, or target port. .sp .LP When the caller is finished using the list it must free the memory used by the list by calling \fBMP_FreeOidList\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -100,8 +95,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -120,8 +113,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetPathLogicalUnitProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi index fc14a37a4f..a9ebe89d85 100644 --- a/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi @@ -4,11 +4,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 MP_GETDEVICEPRODUCTOIDLIST 3MPAPI "Feb 15, 2006" +.TH MP_GETDEVICEPRODUCTOIDLIST 3MPAPI "June 13, 2021" .SH NAME MP_GetDeviceProductOidList \- get a list of the object IDs .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,21 +31,18 @@ The object ID of the plugin. \fB\fIppList\fR\fR .ad .RS 10n -A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR structure. With a successful return, this will contain a pointer to an object ID that has type \fBMP_OID_LIST\fR that contains the object IDs of all the device product descriptors associated with the specified plugin. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetDeviceProductOidList()\fR function gets a list of the object IDs of all the device product properties associated with this plugin. When the caller is finished using the list, it must free the memory used by the list by calling \fBMP_FreeOidList\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -67,7 +62,7 @@ happen if an uninitialized object ID is passed to the API. .RS 4n The \fIppList\fR is null or specifies a memory area to which data cannot be written because the \fIoid\fR has a type subfield other -than\fBMP_OBJECT_TYPE_PLUGIN\fR. +than \fBMP_OBJECT_TYPE_PLUGIN\fR. .RE .sp @@ -77,7 +72,7 @@ than\fBMP_OBJECT_TYPE_PLUGIN\fR. .ad .sp .6 .RS 4n -The \fIoid\fR owner ID or object sequence number is invalid. +The \fIoid\fR owner ID or object sequence number is invalid. .RE .sp @@ -87,7 +82,7 @@ The \fIoid\fR owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The operation is successful +The operation is successful. .RE .sp @@ -97,7 +92,7 @@ The operation is successful .ad .sp .6 .RS 4n -The plugin for the specified object ID is not found. +The plugin for the specified object ID is not found. .RE .sp @@ -121,8 +116,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -141,8 +134,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi index 7a0be3ee1a..75fc2f7c4b 100644 --- a/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi @@ -4,12 +4,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 MP_GETDEVICEPRODUCTPROPERTIES 3MPAPI "Feb 15, 2006" +.TH MP_GETDEVICEPRODUCTPROPERTIES 3MPAPI "June 13, 2021" .SH NAME MP_GetDeviceProductProperties \- get the properties of a specified device product .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -19,7 +18,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -34,18 +32,15 @@ The object ID of the device product. \fB\fIpProps\fR\fR .ad .RS 10n -A pointer to an object ID that has type \fBMP_DEVICE_PR ODUCT_PROPERTIES\fR +A pointer to an object ID that has type \fBMP_DEVICE_PRODUCT_PROPERTIES\fR structure allocated by the caller. With a successful return, this structure contains the properties of the device product specified by the \fIoid\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetDeviceProductProperties()\fR function gets the properties of the specified device product. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -109,8 +104,6 @@ The implementation does not support the API. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -129,8 +122,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi index 0a90b43d00..b1475dc32b 100644 --- a/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi @@ -4,11 +4,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 MP_GETINITIATORPORTOIDLIST 3MPAPI "Feb 15, 2006" +.TH MP_GETINITIATORPORTOIDLIST 3MPAPI "June 13, 2021" .SH NAME MP_GetInitiatorPortOidList \- gets a list of the object IDs .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -35,19 +33,16 @@ The object ID of the plugin. .RS 10n A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR structure. With a successful return, this contains a pointer to -an\fBMP_OID_LIST\fR that contains the object IDs of all the initiator ports +an \fBMP_OID_LIST\fR that contains the object IDs of all the initiator ports associated with the specified plugin. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetInitiatorPortOidList()\fR function gets a list of the object IDs of all the initiator ports associated with this plugin. When the caller is finished using the list it must free the memory used by the list by calling \fBMP_FreeOidList\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -65,7 +60,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpplist\fR is null or specifies a memory area to which data cannot be +The \fIppList\fR is null or specifies a memory area to which data cannot be written, or when the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR. .RE @@ -77,7 +72,7 @@ written, or when the \fIoid\fR has a type subfield other than .ad .sp .6 .RS 4n -The \fIoid\fR owner ID or object sequence number is invalid. +The \fIoid\fR owner ID or object sequence number is invalid. .RE .sp @@ -101,8 +96,6 @@ A memory allocation failure occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -121,8 +114,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetInitiatorPortProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi index 2d4a75d8b2..b8bd4a1e62 100644 --- a/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi @@ -4,11 +4,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 MP_GETMPLUOIDLISTFROMTPG 3MPAPI "Feb 15, 2006" +.TH MP_GETMPLUOIDLISTFROMTPG 3MPAPI "June 13, 2021" .SH NAME MP_GetMPLuOidListFromTPG \- return a list of object IDs .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -40,8 +38,6 @@ that has type \fBMP_OID_LIST\fR that contains the object IDs of all the .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetMPLuOidListFromTPG()\fR function returns the list of object IDs for the multipath logical units associated with the specific target port group. .sp @@ -49,7 +45,6 @@ for the multipath logical units associated with the specific target port group. When the caller is finished using the list, it must free the memory used by the list by calling \fBMP_FreeOidList\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -67,7 +62,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpplist\fR is null or specifies a memory area to which data cannot be +The \fIppList\fR is null or specifies a memory area to which data cannot be written, or when the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_TARGET_PORT\fR. .RE @@ -114,8 +109,6 @@ A memory allocation failure occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -134,8 +127,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetMPLogicalUnitProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi index 5db55ddbc5..6bf2eb83fa 100644 --- a/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi @@ -4,11 +4,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 MP_GETPLUGINPROPERTIES 3MPAPI "Feb 15, 2006" +.TH MP_GETPLUGINPROPERTIES 3MPAPI "June 13, 2021" .SH NAME MP_GetPluginProperties \- get specified plugin properties .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,18 +31,15 @@ The object ID of the plugin. \fB\fIpProps\fR\fR .ad .RS 10n -A pointer to an object ID that has type \fBMP_PLUGIN_PR OPERTIES\fR structure +A pointer to an object ID that has type \fBMP_PLUGIN_PROPERTIES\fR structure allocated by the caller. With a successful return, this structure contains the properties of the plugin specified by \fIoid\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetPluginProperties()\fR function gets the properties of the specified plugin. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -88,8 +83,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -108,8 +101,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceProperties\fR(3MPAPI), \fBMP_GetPluginOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi index 553ae19835..75f866199d 100644 --- a/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi @@ -4,11 +4,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 MP_GETTARGETPORTPROPERTIES 3MPAPI "Feb 15, 2006" +.TH MP_GETTARGETPORTPROPERTIES 3MPAPI "June 13, 2021" .SH NAME -MP_GetTargetPortProperties \- get targrt port properties +MP_GetTargetPortProperties \- get target port properties .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -39,12 +37,9 @@ contains the properties of the target port group specified by the \fIoid\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_GetTargetPortProperties()\fR function returns the properties of the specified target port. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -88,8 +83,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -108,8 +101,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi index d1ed74a51e..709acfca96 100644 --- a/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi +++ b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi @@ -4,21 +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 MP_SETLOGICALUNITLOADBALANCETYPE 3MPAPI "Feb 15, 2006" +.TH MP_SETLOGICALUNITLOADBALANCETYPE 3MPAPI "June 13, 2021" .SH NAME MP_SetLogicalUnitLoadBalanceType \- set a load balancing policy .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> -\fBMP_STATUS\fR \fBMP_SetLogicalUnitLoadBalanceType\fR(\fBMP_OID\fR \fIlogicalUnitoid\fR, +\fBMP_STATUS\fR \fBMP_SetLogicalUnitLoadBalanceType\fR(\fBMP_OID\fR \fIlogicalUnitOid\fR, \fBMP_LOAD_BALANCE_TYPE\fR \fIloadBalance\fR); .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIlogicalUnitOid\fR\fR @@ -37,14 +35,11 @@ The desired load balance policy for the specified logical unit. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_SetLogicalUnitLoadBalanceType()\fR function sets the multipath logical unit's load balancing policy. The value must correspond to one of the supported values in \fBMP_PLUGIN_PROPERTIES.SupportedLogicalUnitLoadBalanceTypes\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -111,8 +106,6 @@ The implementation does not support the API. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -131,8 +124,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi index e694fe7f81..412023db25 100644 --- a/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi @@ -4,11 +4,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 MP_SETPROPRIETARYPROPERTIES 3MPAPI "Feb 15, 2006" +.TH MP_SETPROPRIETARYPROPERTIES 3MPAPI "June 13, 2021" .SH NAME MP_SetProprietaryProperties \- set proprietary properties .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,14 +17,13 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR .ad .RS 17n The object ID representing an object ID that has type -\fBMP_LOAD_BALANCE_PROPIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or +\fBMP_LOAD_BALANCE_PROPRIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR instance. .RE @@ -49,8 +47,6 @@ same number of elements as does \fIcount\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBMP_SetProprietaryProperties()\fR function sets proprietary properties in supported object instances. .sp @@ -60,7 +56,6 @@ capabilities to set proprietary properties. The \fIpPropertyList\fR is a list of property name/value pairs. The property names shall be a subset of the proprietary property names listed in the referenced object ID. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -90,7 +85,7 @@ The \fIoid\fR owner ID or object sequence number is invalid. .RS 4n The \fIpPropertyList\fR is null, or when one of the properties referenced in the list is not associated with the specified object ID, or the \fIoid\fR has a -type subfield other than\fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR, or +type subfield other than \fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR, or \fBMP_OBJECT_TYPE_PLUGIN\fR, or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE @@ -115,8 +110,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -135,8 +128,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi index 15b66c7daf..1d09b20c01 100644 --- a/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi +++ b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi @@ -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 SUN_MP_SENDSCSICMD 3MPAPI "Dec 12, 2006" +.TH SUN_MP_SENDSCSICMD 3MPAPI "June 13, 2021" .SH NAME Sun_MP_SendScsiCmd \- send a SCSI command to a logical unit .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> -#include <mpapi_sun.h> +#include <mpapi-sun.h> \fBMP_STATUS\fR \fBMP_SendScsiCmd\fR(\fBMP_OID\fR \fIoid\fR, \fBstruct uscsi_cmd *\fR\fIcmd\fR); .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -36,8 +34,6 @@ A \fBuscsi_cmd\fR structure. See \fBuscsi\fR(7I). .RE .SH DESCRIPTION -.sp -.LP The \fBSun_MP_SendScsiCmd()\fR function sends a SCSI command on a specific path to a logical unit. This function is applicable only to an OID whose \fBMP_PLUGIN_PROPERTIES\fR \fIdriverVendor\fR, as defined by the Multipath @@ -45,14 +41,13 @@ Management API, is equal to "Sun Microsystems". See \fBMP_GetPluginProperties\fR(3MPAPI) and \fIMultipath Management API Version 1.0\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR .ad .sp .6 .RS 4n -The \fIpProps\fR is null or specifies a memory area to which data cannot be +The \fIpProps\fR is null or specifies a memory area to which data cannot be written, or the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN.\fR .RE @@ -64,7 +59,7 @@ written, or the \fIoid\fR has a type subfield other than .ad .sp .6 .RS 4n -The \fIoid\fR does not specify any valid object type. This is most likely to +The \fIoid\fR does not specify any valid object type. This is most likely to happen if an uninitialized object ID is passed to the API. .RE @@ -89,13 +84,9 @@ The operation is successful. .RE .SH WARNINGS -.sp -.LP The \fBuscsi\fR command is very powerful but somewhat dangerous. See the -WARNINGS section on \fBattributes\fR(5) before using this interface. +WARNINGS section of \fBuscsi\fR(7I) before using this interface. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -112,8 +103,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetPluginProperties\fR(3MPAPI), \fBattributes\fR(5), \fBuscsi\fR(7I) .sp diff --git a/usr/src/man/man3socket/getsourcefilter.3socket b/usr/src/man/man3socket/getsourcefilter.3socket index a5239ef898..7087498ac0 100644 --- a/usr/src/man/man3socket/getsourcefilter.3socket +++ b/usr/src/man/man3socket/getsourcefilter.3socket @@ -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 GETSOURCEFILTER 3SOCKET "Aug 20, 2007" +.TH GETSOURCEFILTER 3SOCKET "June 13, 2021" .SH NAME getsourcefilter, setsourcefilter, getipv4sourcefilter, setipv4sourcefilter \- retrieve and set a socket's multicast filter .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsocket\fR [ \fIlibrary\fR... ] #include <netinet/in.h> @@ -40,7 +39,6 @@ retrieve and set a socket's multicast filter .fi .SH DESCRIPTION -.LP These functions allow applications to retrieve and modify the multicast filtering state for a tuple consisting of socket, interface, and multicast group values. @@ -108,11 +106,9 @@ number of addresses in the \fIslist\fR array. The \fIslist\fR argument points to the array of source addresses to be included or excluded, depending on the \fIfmode\fR value. .SH RETURN VALUES -.LP If successful, all four functions return \fB0\fR. Otherwise, they return \fB\(mi1\fR and set \fBerrno\fR to indicate the error. .SH ERRORS -.LP These functions will fail if: .sp .ne 2 @@ -187,7 +183,7 @@ exist; \fIgroup\fR is not being listened to on \fIinterface\fR by \fIsocket\fR. .sp .LP -The functions \fBsetsourcefilter()\fRand \fBsetipv4sourcefilter()\fR can fail +The functions \fBsetsourcefilter()\fR and \fBsetipv4sourcefilter()\fR can fail in the following additional case: .sp .ne 2 @@ -199,7 +195,6 @@ The source filter list is larger than that allowed by the implementation. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -216,7 +211,6 @@ MT-Level Safe .TE .SH SEE ALSO -.LP \fBif_nametoindex\fR(3SOCKET), \fBsocket\fR(3SOCKET), \fBsockaddr\fR(3SOCKET), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3socket/inet6_opt.3socket b/usr/src/man/man3socket/inet6_opt.3socket index b081684f7a..75aa96b066 100644 --- a/usr/src/man/man3socket/inet6_opt.3socket +++ b/usr/src/man/man3socket/inet6_opt.3socket @@ -4,13 +4,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 INET6_OPT 3SOCKET "Feb 15, 2007" +.TH INET6_OPT 3SOCKET "June 13, 2021" .SH NAME inet6_opt, inet6_opt_init, inet6_opt_append, inet6_opt_finish, inet6_opt_set_val, inet6_opt_next, inet6_opt_find, inet6_opt_get_val \- Option manipulation mechanism .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsocket\fR [\fIlibrary...\fR] #include <netinet/in.h> @@ -52,13 +51,11 @@ manipulation mechanism .LP .nf -\fBint\fR\fBinet6_opt_get_val\fR(\fBvoid *\fR\fIdatabuf\fR, \fBint\fR \fIoffset\fR, +\fBint\fR \fBinet6_opt_get_val\fR(\fBvoid *\fR\fIdatabuf\fR, \fBint\fR \fIoffset\fR, \fBvoid *\fR\fIval\fR, \fBsocklen_t *\fR\fIvallen\fR); .fi .SH DESCRIPTION -.sp -.LP The \fBinet6_opt\fR functions enable users to manipulate options without having to know the structure of the option header. .sp @@ -128,8 +125,6 @@ in the option's data portion the value should be extracted. The first byte following the option type and length is accessed by specifying an \fIoffset\fR of zero. .SH RETURN VALUES -.sp -.LP The \fBinet6_opt_init()\fR function returns the number of bytes needed for the empty extension header. If the \fIextlen\fR value is not a positive non-zero multiple of 8, the function fails and returns \fB-1\fR\&. @@ -161,8 +156,6 @@ The \fBinet6_opt_get_val()\fR function returns the \fIoffset\fR for the next field (that is, \fIoffset\fR + \fIvallen\fR) which can be used when extracting option content with multiple fields. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -179,7 +172,5 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP RFC 3542 - \fIAdvanced Sockets Application Programming Interface (API) for IPv6\fR, The Internet Society. May 2003 |
