diff options
Diffstat (limited to 'usr/src/man')
43 files changed, 454 insertions, 529 deletions
diff --git a/usr/src/man/Makefile b/usr/src/man/Makefile index a948d1256c..d2a1fbe134 100644 --- a/usr/src/man/Makefile +++ b/usr/src/man/Makefile @@ -83,6 +83,7 @@ SUBDIRS= man1 \ man3tecla \ man3tnf \ man3tsol \ + man3utempter \ man3uuid \ man3volmgt \ man3vnd \ diff --git a/usr/src/man/man1/cp.1 b/usr/src/man/man1/cp.1 index a4b71a5976..97b64289ad 100644 --- a/usr/src/man/man1/cp.1 +++ b/usr/src/man/man1/cp.1 @@ -45,11 +45,10 @@ .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved. .\" -.TH CP 1 "Apr 15, 2013" +.TH CP 1 "May 17, 2020" .SH NAME cp \- copy files .SH SYNOPSIS -.LP .nf \fB/usr/bin/cp\fR [\fB-afip@/\fR] \fIsource_file\fR \fItarget_file\fR .fi @@ -90,8 +89,6 @@ cp \- copy files .fi .SH DESCRIPTION -.sp -.LP In the first synopsis form, neither \fIsource_file\fR nor \fItarget_file\fR are directory files, nor can they have the same name. The \fBcp\fR utility copies the contents of \fIsource_file\fR to the destination path named by @@ -121,8 +118,6 @@ In the third or fourth synopsis forms, one or more directories specified by the \fB-r\fR or \fB-R\fR must be specified. For each \fIsource_dir\fR, \fBcp\fR copies all files and subdirectories. .SH OPTIONS -.sp -.LP The following options are supported for both \fB/usr/bin/cp\fR and \fB/usr/xpg4/bin/cp\fR: .sp @@ -272,8 +267,6 @@ Specifying more than one of the mutually-exclusive options \fB-H\fR, \fB-L\fR, and \fB-P\fR is not considered an error. The last option specified determines the behavior of the utility. .SS "/usr/bin/cp" -.sp -.LP If the \fB-p\fR option is specified with either the \fB-@\fR option or the \fB-/\fR option, \fB/usr/bin/cp\fR behaves as follows .RS +4 @@ -291,10 +284,8 @@ When both \fB-p\fR and \fB-/\fR are specified in any order, the copy fails if extended system attributes cannot be copied. .RE .SS "/usr/xpg4/bin/cp" -.sp -.LP If the \fB-p\fR option is specified with either the \fB-@\fR option or the -\fB-/\fR option, /\fBusr/xpg4/bin/cp\fR behaves as follows: +\fB-/\fR option, \fB/usr/xpg4/bin/cp\fR behaves as follows: .RS +4 .TP .ie t \(bu @@ -311,8 +302,6 @@ determines whether the copy fails if extended system attributes cannot be preserved. .RE .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -352,12 +341,9 @@ A pathname of a directory to contain the copied files. .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBcp\fR when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes). .SH EXAMPLES -.LP \fBExample 1 \fRCopying a File .sp .LP @@ -462,8 +448,6 @@ $ ls -/c /tmp/file1 .sp .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBcp\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. @@ -478,8 +462,6 @@ in \fBLC_CTYPE\fR determines the locale for interpretation of sequences of bytes of text data a characters, the behavior of character classes used in the expression defined for the \fByesexpr\fR. See \fBlocale\fR(5). .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -500,13 +482,8 @@ An error occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .SS "/usr/bin/cp" -.sp - -.sp .TS box; c | c @@ -519,9 +496,6 @@ Interface Stability Committed .TE .SS "/usr/xpg4/bin/cp" -.sp - -.sp .TS box; c | c @@ -534,14 +508,10 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBchmod\fR(1), \fBchown\fR(1), \fBsetfacl\fR(1), \fButime\fR(2), \fBfgetattr\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBfsattr\fR(5), \fBlargefile\fR(5), \fBlocale\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP The permission modes of the source file are preserved in the copy. .sp .LP diff --git a/usr/src/man/man1/crle.1 b/usr/src/man/man1/crle.1 index ecab0fa618..c6dabcf56f 100644 --- a/usr/src/man/man1/crle.1 +++ b/usr/src/man/man1/crle.1 @@ -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 CRLE 1 "Oct 6, 2008" +.TH CRLE 1 "Apr 15, 2020" .SH NAME crle \- configure runtime linking environment .SH SYNOPSIS -.LP .nf \fBcrle\fR [\fB-64\fR] [\fB-a\fR \fIname\fR] [\fB-A\fR \fIname\fR] [\fB-c\fR \fIconf\fR] [\fB-e\fR \fIenv\fR] [\fB-E\fR \fIenv\fR] [\fB-f\fR \fIflags\fR] [\fB-i\fR \fIname\fR] [\fB-I\fR \fIname\fR] [\fB-g\fR \fIname\fR] [\fB-G\fR \fIname\fR] @@ -15,7 +14,6 @@ crle \- configure runtime linking environment .fi .SH DESCRIPTION -.LP The \fBcrle\fR utility provides for the creation and display of a runtime linking configuration file. The configuration file is read and interpreted by the runtime linker, \fBld.so.1\fR(1), during process startup. The runtime @@ -182,7 +180,6 @@ alternate object is created in the directory specified by the preceding is created. The flags used by \fBdldump()\fR are specified using the \fB-f\fR option, or default to \fBRTLD_REL_RELATIVE\fR. .SH OPTIONS -.LP The following options are supported. .sp .ne 2 @@ -383,8 +380,8 @@ The default search paths for 32-bit \fBELF\fR objects are \fB/lib\fR followed by \fB/usr/lib\fR. For 64-bit \fBELF\fR objects, the default search paths are \fB/lib/64\fR followed by \fB/usr/lib/64\fR. .sp -The default search paths for \fBAOUT\fR objects are \fB/usr/4lib\fR, followed -by \fB/usr/lib\fR and finally \fB/usr/local/lib\fR. +The default search paths for \fBAOUT\fR objects are \fB/usr/lib\fR and +\fB/usr/local/lib\fR. .sp Use of this option \fBreplaces\fR the default search path. Therefore, a \fB-l\fR option is normally required to specify the original system default in @@ -502,7 +499,6 @@ the \fBLD_CONFIG\fR environment variable. An alternative configuration file can also be specified by recording the configuration file name in the application at the time the application is built. See the \fB-c\fR option of \fBld\fR(1). .SH EXAMPLES -.LP \fBExample 1 \fRExperimenting With a Temporary Configuration File .sp .LP @@ -792,12 +788,10 @@ together with a permanent preload object which becomes appended to the process environment definition. .SH EXIT STATUS -.LP The creation or display of a configuration file results in a \fB0\fR being returned. Otherwise, any error condition is accompanied with a diagnostic message and a non-zero value being returned. .SH NOTES -.LP The ability to tag an alternative application to use an application-specific configuration file, is possible if the original application contains one of the \fI\&.dynamic\fR tags \fBDT_FLAGS_1\fR or \fBDT_FEATURE_1\fR. Without these @@ -914,7 +908,6 @@ Audit library that is employed to \fBdldump\fR(3C) 64-bit objects. .RE .SH ENVIRONMENT VARIABLES -.LP There are no environment variables that are referenced by \fBcrle\fR. However, several environment variables affect the runtime linkers behavior in regard to the processing of configuration files that are created by \fBcrle\fR. @@ -969,7 +962,6 @@ Disable alternative object processing from a configuration file. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes. .sp @@ -984,7 +976,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBfile\fR(1), \fBld\fR(1), \fBld.so.1\fR(1), \fBdldump\fR(3C), \fBtempnam\fR(3C), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man1/elfedit.1 b/usr/src/man/man1/elfedit.1 index 7230d8ab13..b8f27fa3a9 100644 --- a/usr/src/man/man1/elfedit.1 +++ b/usr/src/man/man1/elfedit.1 @@ -4,19 +4,16 @@ .\" 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 ELFEDIT 1 "Jan 28, 2008" +.TH ELFEDIT 1 "May 17, 2020" .SH NAME elfedit \- examine or edit ELF files .SH SYNOPSIS -.LP .nf \fBelfedit\fR [\fB-adr\fR] [\fB-e\fR \fIcmd\fR] [\fB-L\fR \fIpath\fR] [\fB-o\fR \fBdefault\fR | \fBsimple\fR | \fBnum\fR] [\fIinfile\fR] [\fIoutfile\fR] .fi .SH DESCRIPTION -.sp -.LP \fBelfedit\fR is a tool for examining or modifying the contents of an existing ELF object. Specifically, \fBelfedit\fR is used to modify the ELF metadata contained in the object. Access is provided to most of the ELF data contained @@ -24,8 +21,6 @@ in an object, including the ELF header, section header table, program header table, dynamic section, hardware and software capabilities, string tables, and symbol tables. .SS "Syntax" -.sp -.LP \fBelfedit\fR processes commands from the command line (\fB-e\fR option) or from standard input. If standard input is a terminal, \fBelfedit\fR provides terminal editing capabilities, as well as extensive command completion. ELF @@ -302,8 +297,6 @@ Core built in \fBelfedit\fR commands .RE .SS "Status And Command Documentation" -.sp -.LP Status And Command Documentation .sp .LP @@ -399,8 +392,6 @@ help (\fBsys:help\fR) can be used to obtain help on itself: .sp .SS "Module Search Path" -.sp -.LP \fBelfedit\fR modules are implemented as sharable objects which are loaded on demand. When a module is required, \fBelfedit\fR searches a module path in order to locate the sharable object that implements the module. The path is a @@ -444,7 +435,7 @@ appending or prepending directories to the default path. .ad .RS 6n Root of file system tree holding the \fBelfedit\fR program, assuming that -\fBelfedit\fR is installed as \fBusr/bin/elfedi\fRt within the tree. On a +\fBelfedit\fR is installed as \fBusr/bin/elfedit\fR within the tree. On a standard system, this is simply the standard system root directory (\fB/\fR). On a development system, where the copy of \fBelfedit\fR can be installed elsewhere, the use of \fB%r\fR can be used to ensure that the matching set of @@ -507,8 +498,6 @@ The default search path can be changed by setting the \fBELFEDIT_PATH\fR environment variable, or by using the \fB-L\fR command line option. If you specify both, the \fB-L\fR option supersedes the environment variable. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -628,8 +617,6 @@ examination of files for which the user does not have write permission. .RE .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -672,8 +659,6 @@ is opened for read-only access, and the modified object contents are written to .RE .SH USAGE -.sp -.LP When supported by the system, \fBelfedit\fR runs as a 64-bit application, capable of processing files greater than or equal to 2 Gbytes (2^31 bytes). .sp @@ -702,8 +687,6 @@ If no \fB-e\fR options are specified, \fBelfedit\fR reads commands from issue the write (\fBsys:write\fR) and quit (\fBsys:quit\fR) commands to save their work and exit when running in this mode. .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -733,8 +716,6 @@ Invalid command line options were specified. .RE .SH EXAMPLES -.sp -.LP In the following examples, interactive use of \fBelfedit\fR is shown with the shell prompt (\fB%\fR) and the \fBelfedit\fR prompt (\fB>\fR). Neither of these characters should be entered by the user. @@ -866,7 +847,6 @@ STT_FUNC .sp .SH ENVIRONMENT VARIABLES -.sp .ne 2 .na \fB\fBELFEDIT_PATH\fR\fR @@ -897,7 +877,6 @@ Interactively delivers output from \fBelfedit\fR to the screen. If not set, .RE .SH FILES -.sp .ne 2 .na \fB\fB/usr/lib/elfedit\fR\fR @@ -918,8 +897,6 @@ Personal \fBtecla\fR customization file for command line editing. See .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -934,8 +911,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBdump\fR(1), \fBelfdump\fR(1), \fBld.so.1\fR(1), \fBmore\fR(1), \fBnm\fR(1), \fBpvs\fR(1), \fBelf\fR(3ELF), \fBlibelf\fR(3LIB), \fBtecla\fR(5), \fBattributes\fR(5) @@ -943,8 +918,6 @@ Interface Stability Committed .LP \fILinker and Libraries Guide\fR .SH WARNINGS -.sp -.LP \fBelfedit\fR is designed to be a tool for testing and development of the ELF system. It offers the ability to examine and change nearly every piece of ELF metadata in the object. It quietly allows edits that can produce an invalid or @@ -965,8 +938,6 @@ Higher level operations, such as the use of the \fBdyn:runpath\fR command to change the \fBrunpath\fR of an object, are safe, and can be carried out without the sort of risk detailed in this section. .SH NOTES -.sp -.LP Not every ELF operation supported by \fBelfedit\fR can be successfully carried out on every ELF object. \fBelfedit\fR is constrained by the existing sections found in the file. diff --git a/usr/src/man/man1/mail.1 b/usr/src/man/man1/mail.1 index 8aad4de37e..5d8bc7b84c 100644 --- a/usr/src/man/man1/mail.1 +++ b/usr/src/man/man1/mail.1 @@ -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 MAIL 1 "Jul 24, 2008" +.TH MAIL 1 "May 17, 2020" .SH NAME mail, rmail \- read mail or send mail to users .SH SYNOPSIS .SS "Sending Mail" -.LP .nf \fBmail\fR [\fB-tw\fR] [\fB-m\fR \fImessage_type\fR] \fIrecipient\fR... .fi @@ -60,20 +59,16 @@ mail, rmail \- read mail or send mail to users .fi .SS "Reading Mail" -.LP .nf \fBmail\fR [\fB-ehpPqr\fR] [\fB-f\fR \fIfile\fR] .fi .SS "Debugging" -.LP .nf \fBmail\fR [\fB-x\fR \fIdebug_level\fR] [\fIother_mail_options\fR] \fIrecipient\fR... .fi .SH DESCRIPTION -.sp -.LP A \fIrecipient\fR is usually a domain style address ("\fIuser\fR@\fImachine\fR") or a user name recognized by \fBlogin\fR(1). When \fIrecipient\fRs are named, \fBmail\fR assumes a message is being sent. It @@ -119,8 +114,6 @@ consists of only header lines with no message content. Header lines may be continued on the following line if that line starts with white space. .SH OPTIONS .SS "Sending Mail" -.sp -.LP The following command-line arguments affect sending mail: .sp .ne 2 @@ -202,8 +195,6 @@ extended network (such as \fBsysa!sysb!sysc!user\fR or .RE .SS "Reading Mail" -.sp -.LP The following command-line arguments affect reading mail: .sp .ne 2 @@ -545,8 +536,6 @@ preservation using the \fBDEL_EMPTY_MAILFILE\fR option of \fBmailcnfg\fR.) The group \fBID\fR of the mailfile must be \fBmail\fR to allow new messages to be delivered, and the mailfile must be writable by group \fBmail\fR. .SS "Debugging" -.sp -.LP The following command-line arguments cause \fBmail\fR to provide debugging information: .sp @@ -572,8 +561,6 @@ overrides any specification of \fBDEBUG\fR in \fB/etc/mail/mailcnfg\fR. The information provided by the \fB-x\fR option is esoteric and is probably only useful to system administrators. .SS "Delivery Notification" -.sp -.LP Several forms of notification are available for mail by including one of the following lines in the message header. .sp @@ -640,8 +627,6 @@ Same as \fB/return\fR except that the original message is not returned. The default is \fB/nodelivery/return\fR. If contradictory options are used, the first is recognized and later, conflicting, terms are ignored. .SH OPERANDS -.sp -.LP The following operand is supported for sending mail: .sp .ne 2 @@ -654,14 +639,10 @@ recognized by \fBlogin\fR(1). .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBmail\fR and \fBrmail\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 \fBmail\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. @@ -675,8 +656,6 @@ Determine the timezone used with date and time strings. .RE .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -706,7 +685,6 @@ An error occurred after initialization. .RE .SH FILES -.sp .ne 2 .na \fB\fBdead.letter\fR\fR @@ -782,15 +760,13 @@ incoming mail for \fIuser\fR; that is, the \fImailfile\fR .sp .ne 2 .na -\fB\fBvar/tmp/ma\fR*\fR +\fB\fB/var/tmp/ma\fR*\fR .ad .RS 20n temporary file .RE .SH SEE ALSO -.sp -.LP \fBchmod\fR(1), \fBcsh\fR(1), \fBlogin\fR(1), \fBmailx\fR(1), \fBuucp\fR(1C), \fBuuencode\fR(1C), \fBvacation\fR(1), \fBwrite\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5) @@ -798,8 +774,6 @@ temporary file .LP \fISolaris Advanced User\&'s Guide\fR .SH NOTES -.sp -.LP The interpretation and resulting action taken because of the header lines described in the Delivery Notifications section only occur if this version of \fBmail\fR is installed on the system where the delivery (or failure) happens. diff --git a/usr/src/man/man1/mdb.1 b/usr/src/man/man1/mdb.1 index e197836a1c..54f00f4b61 100644 --- a/usr/src/man/man1/mdb.1 +++ b/usr/src/man/man1/mdb.1 @@ -5,7 +5,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 MDB 1 "Feb 21, 2019" +.TH MDB 1 "May 20, 2020" .SH NAME mdb \- modular debugger .SH SYNOPSIS diff --git a/usr/src/man/man1/wait.1 b/usr/src/man/man1/wait.1 index 6708415364..67e87e8a95 100644 --- a/usr/src/man/man1/wait.1 +++ b/usr/src/man/man1/wait.1 @@ -45,23 +45,20 @@ .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved .\" -.TH WAIT 1 "Mar 13, 2008" +.TH WAIT 1 "May 17, 2020" .SH NAME wait \- await process completion .SH SYNOPSIS -.LP .nf .fi .SS "/bin/sh" -.LP .nf \fBwait\fR [\fIpid\fR]... .fi .SS "/bin/jsh /bin/ksh /usr/xpg4/bin/sh" -.LP .nf \fBwait\fR [\fIpid\fR]... .fi @@ -72,20 +69,16 @@ wait \- await process completion .fi .SS "/bin/csh" -.LP .nf \fBwait\fR .fi .SS "ksh93" -.LP .nf \fBwait\fR [\fIjob...\fR] .fi .SH DESCRIPTION -.sp -.LP The shell itself executes \fBwait\fR, without creating a new process. If you get the error message \fBcannot fork,too many processes\fR, try using the \fBwait\fR command to clean up your background processes. If this doesn't help, @@ -97,8 +90,6 @@ associated with your login, and to the number the system can keep track of. Not all the processes of a pipeline with three or more stages are children of the shell, and thus cannot be waited for. .SS "/bin/sh, /bin/jsh" -.sp -.LP Wait for your background process whose process \fBID\fR is \fIpid\fR and report its termination status. If \fIpid\fR is omitted, all your shell's currently active background processes are waited for and the return code is \fB0\fR. The @@ -109,12 +100,8 @@ and the argument, \fIjobid\fR, is preceded by a percent sign (\fB%\fR). If \fIpid\fR is not an active process \fBID,\fR the \fBwait\fR utility returns immediately and the return code is \fB0\fR. .SS "csh" -.sp -.LP Wait for your background processes. .SS "ksh" -.sp -.LP When an asynchronous list is started by the shell, the process \fBID\fR of the last command in each element of the asynchronous list becomes known in the current shell execution environment. @@ -138,8 +125,6 @@ is the exit status of the process requested by the last \fIpid\fR or The known process \fBID\fRs are applicable only for invocations of \fBwait\fR in the current shell execution environment. .SS "ksh93" -.sp -.LP wait with no operands, waits until all jobs known to the invoking shell have terminated. If one or more job operands are specified, wait waits until all of them have completed. Each job can be specified as one of the following: @@ -212,12 +197,10 @@ Refers to the previous job .sp .LP -If one ore more job operands is a process id or process group id not known by +If one or more job operands is a process id or process group id not known by the current shell environment, \fBwait\fR treats each of them as if it were a process that exited with status 127. .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -242,8 +225,6 @@ on systems supporting the job control option. .RE .SH USAGE -.sp -.LP On most implementations, \fBwait\fR is a shell built-in. If it is called in a subshell or separate utility execution environment, such as one of the following, @@ -262,7 +243,6 @@ find . -exec wait ... \e; it returns immediately because there is no known process \fBID\fRs to wait for in those environments. .SH EXAMPLES -.LP \fBExample 1 \fRUsing A Script To Identify The Termination Signal .sp .LP @@ -315,15 +295,11 @@ wait %% .sp .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBwait\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. .SH EXIT STATUS .SS "ksh93" -.sp -.LP The following exit values are returned by the \fBwait\fR built-in in \fBksh93\fR: .sp @@ -347,8 +323,6 @@ shell environment. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -365,7 +339,5 @@ Standard See \fBstandards\fR(5). .TE .SH SEE ALSO -.sp -.LP \fBcsh\fR(1), \fBjobs\fR(1), \fBksh\fR(1), \fBksh93\fR(1), \fBsh\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man1m/dladm.1m b/usr/src/man/man1m/dladm.1m index ffe36dfa07..77bf045e08 100644 --- a/usr/src/man/man1m/dladm.1m +++ b/usr/src/man/man1m/dladm.1m @@ -42,12 +42,12 @@ .\" .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2017 Joyent, Inc. +.\" Copyright 2020 RackTop Systems, Inc. .\" -.TH DLADM 1M "Dec 6, 2017" +.TH DLADM 1M "May 4, 2020" .SH NAME dladm \- administer data links .SH SYNOPSIS -.LP .nf \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR] \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR @@ -189,7 +189,6 @@ dladm \- administer data links .fi .SH DESCRIPTION -.LP The \fBdladm\fR command is used to administer data-links. A data-link is represented in the system as a \fBSTREAMS DLPI\fR (v2) interface which can be plumbed under protocol stacks such as \fBTCP/IP\fR. Each data-link relies on @@ -356,7 +355,6 @@ other hosts. For more information on overlay devices, see \fBoverlay\fR(5). .RE .SS "Options" -.LP Each \fBdladm\fR subcommand has its own set of options. However, many of the subcommands have the following as a common option: .sp @@ -371,7 +369,6 @@ deletion, or renaming-should apply. .RE .SS "SUBCOMMANDS" -.LP The following subcommands are supported: .sp .ne 2 @@ -4872,7 +4869,6 @@ display network usage for all links. .RE .SS "Parsable Output Format" -.LP Many \fBdladm\fR subcommands have an option that displays output in a machine-parsable format. The output format is one or more lines of colon (\fB:\fR) delimited fields. The fields displayed are specific to the subcommand @@ -4888,7 +4884,6 @@ by using shell \fBread\fR(1) functions with the environment variable \fBIFS=:\fR (see \fBEXAMPLES\fR, below). Note that escaping is not done when you request only a single field. .SS "General Link Properties" -.LP The following general link properties are supported: .sp .ne 2 @@ -5275,7 +5270,6 @@ currently running on the system. By default, the zone binding is as per .RE .SS "Wifi Link Properties" -.LP The following \fBWiFi\fR link properties are supported. Note that the ability to set a given property to a given value depends on the driver and hardware. .sp @@ -5327,7 +5321,6 @@ is no fixed speed. .RE .SS "Ethernet Link Properties" -.LP The following MII Properties, as documented in \fBieee802.3\fR(5), are supported in read-only mode: .RS +4 @@ -5488,6 +5481,75 @@ capabilities allowed by the device and the link partner. .sp .ne 2 .na +\fB\fBen_fec_cap\fR\fR +.ad +.sp .6 +.RS 4n +Sets the Forward Error Correct (FEC) code(s) to be advertised by the +device. +Valid values are: +.sp +.ne 2 +.na +\fB\fBnone\fR\fR +.ad +.sp .6 +.RS 4n +Allow the device not to use FEC. +.RE + +.sp +.ne 2 +.na +\fB\fBauto\fR\fR +.ad +.sp .6 +.RS 4n +The device will automatically decide which FEC code to use. +.RE + +.sp +.ne 2 +.na +\fB\fBrs\fR\fR +.ad +.sp .6 +.RS 4n +Allow Reed-Solomon FEC code. +.RE + +.sp +.ne 2 +.na +\fB\fBbase-r\fR\fR +.ad +.sp .6 +.RS 4n +Allow Base-R (also known as FireCode) code. +.RE + +Valid input is either \fBauto\fR as a single value, or a comma separated +combination of \fBnone\fR, \fBrs\fR and \fBbase-r\fR. +The default value is \fBauto\fR. +.sp +.LP +Note the actual FEC settings and combinations are constrained by the +capabilities allowed by the device and the link partner. +.RE + +.sp +.ne 2 +.na +\fB\fBadv_fec_cap\fR\fR +.ad +.sp .6 +.RS 4n +(read only) The current negotiated Forward Error Correction code. +.RE + +.sp +.ne 2 +.na \fB\fBsecondary-macs\fR\fR .ad .sp .6 @@ -5542,7 +5604,6 @@ The default value is \fBvlanonly\fR. .RE .SS "IP Tunnel Link Properties" -.LP The following IP tunnel link properties are supported. .sp .ne 2 @@ -5569,7 +5630,6 @@ default value is 4. A value of 0 disables the encapsulation limit. .RE .SH EXAMPLES -.LP \fBExample 1 \fRConfiguring an Aggregation .sp .LP @@ -6044,7 +6104,6 @@ interface. See \fBifconfig\fR(1M) for a description of how IPv6 addresses are configured on 6to4 tunnel links. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .LP @@ -6077,7 +6136,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBacctadm\fR(1M), \fBautopush\fR(1M), \fBifconfig\fR(1M), \fBipsecconf\fR(1M), \fBndd\fR(1M), \fBpsrset\fR(1M), \fBwpad\fR(1M), \fBzonecfg\fR(1M), \fBattributes\fR(5), \fBieee802.3\fR(5), \fBoverlay\fR(5), \fBdlpi\fR(7P) @@ -6092,7 +6150,6 @@ T. Lemon, B. Sommerfeld. February 2006. \fIRFC 4361: Node-specific Client Identifiers for Dynamic Host Configuration Protocol Version Four (DHCPv4)\fR. The Internet Society. January 2006. .SH NOTES -.LP The preferred method of referring to an aggregation in the aggregation subcommands is by its link name. Referring to an aggregation by its integer \fIkey\fR is supported for backward compatibility, but is not necessary. When diff --git a/usr/src/man/man1m/ipf.1m b/usr/src/man/man1m/ipf.1m index 5797e8c28e..121556e83c 100644 --- a/usr/src/man/man1m/ipf.1m +++ b/usr/src/man/man1m/ipf.1m @@ -3,11 +3,10 @@ .\" location. .\" Portions Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved. .\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPF 1M "April 9, 2016" +.TH IPF 1M "May 17, 2020" .SH NAME ipf \- alter packet filtering lists for IP packet input and output .SH SYNOPSIS -.LP .nf \fBipf\fR [\fB-6AdDEGInoPRrsvVyzZ\fR] [\fB-l\fR block | pass | nomatch] [\fB-T\fR \fIoptionlist\fR] [\fB-F\fR i | o | a | s | S] \fB-f\fR \fIfilename\fR @@ -15,7 +14,6 @@ ipf \- alter packet filtering lists for IP packet input and output .fi .SH DESCRIPTION -.LP The \fBipf\fR utility is part of a suite of commands associated with the Solaris IP Filter feature. See \fBipfilter\fR(5). .sp @@ -34,7 +32,6 @@ matching the order in which they appear when given to \fBipf\fR. \fB/dev/ipl\fR, and \fB/dev/ipstate\fR. The default permissions of these files require \fBipf\fR to be run as root for all operations. .SS "Enabling Solaris IP Filter Feature" -.LP Solaris IP Filter is installed with the Solaris operating system. However, packet filtering is not enabled by default. Use the following procedure to activate the Solaris IP Filter feature. @@ -61,7 +58,7 @@ See \fBipnat\fR(4). 4. (Optional) Create an address pool configuration file. See \fBippool\fR(4). .sp -Create an \fBipool.conf\fR file if you want to refer to a group of addresses as +Create an \fBippool.conf\fR file if you want to refer to a group of addresses as a single address pool. If you want the address pool configuration file to be loaded at boot time, create a file called \fB/etc/ipf/ippool.conf\fR in which to put the address pool. If you do not want the address pool configuration file @@ -158,7 +155,6 @@ If you reboot your system, the IPfilter configuration is automatically activated. .RE .SH OPTIONS -.LP The following options are supported: .sp .ne 2 @@ -469,7 +465,6 @@ affect fragment or state statistics. .RE .SH ZONES -.LP Each non-global zone has two ipfilter instances: the in-zone ipfilter, which can be controlled from both the zone itself and the global zone, and the Global Zone-controlled (GZ-controlled) instance, which can only be controlled @@ -525,7 +520,6 @@ Contains numerous IP Filter examples. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -540,7 +534,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBipfstat\fR(1M), \fBipmon\fR(1M), \fBipnat\fR(1M), \fBippool\fR(1M), \fBsvcadm\fR(1M), \fBsvc.ipfd\fR(1M), \fBipf\fR(4), \fBipnat\fR(4), \fBippool\fR(4), \fBattributes\fR(5), \fBipfilter\fR(5), \fBzones(5)\fR @@ -548,6 +541,5 @@ Interface Stability Committed .LP \fI\fR .SH DIAGNOSTICS -.LP Needs to be run as root for the packet filtering lists to actually be affected inside the kernel. diff --git a/usr/src/man/man1m/luxadm.1m b/usr/src/man/man1m/luxadm.1m index 71fc381a8c..4bd782458b 100644 --- a/usr/src/man/man1m/luxadm.1m +++ b/usr/src/man/man1m/luxadm.1m @@ -3,18 +3,16 @@ .\" 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 LUXADM 1M "May 13, 2017" +.TH LUXADM 1M "May 17, 2020" .SH NAME luxadm \- administer Sun Fire 880 storage subsystem and FC_AL devices .SH SYNOPSIS -.LP .nf \fBluxadm\fR [\fIoptions\fR]... \fIsubcommand\fR [\fIoptions\fR]... \fIenclosure\fR [,\fIdev\fR] | \fIpathname\fR... .fi .SH DESCRIPTION -.LP The \fBluxadm\fR program is an administrative command that manages the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and individual Fiber Channel Arbitrated Loop (\fBFC_AL\fR) devices. \fBluxadm\fR performs a variety @@ -36,7 +34,6 @@ of the \fBSENA\fR enclosure, and an optional identifier for the particular device in the enclosure. The individual \fBFC_AL\fR devices may be specified by entering the \fBWWN\fR for the device or a port to the device. .SS "Pathname" -.LP Specify the device or controller by either a complete physical pathname or a complete logical pathname. .sp @@ -120,7 +117,6 @@ and a typical logical pathname is: .sp .SS "Enclosure" -.LP For \fBSENA,\fR a device may be identified by its enclosure name and slotname: .br .in +2 @@ -169,7 +165,6 @@ the disk slot number in the Sun Fire 880 internal storage subsystem, \fB0\fR - See \fBdisks\fR(1M) and \fBdevlinks\fR(1M) for additional information on logical names for disks and subsystems. .SH OPTIONS -.LP The following options are supported by all subcommands: .sp .ne 2 @@ -194,7 +189,6 @@ Verbose mode. Options that are specific to particular subcommands are described with the subcommand in the \fBUSAGE\fR section. .SH OPERANDS -.LP The following operands are supported: .sp .ne 2 @@ -315,7 +309,7 @@ pathname. When the \fBSENA's\fR download is complete, the \fBSENA\fR will be reset and the downloaded code executed. If no filename is specified, the default prom image will be used. The default prom image for the \fBSENA\fR is in the -directory \fBusr/lib/locale/C/LC_MESSAGES\fR and is named \fBibfirmware\fR +directory \fB/usr/lib/locale/C/LC_MESSAGES\fR and is named \fBibfirmware\fR .sp When the Sun Fire 880 internal storage subsystem's download is complete, the subsystem resets and the downloaded code begins execution. The default firmware @@ -746,7 +740,6 @@ Spin down the specified disks in a SENA. .RE .SS "SENA, Sun Fire 880 Internal Storage Subsystem, and Individual FC_AL Drive Expert Mode Subcommands" -.LP The following subcommands are for expert use only, and are applicable only to the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and fiber channel loops. They should only be used by users that are knowledgeable about the @@ -867,7 +860,6 @@ the loop that contains the device specified by the enclosure or pathname. .RE .SS "Other Expert Mode Subcommands" -.LP See \fBNOTES\fR for limitations of these subcommands. They should only be used by users that are knowledgeable about the systems they are managing. .sp @@ -955,7 +947,6 @@ Put the specified device online. .RE .SH EXAMPLES -.LP \fBExample 1 \fRDisplaying the \fBSENA\fRs and Individual FC_AL Devices on a System .sp @@ -1207,11 +1198,9 @@ example# \fBluxadm release /dev/rdsk/c1t8d0s2\fR .sp .SH ENVIRONMENT VARIABLES -.LP See \fBenviron\fR(5) for a description of the \fBLANG\fR environment variable that affects the execution of \fBluxadm\fR. .SH EXIT STATUS -.LP The following exit values are returned: .sp .ne 2 @@ -1234,7 +1223,7 @@ An error occurred. .SH FILES .ne 2 .na -\fB\fBusr/lib/firmware/fc_s/fc_s_fcode\fR\fR +\fB\fB/usr/lib/firmware/fc_s/fc_s_fcode\fR\fR .ad .sp .6 .RS 4n @@ -1244,7 +1233,7 @@ An error occurred. .sp .ne 2 .na -\fB\fBusr/lib/locale/C/LC_MESSAGES/ibfirmware\fR\fR +\fB\fB/usr/lib/locale/C/LC_MESSAGES/ibfirmware\fR\fR .ad .sp .6 .RS 4n @@ -1252,11 +1241,9 @@ An error occurred. .RE .SH SEE ALSO -.LP \fBdevlinks\fR(1M), \fBdisks\fR(1M), \fBattributes\fR(5), \fBenviron\fR(5), \fBses\fR(7D) .SH NOTES -.LP Currently, only some device drivers support hot plugging. If hot plugging is attempted on a disk or bus where it is not supported, an error message of the form: diff --git a/usr/src/man/man1m/picld.1m b/usr/src/man/man1m/picld.1m index debb8bf9af..d233fb7444 100644 --- a/usr/src/man/man1m/picld.1m +++ b/usr/src/man/man1m/picld.1m @@ -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 PICLD 1M "Aug 10, 2004" +.TH PICLD 1M "May 16, 2020" .SH NAME picld \- PICL daemon .SH SYNOPSIS -.LP .nf \fB/usr/lib/picl/picld\fR .fi .SH DESCRIPTION -.sp -.LP The Platform Information and Control Library (\fBPICL\fR) provides a mechanism to publish platform-specific information for clients to access in a platform-independent way. \fBpicld\fR maintains and controls access to the @@ -29,8 +26,6 @@ information. After the plug-in modules are initialized, the daemon opens the \fBPICL\fR daemon door to service client requests to access information in the \fBPICL\fR tree. .SS "PICL Tree" -.sp -.LP The \fBPICL\fR tree is the repository of all the nodes and properties created by the plug-in modules to represent the platform configuration. Every node in the \fBPICL\fR tree is an instance of a well-defined \fBPICL\fR class. The name @@ -42,15 +37,13 @@ nodes in the \fBPICL\fR tree have well-known names. For example, the name of the root node of the \fBPICL\fR tree is \fB/\fR and the name of the root node of the sub-tree containing platform device nodes is \fBplatform\fR. .SS "PICL plug-in Modules" -.sp -.LP The \fBPICL\fR plug-in modules are shared objects that publish platform-specific data in the \fBPICL\fR tree. They are located in well-known directories so that the daemon can locate and load them. .sp .LP Plug-in modules are located in one of the following plug-in directories -depending on the plaform-specific nature of the data that they collect and +depending on the platform-specific nature of the data that they collect and publish: .sp .in +2 @@ -92,11 +85,8 @@ environmental information in the \fBPICL\fR tree so clients can access them. Clients use the \fBlibpicl\fR(3PICL) interface to send requests to \fBpicld\fR for accessing the \fBPICL\fR tree. .SH EXIT STATUS -.sp -.LP \fBpicld\fR does not return an exit status. .SH FILES -.sp .ne 2 .na \fB\fB/var/run/picld_door\fR\fR @@ -115,14 +105,10 @@ for accessing the \fBPICL\fR tree. .RE .SH SEE ALSO -.sp -.LP \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBdlopen\fR(3C), \fBlibpicl\fR(3PICL), \fBlibpicltree\fR(3PICLTREE), \fBpicld_log\fR(3PICLTREE), \fBpicld_plugin_register\fR(3PICLTREE), \fBattributes\fR(5), \fBsmf\fR(5) .SH NOTES -.sp -.LP The \fBpicld\fR service is managed by the service management facility, \fBsmf\fR(5), under the service identifier: .sp diff --git a/usr/src/man/man1m/plockstat.1m b/usr/src/man/man1m/plockstat.1m index d1dca3ce03..5c22d6cfaf 100644 --- a/usr/src/man/man1m/plockstat.1m +++ b/usr/src/man/man1m/plockstat.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 PLOCKSTAT 1M "Dec 10, 2017" +.TH PLOCKSTAT 1M "May 23, 2020" .SH NAME plockstat \- report user-level lock statistics .SH SYNOPSIS -.LP .nf \fBplockstat\fR [\fB-vACHV\fR] [\fB-n\fR \fIcount\fR] [\fB-s\fR \fIdepth\fR] [\fB-e\fR \fIsecs\fR] [\fB-x\fR \fIarg\fR [=val]] \fIcommand\fR [\fIarg\fR]... @@ -20,7 +19,6 @@ plockstat \- report user-level lock statistics .fi .SH DESCRIPTION -.LP The \fBplockstat\fR utility gathers and displays user-level locking statistics. By default, \fBplockstat\fR monitors all lock contention events, gathers frequency and timing data about those events, and displays the data in @@ -35,10 +33,9 @@ process specified with the \fB-p\fR option completes. it invokes to trace events of interest. This imposes a small but measurable performance overhead on the processes being observed. Users must have the \fBdtrace_proc\fR privilege and have permission to observe a particular process -with \fBplockstat\fR. Refer to the \fI\fR for more information about DTrace -security features. +with \fBplockstat\fR. Refer to the \fIDynamic Tracing Guide\fR for more +information about DTrace security features. .SH OPTIONS -.LP The following options are supported: .sp .ne 2 @@ -130,12 +127,11 @@ the option name and value with an equals sign (\fB=\fR). \fB\fB-V\fR\fR .ad .RS 16n -Print the Dtrace commands used to gather the data. The output can then be used +Print the DTrace commands used to gather the data. The output can then be used directly with the \fBdtrace\fR(1M) command. .RE .SH OPERANDS -.LP The following operands are supported: .sp .ne 2 @@ -183,7 +179,6 @@ Duration specified as a positive integer number of seconds. .RE .SH EXIT STATUS -.LP The following exit values are returned: .sp .ne 2 @@ -204,7 +199,6 @@ An error occurred. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -222,7 +216,6 @@ Interface Stability See below. .LP The command-line syntax is Evolving. The human-readable output is Unstable. .SH SEE ALSO -.LP \fBdtrace\fR(1M), \fBlockstat\fR(1M), \fBmutex_init\fR(3C), \fBpthread_mutex_lock\fR(3C), \fBpthread_rwlock_rdlock\fR(3C), \fBpthread_rwlock_wrlock\fR(3C), \fBpthread_rwlock_unlock\fR(3C), diff --git a/usr/src/man/man1m/vmstat.1m b/usr/src/man/man1m/vmstat.1m index 5c53b020fa..166ef42ae9 100644 --- a/usr/src/man/man1m/vmstat.1m +++ b/usr/src/man/man1m/vmstat.1m @@ -3,17 +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 VMSTAT 1M "April 14, 2015" +.TH VMSTAT 1M "May 6, 2020" .SH NAME vmstat \- report virtual memory statistics .SH SYNOPSIS -.LP .nf \fBvmstat\fR [\fB-ipqsS\fR] [\fB-T\fR u | d] [\fIdisks\fR] [\fIinterval\fR [\fIcount\fR]] .fi .SH DESCRIPTION -.LP \fBvmstat\fR reports virtual memory statistics regarding kernel thread, virtual memory, disk, trap, and \fBCPU\fR activity. .sp @@ -46,9 +44,8 @@ output, in one of the following forms: .sp .LP -See \fI\fR for device naming conventions for disks. +See \fBdisks\fR(1M) for device naming conventions for disks. .SH OPTIONS -.LP The following options are supported: .sp .ne 2 @@ -150,7 +147,7 @@ File system page-frees. .RE When executed in a \fBzone\fR and if the pools facility is active, all of the -above only report actitivity on the processors in the processor set of the +above only report activity on the processors in the processor set of the \fBzone\fR's pool. .RE @@ -196,7 +193,6 @@ time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See .RE .SH OPERANDS -.LP The following operands are supported: .sp .ne 2 @@ -232,7 +228,6 @@ to the \fB-i\fR and \fB-s\fR options. .RE .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBvmstat\fR .sp .LP @@ -454,7 +449,7 @@ system calls .RE When executed in a \fBzone\fR and if the pools facility is active, all of the -above only report actitivity on the processors in the processor set of the +above only report activity on the processors in the processor set of the \fBzone\fR's pool. .RE @@ -494,12 +489,11 @@ idle time .RE When executed in a \fBzone\fR and if the pools facility is active, all of the -above only report actitivity on the processors in the processor set of the +above only report activity on the processors in the processor set of the \fBzone\fR's pool. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -517,11 +511,9 @@ Interface Stability See below. .LP Invocation is evolving. Human readable output is unstable. .SH SEE ALSO -.LP -\fBdate\fR(1), \fBsar\fR(1), \fBiostat\fR(1M), \fBmpstat\fR(1M), \fBsar\fR(1M), +\fBdate\fR(1), \fBsar\fR(1), \fBdisks\fR(1M), \fBiostat\fR(1M), \fBmpstat\fR(1M), \fBsar\fR(1M), \fBtime\fR(2), \fBattributes\fR(5) .SH NOTES -.LP The sum of CPU utilization might vary slightly from 100 because of rounding errors in the production of a percentage figure. .sp diff --git a/usr/src/man/man1m/zpool.1m b/usr/src/man/man1m/zpool.1m index 5a793062f2..6d291ba46a 100644 --- a/usr/src/man/man1m/zpool.1m +++ b/usr/src/man/man1m/zpool.1m @@ -28,7 +28,7 @@ .\" Copyright 2020 Joyent, Inc. .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved. .\" -.Dd August 30, 2019 +.Dd April 29, 2020 .Dt ZPOOL 1M .Os .Sh NAME @@ -61,6 +61,7 @@ .Op Fl B .Op Fl m Ar mountpoint .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Cm feature@ Ns Ar feature Ns = Ns Ar value Oc Ns ... .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ... .Op Fl R Ar root .Op Fl t Ar tempname @@ -1045,6 +1046,7 @@ another host, and resuming I/O could result in pool damage. .Op Fl B .Op Fl m Ar mountpoint .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Cm feature@ Ns Ar feature Ns = Ns Ar value Oc Ns ... .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ... .Op Fl R Ar root .Op Fl t Ar tempname @@ -1175,6 +1177,17 @@ Sets the given pool properties. See the .Sx Properties section for a list of valid properties that can be set. +.It Fl o Cm feature@ Ns Ar feature Ns = Ns Ar value +Sets the given pool feature. +See +.Xr zpool-features 5 +for a list of valid features that can be set. +.Pp +.Ar value +can either be +.Sy disabled +or +.Sy enabled . .It Fl O Ar file-system-property Ns = Ns Ar value Sets the given file system properties in the root file system of the pool. See the diff --git a/usr/src/man/man2/sysinfo.2 b/usr/src/man/man2/sysinfo.2 index fc85af6b0e..6815dbc229 100644 --- a/usr/src/man/man2/sysinfo.2 +++ b/usr/src/man/man2/sysinfo.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 SYSINFO 2 "Sep 7, 2015" +.TH SYSINFO 2 "Apr 27, 2020" .SH NAME sysinfo \- get and set system information strings .SH SYNOPSIS @@ -177,6 +177,18 @@ compilation system. .sp .ne 2 .na +\fB\fBSI_ADDRESS_WIDTH\fR\fR +.ad +.sp .6 +.RS 4n +Copy into the array pointed to by \fIbuf\fR a string describing the number +of bits in the address space of the native instruction set; e.g., \fB32\fR +or \fB64\fR. +.RE + +.sp +.ne 2 +.na \fB\fBSI_ISALIST\fR\fR .ad .sp .6 diff --git a/usr/src/man/man3c/dlopen.3c b/usr/src/man/man3c/dlopen.3c index b72d070579..4836a95562 100644 --- a/usr/src/man/man3c/dlopen.3c +++ b/usr/src/man/man3c/dlopen.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 DLOPEN 3C "Sep 7, 2015" +.TH DLOPEN 3C "May 16, 2020" .SH NAME dlopen, dlmopen \- gain access to an executable object file .SH SYNOPSIS -.LP .nf #include <dlfcn.h> #include <link.h> @@ -21,7 +20,6 @@ dlopen, dlmopen \- gain access to an executable object file .fi .SH DESCRIPTION -.LP The \fBdlopen()\fR function makes an executable object file available to a running process. \fBdlopen()\fR returns to the process a \fIhandle\fR that the process can use on subsequent calls to \fBdlsym\fR(3C), \fBdladdr\fR(3C), @@ -130,7 +128,7 @@ of other objects that include the same group. The program image file and any objects loaded at program startup have the mode \fBRTLD_GLOBAL\fR. The mode \fBRTLD_LOCAL\fR is the default mode for any objects that are acquired with \fBdlopen()\fR. A local object can be a -dependency of more then one group. Any object of mode \fBRTLD_LOCAL\fR that is +dependency of more than one group. Any object of mode \fBRTLD_LOCAL\fR that is referenced as a dependency of an object of mode \fBRTLD_GLOBAL\fR is promoted to \fBRTLD_GLOBAL\fR. In other words, the \fBRTLD_LOCAL\fR mode is ignored. .sp @@ -273,7 +271,6 @@ are opened on a new link-map list must express all of their dependencies. .RE .SH RETURN VALUES -.LP The \fBdlopen()\fR function returns \fINULL\fR if \fIpathname\fR cannot be found, cannot be opened for reading, or is not a shared object or a relocatable object. \fBdlopen()\fR also returns \fINULL\fR if an error occurs during the @@ -281,13 +278,11 @@ process of loading \fIpathname\fR or relocating its symbolic references. See \fBNOTES\fR. Additional diagnostic information is available through \fBdlerror()\fR. .SH USAGE -.LP The \fBdlopen()\fR and \fBdlmopen()\fR functions are members of a family of functions that give the user direct access to the dynamic linking facilities. This family of functions is available only to dynamically-linked processes. See the \fILinker and Libraries Guide\fR. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -304,7 +299,6 @@ MT\(miLevel MT\(miSafe .TE .SH SEE ALSO -.LP \fBld\fR(1), \fBld.so.1\fR(1), \fBdladdr\fR(3C), \fBdlclose\fR(3C), \fBdldump\fR(3C), \fBdlerror\fR(3C), \fBdlinfo\fR(3C), \fBdlsym\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) @@ -312,7 +306,6 @@ MT\(miLevel MT\(miSafe .LP \fILinker and Libraries Guide\fR .SH NOTES -.LP If \fIpathname\fR has dependencies on other objects, these objects are automatically loaded by \fBdlopen()\fR. The directory search path used to find \fIpathname\fR and any dependencies can be affected by setting the environment diff --git a/usr/src/man/man3c/sysconf.3c b/usr/src/man/man3c/sysconf.3c index 570c9709ae..2c5cd02f3a 100644 --- a/usr/src/man/man3c/sysconf.3c +++ b/usr/src/man/man3c/sysconf.3c @@ -45,11 +45,10 @@ .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. .\" Copyright (c) 2013 Gary Mills .\" -.TH SYSCONF 3C "Apr 16, 2013" +.TH SYSCONF 3C "May 04, 2020" .SH NAME sysconf \- get configurable system variables .SH SYNOPSIS -.LP .nf #include <unistd.h> @@ -57,8 +56,6 @@ sysconf \- get configurable system variables .fi .SH DESCRIPTION -.sp -.LP The \fBsysconf()\fR function provides a method for an application to determine the current value of a configurable system limit or option (variable). .sp @@ -319,6 +316,12 @@ _SC_TTY_NAME_MAX TTYNAME_MAX Max length of tty _SC_TZNAME_MAX TZNAME_MAX Max number of bytes supported for name of a time zone +_SC_UADDR_MAX Maximum valid user + address in a process. + The returned value + should be cast to a + uintptr_t before + being interpreted. _SC_V6_ILP32_OFF32 _POSIX_V6_ILP32_OFF32 Supports X/Open ILP32 w/32-bit offset build @@ -424,8 +427,6 @@ l l . .TE .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBsysconf()\fR returns the current variable value on the system. The value returned will not be more restrictive than the corresponding value described to the application when it was compiled with the @@ -474,8 +475,6 @@ _SC_SPLIT_CACHE .in -2 .SH ERRORS -.sp -.LP The \fBsysconf()\fR function will fail if: .sp .ne 2 @@ -487,8 +486,6 @@ The value of the \fIname\fR argument is invalid. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -509,13 +506,9 @@ Standard See \fBstandards\fR(5). .TE .SH SEE ALSO -.sp -.LP \fBpooladm\fR(1M), \fBzoneadm\fR(1M), \fBfpathconf\fR(2), \fBseteuid\fR(2), \fBsetrlimit\fR(2), \fBconfstr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP A call to \fBsetrlimit()\fR can cause the value of \fBOPEN_MAX\fR to change. .sp .LP diff --git a/usr/src/man/man3ext/efi_alloc_and_init.3ext b/usr/src/man/man3ext/efi_alloc_and_init.3ext index bd7bb22af6..ad4c21a543 100644 --- a/usr/src/man/man3ext/efi_alloc_and_init.3ext +++ b/usr/src/man/man3ext/efi_alloc_and_init.3ext @@ -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 EFI_ALLOC_AND_INIT 3EXT "November 20, 2019" +.TH EFI_ALLOC_AND_INIT 3EXT "May 16, 2020" .SH NAME efi_alloc_and_init, efi_alloc_and_read, efi_free, efi_write, efi_use_whole_disk, efi_reserved_sectors \- manipulate a disk's EFI Partition Table @@ -100,7 +100,7 @@ struct dk_part efi_parts[]; /* array of partitions */ .SS "Protective Master Boot Record" When a disk receives an EFI label, a protective MBR (\fBPMBR\fR) is also -written containing a single partiton of type \fBEEh\fR and spanning the +written containing a single partition of type \fBEEh\fR and spanning the entire disk (up to the limit of what can be represented in an MBR). By default that partition is placed in slot 0 of the PMBR and not marked as active. Some BIOS implementations contain bugs that require the entry to be diff --git a/usr/src/man/man3picl/picl_get_propinfo.3picl b/usr/src/man/man3picl/picl_get_propinfo.3picl index 1581d57e5a..ddf18cbb4b 100644 --- a/usr/src/man/man3picl/picl_get_propinfo.3picl +++ b/usr/src/man/man3picl/picl_get_propinfo.3picl @@ -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 PICL_GET_PROPINFO 3PICL "Mar 28, 2000" +.TH PICL_GET_PROPINFO 3PICL "May 16, 2020" .SH NAME picl_get_propinfo \- get the information about a property .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ] #include <picl.h> @@ -17,8 +16,6 @@ picl_get_propinfo \- get the information about a property .fi .SH DESCRIPTION -.sp -.LP The \fBpicl_get_propinfo()\fR function gets the information about the property specified by handle \fIproph\fR and copies it into the location specified by \fIpinfo\fR. The property information includes the property type, access mode, @@ -29,8 +26,6 @@ page. The maximum size of a property value is specified by \fBPICL_PROPSIZE_MAX\fR. It is currently set to 512KB. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fB0\fR is returned. On failure, a non-negative integer is returned to indicate an error. .sp @@ -44,7 +39,6 @@ This error may be returned for a previously valid handle if the daemon was brought down and restarted. When this occurs a client must revalidate any saved handles. .SH ERRORS -.sp .ne 2 .na \fB\fBPICL_NOTINITIALIZED\fR\fR @@ -86,7 +80,7 @@ Invalid handle specified \fB\fBPICL_STALEHANDLE\fR\fR .ad .RS 23n -Stale handle specifie +Stale handle specified .RE .sp @@ -99,8 +93,6 @@ General system failure .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -115,7 +107,5 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBlibpicl\fR(3PICL), \fBpicl_get_propval\fR(3PICL), \fBpicl_get_propval_by_name\fR(3PICL), \fBattributes\fR(5) diff --git a/usr/src/man/man3picltree/libpicltree.3picltree b/usr/src/man/man3picltree/libpicltree.3picltree index 2651d0d63d..3732c1a259 100644 --- a/usr/src/man/man3picltree/libpicltree.3picltree +++ b/usr/src/man/man3picltree/libpicltree.3picltree @@ -3,19 +3,16 @@ .\" 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 LIBPICLTREE 3PICLTREE "Mar 1, 2004" +.TH LIBPICLTREE 3PICLTREE "May 16, 2020" .SH NAME libpicltree \- PTree and Plug-in Registration interface library .SH SYNOPSIS -.LP .nf \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile \fR\&.\|.\|. \fB-lpicltree\fR [\fIlibrary \&.\|.\|.\fR] #include <picltree.h> .fi .SH DESCRIPTION -.sp -.LP The PTree interface is the set of functions and data structures to access and manipulate the PICL tree. The daemon and the plug-in modules use the PTree interface. @@ -53,8 +50,6 @@ properties. The maximum size of a property value cannot exceed \fBPICL_PROPSIZE_MAX\fR. It is currently set to 512KB. .SS "Volatile Properties" -.sp -.LP In addition to \fBPICL_READ\fR and \fBPICL_WRITE\fR property access modes, the plug-in modules specify whether a property is volatile or not by setting the bit \fBPICL_VOLATILE\fR. @@ -142,11 +137,9 @@ the maximum possible size of the value. The maximum size of the value cannot exceed \fBPICL_PROPSIZE_MAX\fR. This allows a client to allocate a sufficiently large buffer before retrieving a volatile property's value .SS "Plug-in Modules" -.sp -.LP Plug-in modules are shared objects that are located in well-known directories -for the daemon to locate and load them. Plug-in module's are located in the one -of the following plug-in directories depending on the plaform-specific nature +for the daemon to locate and load them. Plug-in modules are located in the one +of the following plug-in directories depending on the platform-specific nature of the data they collect and publish. .sp .in +2 @@ -171,8 +164,6 @@ registration. The plug-in modules may use the \fBpicld_log\fR(3PICLTREE) function to log their messages to the system log file. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -187,7 +178,5 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBlibpicl\fR(3PICL), \fBlibpicltree\fR(3LIB), \fBpicld_log\fR(3PICLTREE), \fBpicld_plugin_register\fR(3PICLTREE), \fBattributes\fR(5) diff --git a/usr/src/man/man3pool/pool_get_property.3pool b/usr/src/man/man3pool/pool_get_property.3pool index 410c40ded2..39ac2fb084 100644 --- a/usr/src/man/man3pool/pool_get_property.3pool +++ b/usr/src/man/man3pool/pool_get_property.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_GET_PROPERTY 3POOL "Sep 23, 2003" +.TH POOL_GET_PROPERTY 3POOL "May 16, 2020" .SH NAME pool_get_property, pool_put_property, pool_rm_property, pool_walk_properties \- resource pool element property manipulation .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ] #include <pool.h> @@ -38,8 +37,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\| .fi .SH DESCRIPTION -.sp -.LP The various pool types are converted to the common pool element type (\fBpool_elem_t\fR) before property manipulation. A \fBpool_value_t\fR is an opaque type that contains a property value of one of the following types: @@ -110,7 +107,7 @@ error. .LP The \fBpool_rm_property()\fR function attempts to remove the named property from the element. If the property does not exist or is not removable, -1 is -returned and \fBpool_error\fR(3POOL) reporst an error of \fBPOE_PUTPROP\fR. +returned and \fBpool_error\fR(3POOL) reports an error of \fBPOE_PUTPROP\fR. .sp .LP The \fBpool_walk_properties()\fR function invokes \fIcallback\fR on all @@ -123,8 +120,6 @@ A number of special properties are reserved for internal use and cannot be set or removed. Attempting to do so will fail. These properties are documented on the \fBlibpool\fR(3LIB) manual page. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBpool_get_property()\fR returns the type of the property. Otherwise it returns \fBPOC_INVAL\fR and \fBpool_error()\fR returns the pool-specific error value. @@ -134,8 +129,6 @@ Upon successful completion, \fBpool_put_property()\fR, \fBpool_rm_property()\fR, and \fBpool_walk_properties()\fR return 0. Otherwise they return \(mi1 and \fBpool_error()\fR returns the pool-specific error value. .SH ERRORS -.sp -.LP The \fBpool_get_property()\fR function will fail if: .sp .ne 2 @@ -253,8 +246,6 @@ A system error has occurred. Check the system error code for more details. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -273,6 +264,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/man3proc/Pclearsig.3proc b/usr/src/man/man3proc/Pclearsig.3proc index 23f81df918..116e23c391 100644 --- a/usr/src/man/man3proc/Pclearsig.3proc +++ b/usr/src/man/man3proc/Pclearsig.3proc @@ -11,7 +11,7 @@ .\" .\" Copyright 2015 Joyent, Inc. .\" -.Dd May 11, 2016 +.Dd May 16, 2020 .Dt PCLEARSIG 3PROC .Os .Sh NAME @@ -50,7 +50,7 @@ The function is identical to the .Fn Pclearsig function, except rather than operating on the process and its -representive thread, it instead operates on the thread handle +representative thread, it instead operates on the thread handle .Fa L . .Pp The diff --git a/usr/src/man/man3proc/Plwp_getregs.3proc b/usr/src/man/man3proc/Plwp_getregs.3proc index e11f4f5fa2..7b7d3b4d3d 100644 --- a/usr/src/man/man3proc/Plwp_getregs.3proc +++ b/usr/src/man/man3proc/Plwp_getregs.3proc @@ -11,7 +11,7 @@ .\" .\" Copyright 2015 Joyent, Inc. .\" -.Dd May 11, 2016 +.Dd May 02, 2020 .Dt PLWP_GETREGS 3PROC .Os .Sh NAME @@ -40,13 +40,13 @@ .Fo Plwp_getregs .Fa "struct ps_prochandle *P" .Fa "lwpid_t lwpid" -.Fa "prpregset_t *gregs" +.Fa "prgregset_t gregs" .Fc .Ft int .Fo Plwp_setregs .Fa "struct ps_prochandle *P" .Fa "lwpid_t lwpid" -.Fa "const prpregset_t gregs" +.Fa "const prgregset_t gregs" .Fc .Sh DESCRIPTION The @@ -98,8 +98,8 @@ Processes may be stopped with .Xr Pstop 3PROC . The structures used for registers are described in .Xr proc 4 -and their defintions may be found in -.In sys/regset.h . +and their definitions may be found in +.In procfs.h . The definitions of these structures varies based on the architecture of the system and the running process. .Pp diff --git a/usr/src/man/man3proc/Pstopstatus.3proc b/usr/src/man/man3proc/Pstopstatus.3proc index 15f9f417f6..07a500c8a7 100644 --- a/usr/src/man/man3proc/Pstopstatus.3proc +++ b/usr/src/man/man3proc/Pstopstatus.3proc @@ -11,7 +11,7 @@ .\" .\" Copyright 2015 Joyent, Inc. .\" -.Dd May 11, 2016 +.Dd May 02, 2020 .Dt PSTOPSTATUS 3PROC .Os .Sh NAME @@ -40,10 +40,12 @@ .Ft int .Fo Pstop .Fa "struct ps_prochandle *P" +.Fa "uint_t msec" .Fc .Ft int .Fo Pwait .Fa "struct ps_prochandle *P" +.Fa "uint_t msec" .Fc .Ft int .Fo Ldstop @@ -52,10 +54,12 @@ .Ft int .Fo Lstop .Fa "struct ps_lwphandle *L" +.Fa "uint_t msec" .Fc .Ft int .Fo Lwait .Fa "struct ps_lwphandle *L" +.Fa "uint_t msec" .Fc .Sh DESCRIPTION The @@ -133,16 +137,14 @@ The function is is equivalent to calling the .Fn Pstopstatus function with the request set to -.Dv PCSTOP -and an infinite timeout. +.Dv PCSTOP . .Pp The .Fn Pwait function is is equivalent to calling the .Fn Pstopstatus function with the request set to -.Dv PCWSTOP -and an infinite timeout. +.Dv PCWSTOP . .Pp The .Fn Pdstop diff --git a/usr/src/man/man3utempter/Makefile b/usr/src/man/man3utempter/Makefile new file mode 100644 index 0000000000..a61f7696e6 --- /dev/null +++ b/usr/src/man/man3utempter/Makefile @@ -0,0 +1,35 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +include $(SRC)/Makefile.master + +MANSECT= 3utempter + +MANFILES= utempter_add_record.3utempter + +MANLINKS= addToUtmp.3utempter \ + removeFromUtmp.3utempter \ + removeLineFromUtmp.3utempter \ + utempter_remove_added_record.3utempter \ + utempter_remove_record.3utempter + + +addToUtmp.3utempter := LINKSRC = utempter_add_record.3utempter +removeFromUtmp.3utempter := LINKSRC = utempter_add_record.3utempter +removeLineFromUtmp.3utempter := LINKSRC = utempter_add_record.3utempter +utempter_remove_added_record.3utempter := LINKSRC = utempter_add_record.3utempter +utempter_remove_record.3utempter := LINKSRC = utempter_add_record.3utempter + +.KEEP_STATE: + +include $(SRC)/man/Makefile.man + +install: $(ROOTMANFILES) $(ROOTMANLINKS) diff --git a/usr/src/man/man3utempter/utempter_add_record.3utempter b/usr/src/man/man3utempter/utempter_add_record.3utempter new file mode 100644 index 0000000000..da6cbb7211 --- /dev/null +++ b/usr/src/man/man3utempter/utempter_add_record.3utempter @@ -0,0 +1,134 @@ +.\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.Dd May 5, 2020 +.Dt UTEMPTER_ADD_RECORD 3UTEMPTER +.Os +.Sh NAME +.Nm utempter_add_record , +.Nm utempter_remove_added_record , +.Nm utempter_remove_record , +.Nm addToUtmp , +.Nm removeFromUtmp , +.Nm removeLineFromUtmp +.Nd utempter compatibility interface +.Sh LIBRARY +.Lb libutempter +.Sh SYNOPSIS +.In utempter.h +.Ft int +.Fn utempter_add_record "int fd" "const char *host" +.Ft int +.Fn utempter_remove_added_record "void" +.Ft int +.Fn utempter_remove_record "int fd" +.Ft void +.Fn addToUtmp "const char *pty" "const char *host" "int fd" +.Ft void +.Fn removeFromUtmp "void" +.Ft void +.Fn removeLineFromUtmp "const char *pty" "int fd" +.Sh DESCRIPTION +These functions provide an interface for terminal emulators such as tmux, +screen, and xterm to record user sessions to +.Xr utmpx 4 +database. +Note that they are best effort and may not succeed. +If consumers need to know for certain that they have successfully updated the +.Xr utmpx 4 +database, these functions should not be used because they cannot communicate +that for compatibility reasons. +.Pp +The +.Fn utempter_add_record +and +.Fn addToUtmp +functions add a login record to the +.Xr utmpx 4 +database for the TTY belonging to the pseudo-terminal master file descriptor +.Fa fd , +using the username corresponding with the real user ID of the calling +process and the optional hostname +.Fa host , +limited to 256 characters, that is the size of +.Va ut_host +member of +.Vt struct utmpx +minus terminating NUL character. +.Pp +The +.Fn utempter_remove_record +and +.Fn removeLineFromUtmp +functions mark the login session as being closed for the TTY belonging +to the pseudo-terminal master file descriptor +.Fa fd . +.Pp +The +.Fn utempter_remove_added_record +and +.Fn removeFromUtmp +functions have the same properties as the previously mentioned +functions, except that they use an internally cached value of the file +descriptor passed to +.Fn utempter_add_record +and +.Fn addToUtmp . +.Pp +In this implementation, the +.Fa pty +arguments of +.Fn addToUtmp +and +.Fn removeLineFromUtmp +are ignored, and database entries are driven entirely by the +.Fa fd +argument. +.Sh RETURN VALUES +The +.Fn utempter_add_record , +.Fn utempter_remove_added_record +and +.Fn utempter_remove_record +functions always return a value of 0. +.Sh INTERFACE STABILITY +.Fn utempter_add_record , +.Fn utempter_remove_added_record , +and +.Fn utempter_remove_record +are +.Sy Committed . +.Fn addToUtmp , +.Fn removeFromUtmp , +and +.Fn removeLineFromUtmp +are +.Sy Obsolete Committed . +.Sh MT-LEVEL +.Sy Unsafe +.Sh SEE ALSO +.Xr pututxline 3c , +.Xr utmpx 3head , +.Xr utmpx 4 diff --git a/usr/src/man/man4/ippool.4 b/usr/src/man/man4/ippool.4 index d70b5cad9a..1b6586a4b0 100644 --- a/usr/src/man/man4/ippool.4 +++ b/usr/src/man/man4/ippool.4 @@ -1,10 +1,10 @@ '\" te .\" To view license terms, attribution, and copyright for IP Filter, the -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Illumos operating +.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the illumos operating .\" environment has been installed anywhere other than the default, modify the .\" given path to access the file at the installed location. .\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPPOOL 4 "April 9, 2016" +.TH IPPOOL 4 "May 16, 2020" .SH NAME ippool, ippool.conf \- IP Pool file format .SH DESCRIPTION @@ -62,7 +62,6 @@ of a mixture of netmask sizes, from 0 to 32. .PP At this point in time, only IPv4 addressing is supported. .SH OVERVIEW -.PP The IP pool configuration file provides for defining two different mechanisms for improving speed in matching IP addresses with rules. The first, @@ -86,7 +85,6 @@ or respectively, for determining which filter group to jump to next for continuation of filter packet processing. .SH POOL TYPES -.PP Two storage formats are provided: hash tables and tree structure. The hash table is intended for use with objects all containing the same netmask or a few different sized netmasks of non-overlapping address space and the tree @@ -96,8 +94,7 @@ to use the tree data storage type with .B group-map configuration entries. .SH POOL ROLES -.PP -When a pool is defined in the configruation file, it must have an associated +When a pool is defined in the configuration file, it must have an associated role. At present the only supported role is .B ipf. Future development will see further expansion of their use by other sections diff --git a/usr/src/man/man4/krb5.conf.4 b/usr/src/man/man4/krb5.conf.4 index c97d2a7eae..4d18ab5362 100644 --- a/usr/src/man/man4/krb5.conf.4 +++ b/usr/src/man/man4/krb5.conf.4 @@ -3,17 +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 KRB5.CONF 4 "Nov 26, 2017" +.TH KRB5.CONF 4 "May 16, 2020" .SH NAME krb5.conf \- Kerberos configuration file .SH SYNOPSIS -.LP .nf /etc/krb5/krb5.conf .fi .SH DESCRIPTION -.LP The \fBkrb5.conf\fR file contains Kerberos configuration information, including the locations of \fBKDC\fRs and administration daemons for the Kerberos realms of interest, defaults for the current realm and for Kerberos applications, and @@ -141,7 +139,6 @@ For a Key Distribution Center (\fBKDC\fR), can contain the location of the .RE .SS "The \fB[libdefaults]\fR Section" -.LP The \fB[libdefaults]\fR section can contain any of the following relations: .sp .ne 2 @@ -346,7 +343,7 @@ above. Indicates whether DNS SRV records need to be used to locate the KDCs and the other servers for a realm, if they have not already been listed in the \fB[realms]\fR section. This option makes the machine vulnerable to a certain -type of DoS attack if somone spoofs the DNS records and does a redirect to +type of DoS attack if someone spoofs the DNS records and does a redirect to another server. This is, however, no worse than a DoS, since the bogus KDC is unable to decode anything sent (excepting the initial ticket request, which has no encrypted data). Also, anything the fake KDC sends out isl not trusted @@ -407,7 +404,6 @@ to make it a network-wide setting for all realms. .RE .SS "The \fB[appdefaults]\fR Section" -.LP This section contains subsections for Kerberos V5 applications, where \fIrelation-subsection\fR is the name of an application. Each subsection contains relations that define the default behaviors for that application. @@ -589,7 +585,6 @@ In the following example, \fBkinit\fR gets forwardable tickets by default and The application defaults specified here are overridden by those specified in the \fB[realms]\fR section. .SS "The \fB[realms]\fR Section" -.LP This section contains subsections for Kerberos realms, where \fIrelation-subsection\fR is the name of a realm. Each subsection contains relations that define the properties for that particular realm. The following @@ -869,7 +864,6 @@ parameters. Most often, you need to specify them only when using a non-Solaris-based Kerberos server. Otherwise, the change request is sent over \fBRPCSEC_GSS\fR to the Solaris Kerberos administration server. .SS "The \fB[domain_realm]\fR Section" -.LP This section provides a translation from a domain name or hostname to a Kerberos realm name. The \fIrelation\fR can be a host name, or a domain name, where domain names are indicated by a period (`\fB\&.\fR') prefix. @@ -902,7 +896,6 @@ default into the \fBFUBAR.ORG\fR realm. The entries for the hosts \fBmit.edu\fR and \fBfubar.org\fR. Without these entries, these hosts would be mapped into the Kerberos realms \fBEDU\fR and \fBORG\fR, respectively. .SS "The \fB[logging]\fR Section" -.LP This section indicates how Kerberos programs are to perform logging. There are two types of relations for this section: relations to specify how to log and a relation to specify how to rotate \fBkdc\fR log files. @@ -1111,7 +1104,6 @@ with a specified time interval of a day. .sp .SS "The \fB[capaths]\fR Section" -.LP In order to perform direct (non-hierarchical) cross-realm authentication, a database is needed to construct the authentication paths between the realms. This section defines that database. @@ -1215,7 +1207,6 @@ In the above examples, the ordering is not important, except when the same relation is used more than once. The client uses this to determine the path. (It is not important to the server, since the transited field is not sorted.) .SS "PKINIT-specific Options" -.LP The following are \fBpkinit-specific\fR options. These values can be specified in \fB[libdefaults]\fR as global defaults, or within a realm-specific subsection of \fB[libdefaults]\fR, or can be specified as realm-specific values @@ -1646,7 +1637,6 @@ been set to \fBFILE:/tmp/my_proxy.pem\fR. .RE .SS "The \fB[dbmodules]\fR Section" -.LP This section consists of relations that provide configuration information for plug-in modules. In particular, the relations describe the configuration for LDAP KDB plug-in. Use of the \fBdb2\fR KDB plug-in is the default behavior and @@ -1761,7 +1751,6 @@ Port number for SSL connection with directory server. The default is \fB389\fR. .RE .SH EXAMPLES -.LP \fBExample 1 \fRSample File .sp .LP @@ -1840,7 +1829,6 @@ a Kerberos configuration file when the KDC is using the LDAP KDB plug-in. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -1859,12 +1847,10 @@ Interface Stability See below. All of the keywords are Committed, except for the \fBPKINIT\fR keywords, which are Volatile. .SH SEE ALSO -.LP \fBkinit\fR(1), \fBrcp\fR(1), \fBrdist\fR(1), \fBrlogin\fR(1), \fBrsh\fR(1), \fBtelnet\fR(1), \fBsyslog\fR(3C), \fBattributes\fR(5), \fBkerberos\fR(5), \fBregex\fR(5) .SH NOTES -.LP If the \fBkrb5.conf\fR file is not formatted properly, the \fBtelnet\fR command fails. However, the \fBdtlogin\fR and \fBlogin\fR commands still succeed, even if the \fBkrb5.conf\fR file is specified as required for the commands. If this diff --git a/usr/src/man/man4/proc.4 b/usr/src/man/man4/proc.4 index 4fc8647c7f..e42afdd1fc 100644 --- a/usr/src/man/man4/proc.4 +++ b/usr/src/man/man4/proc.4 @@ -18,7 +18,7 @@ .\" fields enclosed by brackets "[]" replaced with your own identifying .\" information: Portions Copyright [yyyy] [name of copyright owner] .\" -.Dd January 6, 2020 +.Dd May 17, 2020 .Dt PROC 4 .Os .Sh NAME @@ -483,7 +483,7 @@ is the total number of active lwps in the process. is the total number of zombie lwps in the process. A zombie lwp is a non-detached lwp that has terminated but has not been reaped with -.Xr thr_join 3 +.Xr thr_join 3C or .Xr pthread_join 3C . .Pp diff --git a/usr/src/man/man4/securenets.4 b/usr/src/man/man4/securenets.4 index 5500c61fa6..825b72f835 100644 --- a/usr/src/man/man4/securenets.4 +++ b/usr/src/man/man4/securenets.4 @@ -4,18 +4,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 SECURENETS 4 "Apr 26, 1999" +.TH SECURENETS 4 "May 16, 2020" .SH NAME securenets \- configuration file for NIS security .SH SYNOPSIS -.LP .nf \fB/var/yp/securenets\fR .fi .SH DESCRIPTION -.sp -.LP The \fB/var/yp/securenets\fR file defines the networks or hosts which are allowed access to information by the Network Information Service ("\fBNIS\fR"). .sp @@ -66,7 +63,6 @@ hosts 127.0.0.1 .sp .SH EXAMPLES -.LP \fBExample 1 \fRAccess for Individual Entries .sp .LP @@ -121,7 +117,7 @@ The entry for access to a class B network could be: .sp .LP -\fBExample 4 \fRAccess for an Invidual IPv6 Address +\fBExample 4 \fRAccess for an Individual IPv6 Address .sp .LP Similarly, to allow access for an individual IPv6 address: @@ -161,7 +157,6 @@ ffff:: fe80:: .sp .SH FILES -.sp .ne 2 .na \fB\fB/var/yp/securenets\fR\fR @@ -171,12 +166,8 @@ Configuration file for \fBNIS\fR security. .RE .SH SEE ALSO -.sp -.LP \fBypserv\fR(1M), \fBypstart\fR(1M), \fBypstop\fR(1M), \fBypxfrd\fR(1M) .SH NOTES -.sp -.LP The Network Information Service (NIS) was formerly known as Sun Yellow Pages (YP). The functionality of the two remains the same; only the name has changed. The name Yellow Pages is a registered trademark in the United Kingdom diff --git a/usr/src/man/man4/smb.4 b/usr/src/man/man4/smb.4 index c593a52178..b800c3a7b9 100644 --- a/usr/src/man/man4/smb.4 +++ b/usr/src/man/man4/smb.4 @@ -16,11 +16,10 @@ .\" fields enclosed by brackets "[]" replaced with your own identifying .\" information: Portions Copyright [yyyy] [name of copyright owner] .\" -.TH SMB 4 "Apr 23, 2015" +.TH SMB 4 "May 16, 2020" .SH NAME smb \- configuration properties for Solaris CIFS server .SH DESCRIPTION -.LP Behavior of the Solaris CIFS server is defined by property values that are stored in the Service Management Facility, \fBsmf\fR(5). .sp @@ -419,7 +418,7 @@ Controls whether "oplocks" may be granted by the SMB server. The term "oplock" is short for "opportunistic lock", which is the legacy name for cache delegations in SMB. By default, oplocks are enabled. -Note that if oplocks are disabled, file I/O perfrormance may be +Note that if oplocks are disabled, file I/O performance may be severely reduced. .RE @@ -549,7 +548,6 @@ set. .RE .SH ATTRIBUTES -.LP See the \fBattributes\fR(5) man page for descriptions of the following attributes: .sp @@ -565,6 +563,5 @@ Interface Stability Uncommitted .TE .SH SEE ALSO -.LP \fBsharectl\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M), \fBsmbstat\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5) diff --git a/usr/src/man/man4/smhba.conf.4 b/usr/src/man/man4/smhba.conf.4 index 91ed33f378..a960c3526f 100644 --- a/usr/src/man/man4/smhba.conf.4 +++ b/usr/src/man/man4/smhba.conf.4 @@ -3,12 +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 SMHBA.CONF 4 "Sep 28, 2009" +.TH SMHBA.CONF 4 "May 16, 2020" .SH NAME smhba.conf \- configuration file for the SMHBAAPI library .SH DESCRIPTION -.sp -.LP The \fB/etc/smhba.conf\fR file is used to specify the Vendor-Specific Libraries that are installed on the system. This file is used by the Common Library to load the individual VSLs when \fBHBA_LoadLibrary\fR(3HBAAPI) is called. If @@ -49,7 +47,6 @@ is the absolute path to the shared object library file. .RE .SH EXAMPLES -.LP \fBExample 1 \fRContents of \fB/etc/smhba.conf\fR .sp .in +2 @@ -69,8 +66,6 @@ com.sun.sashba64 /usr/lib/64/libsun_sas.so.1 .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -84,17 +79,13 @@ _ Interface Stability Committed _ Standard T{ -ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Ingerface(SM-HBA) +ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Interface(SM-HBA) T} .TE .SH SEE ALSO -.sp -.LP \fBHBA_LoadLibrary\fR(3HBAAPI), \fBlibSMHBAAPI\fR(3LIB), \fBattributes\fR(5) .SH NOTES -.sp -.LP The SMHBAAPI library is provided in both 32-and 64-bit versions, but only one configuration file is specified. As a result, both 32- and 64-bit VSL libraries must be specified within the same file. When using the 32-bit Common Library, diff --git a/usr/src/man/man4/tnf_kernel_probes.4 b/usr/src/man/man4/tnf_kernel_probes.4 index 7d5c3c1ee0..b7c84e1e41 100644 --- a/usr/src/man/man4/tnf_kernel_probes.4 +++ b/usr/src/man/man4/tnf_kernel_probes.4 @@ -3,12 +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 TNF_KERNEL_PROBES 4 "Nov 8, 1999" +.TH TNF_KERNEL_PROBES 4 "May 16, 2020" .SH NAME tnf_kernel_probes \- TNF kernel probes .SH DESCRIPTION -.sp -.LP The set of probes (trace instrumentation points) available in the standard kernel. The probes log trace data to a kernel trace buffer in Trace Normal Form (TNF). Kernel probes are controlled by \fBprex\fR(1). A snapshot of the @@ -22,7 +20,6 @@ from \fBprex\fR(1). A probe that is enabled for tracing generates a \fBTNF\fR record, called an \fIevent record\fR. An event record contains two common members and may contain other probe-specific data members. .SS "Common Members" -.sp .in +2 .nf \fBtnf_probe_event\fR \fItag\fR @@ -70,7 +67,6 @@ time of the event. .SS "Threads" .SS "\fBthread_create\fR" -.sp .in +2 .nf \fBtnf_kthread_id\fR \fItid\fR @@ -110,7 +106,6 @@ The kernel address of its start routine. .RE .SS "\fBthread_state\fR" -.sp .in +2 .nf \fBtnf_kthread_id\fR \fItid\fR @@ -181,16 +176,11 @@ is implicit in the system call entry and exit events. .RE .SS "thread_exit" -.sp -.LP Thread termination event for writing thread. This probe has no data members other than the common members. .SS "Scheduling" -.sp -.LP \fB\fR .SS "thread_queue" -.sp .in +2 .nf \fBtnf_kthread_id\fR \fItid\fR @@ -233,7 +223,6 @@ The current length of the cpu's dispatch queue. .SS "Blocking" .SS "\fBthread_block\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIreason\fR @@ -266,7 +255,6 @@ stack at the time the thread blocks. .SS "System Calls" .SS "\fBsyscall_start\fR" -.sp .in +2 .nf \fBtnf_sysnum\fR \fIsysnum\fR @@ -287,7 +275,6 @@ microstate with this event. .RE .SS "\fBsyscall_end\fR" -.sp .in +2 .nf \fBtnf_long\fR \fIrval1\fR @@ -322,7 +309,6 @@ The error return. The writing thread implicitly enters the \fIuser\fR microstate with this event. .SS "Page Faults" .SS "\fBaddress_fault\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIaddress\fR @@ -364,7 +350,6 @@ for these two members are defined in <\fBvm/seg_enum.h\fR>. .RE .SS "\fBmajor_fault\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIvnode\fR @@ -379,7 +364,6 @@ Major page fault event. The faulting page is mapped to the file given by the virtual address is in the most recent \fBaddress_fault\fR event for the writing thread.) .SS "\fBanon_private\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIaddress\fR @@ -399,7 +383,6 @@ The virtual address at which the new page is mapped. .RE .SS "\fBanon_zero\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIaddress\fR @@ -419,7 +402,6 @@ The virtual address at which the new page is mapped. .RE .SS "\fBpage_unmap\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIvnode\fR @@ -442,7 +424,6 @@ Identifies the file and offset of the page being unmapped. .SS "Pageins and Pageouts" .SS "\fBpagein\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIvnode\fR @@ -460,7 +441,7 @@ Pagein start event. This event signals the initiation of pagein I/O. \fB\fIvnode\fRand\fIoffset\fR\fR .ad .RS 18n -Identifyies the file and offset to be paged in. +Identifies the file and offset to be paged in. .RE .sp @@ -473,7 +454,6 @@ Specifies the number of bytes to be paged in. .RE .SS "\fBpageout\fR" -.sp .in +2 .nf \fBtnf_opaque\fR \fIvnode\fR @@ -524,7 +504,6 @@ The number of pages reclaimed after being written out. .SS "Page Daemon (Page Stealer)" .SS "\fBpageout_scan_start\fR" -.sp .in +2 .nf \fBtnf_ulong\fR \fIpages_free\fR @@ -555,7 +534,6 @@ The number of pages desired free. .RE .SS "\fBpageout_scan_end\fR" -.sp .in +2 .nf \fBtnf_ulong\fR \fIpages_free\fR @@ -588,7 +566,6 @@ be freed when any queued pageout requests complete.) .SS "Swapper" .SS "\fBswapout_process\fR" -.sp .in +2 .nf \fBtnf_pid\fR \fIpid\fR @@ -619,7 +596,6 @@ Reports the number of pages either freed or queued for pageout. .RE .SS "\fBswapout_lwp\fR" -.sp .in +2 .nf \fBtnf_pid\fR \fIpid\fR @@ -670,7 +646,6 @@ The number of pages swapped out. .RE .SS "\fBswapin_lwp\fR" -.sp .in +2 .nf \fBtnf_pid\fR \fIpid\fR @@ -722,7 +697,6 @@ The number of pages swapped in. .SS "Local I/O" .SS "\fBstrategy\fR" -.sp .in +2 .nf \fBtnf_device\fR \fIdevice\fR @@ -783,7 +757,6 @@ The \fBbuf\fR(9S) flags associated with the transfer. .RE .SS "\fBbiodone\fR" -.sp .in +2 .nf \fBtnf_device\fR \fIdevice\fR @@ -824,7 +797,6 @@ The kernel address of the \fBbuf\fR(9S) structure associated with the transfer. .RE .SS "\fBphysio_start\fR" -.sp .in +2 .nf \fBtnf_device\fR \fIdevice\fR @@ -837,7 +809,7 @@ The kernel address of the \fBbuf\fR(9S) structure associated with the transfer. .sp .LP Raw I/O start event. This event marks entry into the \fBphysio\fR(9F) -fufnction which performs unbuffered I/O. +function which performs unbuffered I/O. .sp .ne 2 .na @@ -875,7 +847,6 @@ The direction of the transfer: read or write (see \fBbuf\fR(9S)). .RE .SS "\fBphysio_end\fR" -.sp .in +2 .nf \fBtnf_device\fR \fIdevice\fR @@ -884,7 +855,7 @@ The direction of the transfer: read or write (see \fBbuf\fR(9S)). .sp .LP -Raw I/O end event. This event marks exit from the \fBphysio\fR(9F) fufnction. +Raw I/O end event. This event marks exit from the \fBphysio\fR(9F) function. .sp .ne 2 .na @@ -895,8 +866,6 @@ The major and minor numbers of the device of the transfer. .RE .SH USAGE -.sp -.LP Use the \fBprex\fR utility to control kernel probes. The standard \fBprex\fR commands to list and manipulate probes are available to you, along with commands to set up and manage kernel tracing. @@ -968,8 +937,6 @@ A convenient way to follow these steps is to use two shell windows; run an interactive \fBprex\fR session in one, and run your application and \fBtnfxtract\fR in the other. .SH SEE ALSO -.sp -.LP \fBprex\fR(1), \fBtnfdump\fR(1), \fBtnfxtract\fR(1), \fBlibtnfctl\fR(3TNF), \fBTNF_PROBE\fR(3TNF), \fBtracing\fR(3TNF), \fBstrategy\fR(9E), \fBbiodone\fR(9F), \fBphysio\fR(9F), \fBbuf\fR(9S) diff --git a/usr/src/man/man5/condition.5 b/usr/src/man/man5/condition.5 index 5ebaf3ef50..1282ea26e8 100644 --- a/usr/src/man/man5/condition.5 +++ b/usr/src/man/man5/condition.5 @@ -44,12 +44,10 @@ .\" Copyright (c) 1998 Sun Microsystems, Inc. All Rights Reserved. .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. .\" -.TH CONDITION 5 "Jul 20, 1998" +.TH CONDITION 5 "May 16, 2020" .SH NAME condition \- concepts related to condition variables .SH DESCRIPTION -.sp -.LP Occasionally, a thread running within a mutex needs to wait for an event, in which case it blocks or sleeps. When a thread is waiting for another thread to communicate its disposition, it uses a condition variable in conjunction with a @@ -68,8 +66,6 @@ If another thread changes the condition, it may wake up waiting threads by signaling the associated condition variable. The waiting threads, upon awakening, reacquire the mutex and re-evaluate the condition. .SS "Initialize" -.sp -.LP Condition variables and mutexes should be global. Condition variables that are allocated in writable memory can synchronize threads among processes if they are shared by the cooperating processes (see \fBmmap\fR(2)) and are initialized @@ -99,26 +95,18 @@ initialization of the condition variable. Solaris condition variables also implement as the default, intra-process; however, they set this attribute according to the argument, \fItype\fR, passed to their initialization function. .SS "Condition Wait" -.sp -.LP The condition wait interface allows a thread to wait for a condition and atomically release the associated mutex that it needs to hold to check the condition. The thread waits for another thread to make the condition true and that thread's resulting call to signal and wakeup the waiting thread. .SS "Condition Signaling" -.sp -.LP A condition signal allows a thread to unblock the next thread waiting on the condition variable, whereas, a condition broadcast allows a thread to unblock all threads waiting on the condition variable. .SS "Destroy" -.sp -.LP The condition destroy functions destroy any state, but not the space, associated with the condition variable. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -133,8 +121,6 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBfork\fR(2), \fBmmap\fR(2), \fBsetitimer\fR(2), \fBshmop\fR(2), \fBcond_broadcast\fR(3C), \fBcond_destroy\fR(3C), \fBcond_init\fR(3C), \fBcond_signal\fR(3C), \fBcond_timedwait\fR(3C), \fBcond_wait\fR(3C), @@ -144,13 +130,11 @@ MT-Level MT-Safe \fBpthread_condattr_init\fR(3C), \fBsignal\fR(3C), \fBattributes\fR(5), \fBmutex\fR(5), \fBstandards\fR(5) .SH NOTES -.sp -.LP If more than one thread is blocked on a condition variable, the order in which threads are unblocked is determined by the scheduling policy. .sp .LP -\fBUSYNC_THREAD\fR does not support multiple mapplings to the same logical +\fBUSYNC_THREAD\fR does not support multiple mappings to the same logical synch object. If you need to \fBmmap()\fR a synch object to different locations within the same address space, then the synch object should be initialized as a shared object \fBUSYNC_PROCESS\fR for Solaris, and diff --git a/usr/src/man/man5/epoll.5 b/usr/src/man/man5/epoll.5 index 1cf5d39947..2e64991cbf 100644 --- a/usr/src/man/man5/epoll.5 +++ b/usr/src/man/man5/epoll.5 @@ -8,7 +8,7 @@ .\" A full copy of the text of the CDDL should have accompanied this .\" source. A copy of the CDDL is also available via the Internet at .\" http://www.illumos.org/license/CDDL. -.TH EPOLL 5 "Apr 17, 2014" +.TH EPOLL 5 "May 16, 2020" .SH NAME epoll \- Linux-compatible I/O event notification facility .SH SYNOPSIS @@ -28,7 +28,7 @@ the Linux facility, including the following interfaces: .ie t \(bu .el o \fBepoll_create\fR(3C) creates an \fBepoll\fR instance, returning a file -descriptor. It contains a size arugment which is meaningful only in as +descriptor. It contains a size argument which is meaningful only in as much as it cannot be 0. .RE .RS +4 @@ -59,7 +59,7 @@ via \fBepoll_ctl\fR(3C), blocking the caller if no such events are pending. .TP .ie t \(bu .el o -\fBepoll_pwait\fR(3C) opeates in a similar manner to \fBepoll_wait\fR(3C), but +\fBepoll_pwait\fR(3C) operates in a similar manner to \fBepoll_wait\fR(3C), but allows the caller to specify a signal mask to be set atomically with respect to waiting for events. .RE diff --git a/usr/src/man/man5/filesystem.5 b/usr/src/man/man5/filesystem.5 index f0420111c4..8b4cd14157 100644 --- a/usr/src/man/man5/filesystem.5 +++ b/usr/src/man/man5/filesystem.5 @@ -20,11 +20,10 @@ .\" Copyright 2016 Nexenta Systems, Inc. .\" Copyright 2017 Peter Tribble .\" -.TH FILESYSTEM 5 "Nov 26, 2017" +.TH FILESYSTEM 5 "Apr 15, 2020" .SH NAME filesystem \- File system organization .SH SYNOPSIS -.LP .nf / .fi @@ -35,7 +34,6 @@ filesystem \- File system organization .fi .SH DESCRIPTION -.LP The file system tree is organized for administrative convenience. Distinct areas within the file system tree are provided for files that are private to one machine, files that can be shared by multiple machines of a common @@ -85,7 +83,6 @@ the \fBplatform-specific\fR file is installed only on a subset of supported platforms. Most platform-specific files are gathered under \fB/platform\fR and \fB/usr/platform\fR. .SS "Root File System" -.LP The root file system contains files that are unique to each machine. It contains the following directories: .sp @@ -1544,7 +1541,6 @@ Databases used by \fBNIS\fR and \fBypbind\fR(1M). .RE .SS "\fB/usr\fR File System" -.LP Because it is desirable to keep the root file system small and not volatile, on disk-based systems larger file systems are often mounted on \fB/home\fR, \fB/opt\fR, \fB/usr\fR, and \fB/var\fR. @@ -1566,16 +1562,6 @@ The \fB/usr\fR file system contains the following subdirectories: .sp .ne 2 .na -\fB\fB/usr/4lib\fR\fR -.ad -.sp .6 -.RS 4n -\fBa.out\fR libraries for the Binary Compatibility Package. -.RE - -.sp -.ne 2 -.na \fB\fB/usr/5bin\fR\fR .ad .sp .6 @@ -2951,7 +2937,6 @@ Directory for newer versions of POSIX-compliant utilities. .RE .SH SEE ALSO -.LP \fBat\fR(1), \fBex\fR(1), \fBiconv\fR(1), \fBlp\fR(1), \fBisainfo\fR(1), \fBmail\fR(1), \fBmailx\fR(1), \fBnroff\fR(1), \fBpriocntl\fR(1), \fBrefer\fR(1), \fBsar\fR(1), \fBsh\fR(1), \fBspell\fR(1), diff --git a/usr/src/man/man5/lf64.5 b/usr/src/man/man5/lf64.5 index f1be4e3d83..f2c59d78a6 100644 --- a/usr/src/man/man5/lf64.5 +++ b/usr/src/man/man5/lf64.5 @@ -4,11 +4,10 @@ .\" 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] .\" Copyright (c) 2015, Joyent, Inc. All rights reserved. -.TH LF64 5 "Jan 14, 2015" +.TH LF64 5 "May 17, 2020" .SH NAME lf64 \- transitional interfaces for 64-bit file offsets .SH DESCRIPTION -.LP The data types, interfaces, and macros described on this page provide explicit access to 64-bit file offsets. They are accessible through the transitional compilation environment described on the \fBlfcompile64\fR(5) manual page. The @@ -16,7 +15,6 @@ function prototype and semantics of a transitional interface are equivalent to those of the standard version of the call, except that relevant data types are 64-bit entities. .SS "Data Types" -.LP The following tables list the standard data or struct types in the left-hand column and their corresponding explicit 64-bit file offset types in the right-hand column, grouped by header. The absence of an entry in the left-hand @@ -99,7 +97,7 @@ l l . struct \fBstatvfs\fR struct \fBstatvfs64\fR \fBfsblkcnt_t\fR f_blocks; \fBfsblkcnt64_t\fR f_blocks; \fBfsblkcnt_t\fR f_bfree; \fBfsblkcnt64_t\fR f_bfree; - \fBfsblkcnt_t\fR f_bavial; \fBfsblkcnt64_t\fR f_bavial; + \fBfsblkcnt_t\fR f_bavail; \fBfsblkcnt64_t\fR f_bavail; \fBfsfilcnt_t\fR f_files; \fBfsfilcnt64_t\fR f_files; \fBfsfilcnt_t\fR f_ffree; \fBfsfilcnt64_t\fR f_ffree; \fBfsfilcnt_t\fR f_favail; \fBfsfilcnt64_t\fR f_favail; @@ -138,7 +136,6 @@ l l . .TE .SS "System Interfaces" -.LP The following tables display the standard API and the corresponding transitional interfaces for 64-bit file offsets. The interfaces are grouped by header. The interface name and the affected data types are displayed in courier @@ -148,11 +145,11 @@ font. .TS l l l l . -int \fBaio_cancel\fR(..., int \fBaio_cancel64\fR(..., +int \fBaio_cancel\fR(..., int \fBaio_cancel64\fR(..., struct \fBaiocb\fR *); struct \fBaiocb64\fR *); int \fBaio_error\fR( int \fBaio_error64\fR( const struct \fBaiocb\fR *); const struct \fBaiocb64\fR *); -int \fBaio_fsync\fR(..., int \fBaio_fsync64\fR(..., +int \fBaio_fsync\fR(..., int \fBaio_fsync64\fR(..., struct \fBaiocb\fR *); struct \fBaiocb64\fR *); int \fBaio_read\fR(struct \fBaiocb\fR *); int \fBaio_read64\fR(struct \fBaiocb64\fR *); int \fBaio_return\fR(struct \fBaiocb\fR *); int \fBaio_return64\fR(struct \fBaiocb64\fR *); @@ -161,7 +158,7 @@ int \fBaio_suspend\fR( int \fBaio_suspend64\fR( int \fBaio_waitn\fR(aiocb_t *[], int \fBaio_waitn64\fR(aiocb64_t *[], ...); ...); int \fBaio_write\fR(struct \fBaiocb\fR *); int \fBaio_write64\fR(struct \fBaiocb64\fR *); -int \fBlio_listio\fR(..., int \fBlio_listio64\fR(..., +int \fBlio_listio\fR(..., int \fBlio_listio64\fR(..., const struct \fBaiocb\fR *, ...); const struct \fBaiocb64\fR *, ...); .TE @@ -171,12 +168,12 @@ int \fBlio_listio\fR(..., int \fBlio_listio64\fR(..., l l l l . int \fBalphasort\fR( int \fBalphasort64\fR( - const struct dirent **, const struct dirent64 **, + const struct dirent **, const struct dirent64 **, const struct dirent **) const struct dirent64 **) struct \fBdirent *\fR\fBreaddir()\fR; struct \fBdirent64 *\fR\fBreaddir64()\fR; struct \fBdirent *\fR\fBreaddir_r()\fR; struct \fBdirent64 *\fR\fBreaddir64_r()\fR; -int \fBscandir\fR(..., int \fBscandir64\fR(..., - struct dirent *(*[]), struct dirent64 *(*[]), +int \fBscandir\fR(..., int \fBscandir64\fR(..., + struct dirent *(*[]), struct dirent64 *(*[]), int (*)(const struct dirent *), int (*)(const struct dirent64 *), int (*)(const struct dirent **, int (*)(const struct dirent64 **, const struct dirent **)) const struct dirent64 **)) @@ -202,10 +199,10 @@ l l l l . int \fBftw\fR(..., int \fBftw64\fR(..., const struct \fBstat\fR *, ...); const struct \fBstat64\fR *, ...); - + int \fBnftw\fR(.. int \fBnftw64\fR(..., const struct \fBstat\fR *, ...); const struct \fBstat64\fR *, ...); - + .TE .SS "<\fBlibgen.h\fR>" @@ -252,7 +249,7 @@ int \fBaiowrite\fR(..., \fBoff_t\fR, ...); int \fBaiowrite64\fR(..., \fBoff64_t\ l l l l . int \fBgetdents\fR(..., \fBdirent\fR); int \fBgetdents64\fR(..., \fBdirent64\fR); - + .TE .SS "<\fBsys/mman.h\fR>" @@ -278,11 +275,11 @@ int \fBsetrlimit\fR(..., int \fBsetrlimit64\fR(..., .TS l l l l . -ssize_t \fBsendfile\fR(..., ssize_t \fBsendfile64\fR(..., +ssize_t \fBsendfile\fR(..., ssize_t \fBsendfile64\fR(..., \fBoff_t\fR *, ...); \fBoff64_t\fR *, ...); -ssize_t \fBsendfilev\fR(..., const ssize_t \fBsendfilev64\fR(..., const +ssize_t \fBsendfilev\fR(..., const ssize_t \fBsendfilev64\fR(..., const struct \fBsendfilevec\fR *, ...); struct \fBsendfilevec64\fR *, ...); - + .TE .SS "<\fBsys/stat.h\fR>" @@ -291,7 +288,7 @@ ssize_t \fBsendfilev\fR(..., const ssize_t \fBsendfilev64\fR(..., const l l l l . int \fBfstat\fR(..., struct \fBstat\fR *); int \fBfstat64\fR(..., struct \fBstat64\fR *); -int \fBfstatat\fR(..., int \fBfstatat64\fR(..., +int \fBfstatat\fR(..., int \fBfstatat64\fR(..., struct \fBstat\fR *, int); struct \fBstat64\fR *, int); int \fBlstat\fR(..., struct \fBstat\fR *); int \fBlstat64\fR(..., struct \fBstat64\fR *); int \fBstat\fR(..., struct \fBstat\fR *); int \fBstat64\fR(..., struct \fBstat64\fR *); @@ -304,7 +301,7 @@ l l l l . int \fBstatvfs\fR(..., int \fBstatvfs64\fR(..., struct \fBstatvfs\fR *); struct \fBstatvfs64\fR *); -int \fBfstatvfs\fR(..., int \fBfstatvfs64\fR(..., +int \fBfstatvfs\fR(..., int \fBfstatvfs64\fR(..., struct \fBstatvfs\fR *); struct \fBstatvfs64\fR *); .TE @@ -328,7 +325,7 @@ int \fBalphasort\fR( int \fBalphasort64\fR( struct \fBdirect *\fR\fBreaddir()\fR; struct \fBdirect64 *\fR\fBreaddir64()\fR; int \fBscandir\fR(..., int \fBscandir64\fR(..., struct \fBdirect\fR *(*[]);, ...); struct \fBdirect64\fR *(*[]);, ...); - + .TE .SS "<\fBunistd.h\fR>" @@ -347,5 +344,4 @@ int \fBtruncate\fR(..., \fBoff_t\fR); int \fBtruncate64\fR(..., \fBoff64_t\fR); .TE .SH SEE ALSO -.LP \fBlfcompile\fR(5), \fBlfcompile64\fR(5) diff --git a/usr/src/man/man5/locale.5 b/usr/src/man/man5/locale.5 index dd8d3ba858..e6d63073aa 100644 --- a/usr/src/man/man5/locale.5 +++ b/usr/src/man/man5/locale.5 @@ -43,12 +43,11 @@ .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. .\" -.TH LOCALE 5 "April 9, 2016" +.TH LOCALE 5 "May 16, 2020" .SH NAME locale \- subset of a user's environment that depends on language and cultural conventions .SH DESCRIPTION -.LP A \fBlocale\fR is the definition of the subset of a user's environment that depends on language and cultural conventions. It is made up from one or more categories. Each category is identified by its name and controls specific @@ -139,7 +138,6 @@ the value of the corresponding environment variable is used. If the environment variable is unset or is set to the empty string, the \fBsetlocale()\fR function sets the appropriate environment. .SS "Locale Definition" -.LP Locales can be described with the file format accepted by the \fBlocaledef\fR utility. .sp @@ -341,7 +339,6 @@ decimal or hexadecimal constants. Symbolic names not present in the charmap file can be specified and will be ignored, as specified under item 1 above. .RE .SS "LC_CTYPE" -.LP The \fBLC_CTYPE\fR category defines character classification, case conversion and other character attributes. In addition, a series of characters can be represented by three adjacent periods representing an ellipsis symbol @@ -719,7 +716,6 @@ the mapping will be the reverse mapping of the one specified for \fBtoupper\fR. .RE .SS "LC_COLLATE" -.LP The \fBLC_COLLATE\fR category provides a collation sequence definition for numerous utilities (such as \fBsort\fR(1), \fBuniq\fR(1), and so forth), regular expression matching (see \fBregex\fR(5)), and the \fBstrcoll\fR(3C), @@ -744,7 +740,7 @@ as an entity). \fBUser-defined ordering of collating elements\fR. Each collating element is assigned a collation value defining its order in the character (or basic) collation sequence. This ordering is used by regular expressions and pattern -matching and, unless collation weights are explicity specified, also as the +matching and, unless collation weights are explicitly specified, also as the collation weight to be used in sorting. .RE .RS +4 @@ -833,7 +829,6 @@ Specify the end of the collation-order statements. .RE .SS "collating-element \fIkeyword\fR" -.LP In addition to the collating elements in the character set, the \fBcollating-element\fR keyword is used to define multi-character collating elements. The syntax is: @@ -868,7 +863,6 @@ Example: \fBcollating-element\fR <\fBll\fR> from "\fBll\fR" .in -2 .SS "collating-symbol \fIkeyword\fR" -.LP This keyword will be used to define symbols for use in collation sequence statements; that is, between the \fBorder_start\fR and the \fBorder_end\fR keywords. The syntax is: @@ -907,7 +901,6 @@ associated with a relative position in the character order sequence. While such a symbolic name does not represent any collating element, it can be used as a weight. .SS "order_start \fIkeyword\fR" -.LP The \fBorder_start\fR keyword must precede collation order entries and also defines the number of weights for this collation sequence definition and other collation rules. @@ -987,7 +980,6 @@ order_start forward;backward .LP If no operands are specified, a single \fBforward\fR operand is assumed. .SS "Collation Order" -.LP The \fBorder_start\fR keyword is followed by collating identifier entries. The syntax for the collating element entries is: .sp @@ -1139,7 +1131,7 @@ l l l l . \fBorder_start\fR \fBforward;backward\fR \fBUNDEFINED\fR \fBIGNORE;IGNORE\fR -\fB<LOW>\fR +\fB<LOW>\fR \fB<space>\fR \fB<LOW>;<space>\fR \fB\&.\|.\|.\fR \fB<LOW>;.\|.\|.\fR \fB<a>\fR \fB<a>;<a>\fR @@ -1152,7 +1144,7 @@ l l . \fB<Ch>\fR \fB<ch>;<Ch>\fR \fB<s>\fR \fB<s>;<s>\fR \fB<eszet>\fR \fB"<s><s>";"<eszet><eszet>"\fR -\fBorder_end\fR +\fBorder_end\fR .TE .sp @@ -1186,10 +1178,8 @@ collating symbol <\fBch\fR> and belongs to the same primary equivalence class as the multi-character collating element <\fBCh\fR>. .RE .SS "order_end \fIkeyword\fR" -.LP The collating order entries must be terminated with an \fBorder_end\fR keyword. .SS "LC_MONETARY" -.LP The \fBLC_MONETARY\fR category defines the rules and symbols that are used to format monetary numeric information. This information is available through the \fBlocaleconv\fR(3C) function @@ -1637,18 +1627,18 @@ The following table shows the result of various combinations: .TS l l l l l l l l l l l l . - \fBp_sep_by_space\fR - 2 1 0 -\fBp_cs_precedes\fR= 1 \fBp_sign_posn\fR= 0 \fB($1.25)\fR \fB($1.25)\fR \fB($1.25)\fR - \fBp_sign_posn\fR= 1 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR - \fBp_sign_posn\fR= 2 \fB$1.25+\fR \fB$1.25+\fR \fB$1.25+\fR - \fBp_sign_posn\fR= 3 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR - \fBp_sign_posn\fR= 4 \fB$+1.25\fR \fB$+1.25\fR \fB$+1.25\fR -\fBp_cs_precedes\fR= 0 \fBp_sign_posn\fR= 0 \fB(1.25 $)\fR \fB(1.25 $)\fR \fB(1.25$)\fR - \fBp_sign_posn\fR= 1 \fB+1.25 $\fR \fB+1.25 $\fR \fB+1.25$\fR - \fBp_sign_posn\fR= 2 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR - \fBp_sign_posn\fR= 3 \fB1.25+ $\fR \fB1.25 +$\fR \fB1.25+$\fR - \fBp_sign_posn\fR= 4 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR + \fBp_sep_by_space\fR + 2 1 0 +\fBp_cs_precedes\fR= 1 \fBp_sign_posn\fR= 0 \fB($1.25)\fR \fB($1.25)\fR \fB($1.25)\fR + \fBp_sign_posn\fR= 1 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR + \fBp_sign_posn\fR= 2 \fB$1.25+\fR \fB$1.25+\fR \fB$1.25+\fR + \fBp_sign_posn\fR= 3 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR + \fBp_sign_posn\fR= 4 \fB$+1.25\fR \fB$+1.25\fR \fB$+1.25\fR +\fBp_cs_precedes\fR= 0 \fBp_sign_posn\fR= 0 \fB(1.25 $)\fR \fB(1.25 $)\fR \fB(1.25$)\fR + \fBp_sign_posn\fR= 1 \fB+1.25 $\fR \fB+1.25 $\fR \fB+1.25$\fR + \fBp_sign_posn\fR= 2 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR + \fBp_sign_posn\fR= 3 \fB1.25+ $\fR \fB1.25 +$\fR \fB1.25+$\fR + \fBp_sign_posn\fR= 4 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR .TE .sp @@ -1696,7 +1686,6 @@ END LC_MONETARY The entry \fBn/a\fR indicates that the value is not available in the POSIX locale. .SS "LC_NUMERIC" -.LP The \fBLC_NUMERIC\fR category defines the rules and symbols that will be used to format non-monetary numeric information. This information is available through the \fBlocaleconv\fR(3C) function. @@ -1795,7 +1784,6 @@ _ The entry \fBn/a\fR indicates that the value is not available in the POSIX locale. .SS "LC_TIME" -.LP The \fBLC_TIME\fR category defines the interpretation of the field descriptors supported by \fBdate\fR(1) and affects the behavior of the \fBstrftime\fR(3C), \fBwcsftime\fR(3C), \fBstrptime\fR(3C), and \fBnl_langinfo\fR(3C) functions. @@ -2062,7 +2050,6 @@ field descriptor will be used instead of the value. .RE .SS "LC_TIME \fIC-language\fR Access" -.LP The following information can be accessed. These correspond to constants defined in <\fBlanginfo.h\fR> and used as arguments to the \fBnl_langinfo\fR(3C) function. @@ -2324,7 +2311,6 @@ _ .TE .SS "LC_TIME \fIGeneral\fR Information" -.LP Although certain of the field descriptors in the POSIX locale (such as the name of the month) are shown with initial capital letters, this need not be the case in other locales. Programs using these fields may need to adjust the @@ -2362,7 +2348,6 @@ in 1776" while 7/14/1789 would come out as "The 14 day of July in 1789" The above example is for illustrative purposes only. The \fB%O\fR modifier is primarily intended to provide for Kanji or Hindi digits in \fBdate\fR formats. .SS "LC_MESSAGES" -.LP The \fBLC_MESSAGES\fR category defines the format and values for affirmative and negative responses. .sp @@ -2455,7 +2440,6 @@ l | l | l . In an application conforming to the SUSv3 standard, the information on \fByesstr\fR and \fBnostr\fR is not available. .SH SEE ALSO -.LP \fBdate\fR(1), \fBlocale\fR(1), \fBlocaledef\fR(1), \fBsort\fR(1), \fBtr\fR(1), \fBuniq\fR(1), \fBlocaleconv\fR(3C), \fBnl_langinfo\fR(3C), \fBsetlocale\fR(3C), \fBstrcoll\fR(3C), \fBstrftime\fR(3C), \fBstrptime\fR(3C), diff --git a/usr/src/man/man7d/ecpp.7d b/usr/src/man/man7d/ecpp.7d index 7d10e4ee9c..dc5259dbdf 100644 --- a/usr/src/man/man7d/ecpp.7d +++ b/usr/src/man/man7d/ecpp.7d @@ -3,7 +3,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 ECPP 7D "Jan 10, 2020" +.TH ECPP 7D "May 17, 2020" .SH NAME ecpp \- IEEE 1284 compliant parallel port driver .SH SYNOPSIS @@ -25,7 +25,7 @@ ecpp@unit-address The \fBecpp\fR driver provides a bi-directional interface to \fIIEEE 1284\fR compliant devices as well as a forward single-directional interface to Centronics devices. In addition to the Centronics protocol, the \fBecpp\fR -driver supports the \fIIEEE 1284\fRCompatibility, Nibble, and ECP protocols. +driver supports the \fIIEEE 1284\fR Compatibility, Nibble, and ECP protocols. \fBECPP_COMPAT_MODE\fR and \fBECPP_CENTRONICS\fR modes of operation have logically identical handshaking protocols, however devices that support \fBECPP_COMPAT_MODE\fR are \fIIEEE 1284\fR compliant devices. \fIIEEE 1284\fR @@ -231,8 +231,7 @@ conditions are ok, \fB0\fR is returned. Otherwise, \fB-1\fR is returned, errno is set to \fBEIO\fR and the state of the status pins is captured. The captured status can be retrieved using the \fBBPPIOC_GETERR\fR \fBioctl\fR(2) call. The \fBtimeout_occurred\fR and \fBbus_error\fR fields will never be set by this -\fBioctl\fR(2). \fBBPPIOC_TESTIO\fR and \fBBPPIOC_GETERR\fR are compatible to -the ioctls specified in \fBbpp\fR(7D). +\fBioctl\fR(2). .RE .sp @@ -450,7 +449,7 @@ Interface stability Evolving .SH SEE ALSO \fBmodload\fR(1M), \fBmodunload\fR(1M), \fBupdate_drv\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), -\fBbpp\fR(7D), \fBusbprn\fR(7D), \fBprnio\fR(7I), \fBstreamio\fR(7I) +\fBusbprn\fR(7D), \fBprnio\fR(7I), \fBstreamio\fR(7I) .sp .LP \fIIEEE Std 1284-1994\fR @@ -464,4 +463,3 @@ Interface stability Evolving Driver does not support parallel port controller on the given host. Attach failed. .RE - diff --git a/usr/src/man/man7d/usbprn.7d b/usr/src/man/man7d/usbprn.7d index b28b0a7626..9f5d326917 100644 --- a/usr/src/man/man7d/usbprn.7d +++ b/usr/src/man/man7d/usbprn.7d @@ -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 USBPRN 7D "May 13, 2017" +.TH USBPRN 7D "May 17, 2020" .SH NAME usbprn \- USB printer class driver .SH SYNOPSIS -.LP .nf #include <sys/usb/clients/printer/usb_printer.h> .fi @@ -23,7 +22,6 @@ usbprn@unit-address .fi .SH DESCRIPTION -.LP The \fBusbprn\fR driver is a USBA (Solaris USB Architecture) compliant client driver that supports the \fIUSB Printer Class 1.0\fR specification. The \fBusbprn\fR driver supports a subset of the \fBecpp\fR(7D) parallel port @@ -44,14 +42,12 @@ queue. For USB connected printers, it attempts to pre-select the manufacturer and model information based on the 1284 device id supplied by the printer. .SS "UGEN (Generic USB)" -.LP The \fBusbprn\fR driver also supports a \fBugen\fR(7D) interface allowing raw access to the device, for example by libusb applications, by passing the drivers bound to each interface. Because a libusb application might change the state of the device, you should not access the device through the child interface drivers. .SH DEFAULT OPERATION -.LP With certain minor exceptions (outlined in the Notes sections below), the \fBusbprn\fR driver supports a subset of the \fBecpp\fR(7D) ioctl interfaces: .sp @@ -73,7 +69,6 @@ to their default values with each \fBattach\fR(9E). (The \fBecpp\fR(7D) driver resets configuration variables with each \fBopen\fR(2).) .RE .SH WRITE OPERATION -.LP A \fBwrite\fR(2) operation returns the number of bytes successfully written to the device. If a failure occurs while a driver is transferring data to printer, the contents of the status bits are captured at the time of the error and can @@ -81,7 +76,6 @@ be retrieved by the application program using the ECPPIOC_GETERR \fBioctl\fR(2) call. The captured status information is overwritten each time an ECPPIOC_TESTIO \fBioctl\fR(2) occurs. .SH IOCTLS -.LP The \fBusbprn\fR driver supports \fBprnio\fR(7I) interfaces. Note that the \fBPRNIOC_RESET\fR command has no effect on USB printers. .sp @@ -154,8 +148,6 @@ determine if a \fBwrite\fR(2) will succeed. If status bits are set, a transfer will fail. If a transfer will succeed, zero is returned. If a transfer fails, the driver returns \fBEIO\fR and the state of the status bits are captured. The captured status can be retrieved using the BPPIOC_GETERR \fBioctl\fR(2) call. -BPPIOC_TESTIO and BPPIOC_GETERR are compatible to the ioctls specified in -\fBbpp\fR(7D). .LP Note - .sp @@ -243,7 +235,6 @@ Unlike \fBecpp\fR(7D), only the ECPP_CENTRONICS mode is currently supported in .RE .SH READ OPERATION -.LP The \fBread\fR operation is not supported and returns \fBEIO\fR. .SH ERRORS .ne 2 @@ -354,7 +345,6 @@ Character special files .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -369,10 +359,9 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.LP \fBcfgadm_usb\fR(1M), \fBprintmgr\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), -\fBbpp\fR(7D), \fBecpp\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), \fBprnio\fR(7I), +\fBecpp\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), \fBprnio\fR(7I), \fBattach\fR(9E) .sp .LP @@ -387,7 +376,6 @@ Architecture SPARC, x86, PCI-based systems .LP \fISystem Administration Guide: Basic Administration\fR .SH DIAGNOSTICS -.LP In addition to being logged, the following messages may appear on the system console. All messages are formatted in the following manner: .sp @@ -446,7 +434,6 @@ to the hot-removal may be lost. .RE .SH NOTES -.LP The USB printer will be power managed if the device is closed. .sp .LP diff --git a/usr/src/man/man9e/_fini.9e b/usr/src/man/man9e/_fini.9e index 19cd7b665f..72bfbb8979 100644 --- a/usr/src/man/man9e/_fini.9e +++ b/usr/src/man/man9e/_fini.9e @@ -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 _FINI 9E "Jan 22, 2002" +.TH _FINI 9E "May 06, 2020" .SH NAME _fini, _info, _init \- loadable module configuration entry points .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> @@ -27,13 +26,10 @@ _fini, _info, _init \- loadable module configuration entry points .fi .SH INTERFACE LEVEL -.sp -.LP Solaris DDI specific (Solaris DDI). These entry points are required. You must write them. .SH PARAMETERS .SS "_info(\|)" -.sp .ne 2 .na \fB\fImodinfop\fR \fR @@ -43,8 +39,6 @@ A pointer to an opaque \fBmodinfo\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fB_init()\fR initializes a loadable module. It is called before any other routine in a loadable module. \fB_init()\fR returns the value returned by \fBmod_install\fR(9F). The module may optionally perform some other work before @@ -61,10 +55,10 @@ returns the value returned by \fBmod_info\fR(9F). system wants to unload a module. If the module determines that it can be unloaded, then \fB_fini()\fR returns the value returned by \fBmod_remove\fR(9F). Upon successful return from \fB_fini()\fR no other -routine in the module will be called before \fB_init()\fR is called. +routine in the module will be called before \fB_init()\fR is called. If +\fB_init()\fR did not successfully complete, \fB_fini()\fR will not be +called. .SH RETURN VALUES -.sp -.LP \fB_init()\fR should return the appropriate error number if there is an error, otherwise it should return the return value from \fBmod_install\fR(9F). .sp @@ -79,7 +73,6 @@ resources, such as mutexes and calls to \fBddi_soft_state_fini\fR(9F), should only be destroyed in \fB_fini()\fR after \fBmod_remove()\fR returns successfully. .SH EXAMPLES -.LP \fBExample 1 \fRInitializing and Freeing a Mutex .sp .LP @@ -158,8 +151,6 @@ _fini(void) .in -2 .SH SEE ALSO -.sp -.LP \fBadd_drv\fR(1M), \fBmod_info\fR(9F), \fBmod_install\fR(9F), \fBmod_remove\fR(9F), \fBmutex\fR(9F), \fBmodldrv\fR(9S), \fBmodlinkage\fR(9S), \fBmodlstrmod\fR(9S) @@ -167,17 +158,11 @@ _fini(void) .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP Do not change the structures referred to by the \fBmodlinkage\fR structure after the call to \fBmod_install()\fR, as the system may copy or change them. .SH NOTES -.sp -.LP Even though the identifiers \fB_fini()\fR, \fB_info()\fR, and \fB_init()\fR appear to be declared as globals, their scope is restricted by the kernel to the module that they are defined in. .SH BUGS -.sp -.LP On some implementations \fB_info()\fR may be called before \fB_init()\fR. diff --git a/usr/src/man/man9e/ioctl.9e b/usr/src/man/man9e/ioctl.9e index afb43407d0..796d92a37f 100644 --- a/usr/src/man/man9e/ioctl.9e +++ b/usr/src/man/man9e/ioctl.9e @@ -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 IOCTL 9E "Dec 3, 1996" +.TH IOCTL 9E "May 6, 2020" .SH NAME ioctl \- control a character device .SH SYNOPSIS -.LP .nf #include <sys/cred.h> #include <sys/file.h> @@ -23,11 +22,8 @@ ioctl \- control a character device .fi .SH INTERFACE LEVEL -.sp -.LP Architecture independent level 1 (DDI/DKI). This entry point is \fBoptional\fR. .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdev\fR\fR @@ -112,8 +108,6 @@ value which is valid only if the \fBioctl()\fR succeeds. .RE .SH DESCRIPTION -.sp -.LP \fBioctl()\fR provides character-access drivers with an alternate entry point that can be used for almost any operation other than a simple transfer of characters in and out of buffers. Most often, \fBioctl()\fR is used to control @@ -132,7 +126,10 @@ I/O control commands are used to implement the terminal settings passed from \fBttymon\fR(1M) and \fBstty\fR(1), to format disk devices, to implement a trace driver for debugging, and to clean up character queues. Since the kernel does not interpret the command type that defines the operation, a driver is -free to define its own commands. +free to define its own commands. Drivers must be prepared to receive commands +that they do not recognize or are in contexts that they do not expect. In the +case where \fIcmd\fR is unknown, it is recommended that the driver return +\fBENOTTY\fR. .sp .LP Drivers that use an \fBioctl()\fR routine typically have a command to ``read'' @@ -205,13 +202,10 @@ action that should be taken. However, the command passed to the driver by the user process is an integer value associated with the command name in the header. .SH RETURN VALUES -.sp -.LP \fBioctl()\fR should return \fB0\fR on success, or the appropriate error number. The driver may also set the value returned to the calling process through \fIrval_p\fR. .SH EXAMPLES -.LP \fBExample 1 \fR\fBioctl()\fR entry point .sp .LP @@ -263,8 +257,6 @@ xxioctl(dev_t dev, int cmd, intptr_t arg, int mode, .in -2 .SH SEE ALSO -.sp -.LP \fBstty\fR(1), \fBttymon\fR(1M), \fBdkio\fR(7I), \fBfbio\fR(7I), \fBtermio\fR(7I), \fBopen\fR(9E), \fBput\fR(9E), \fBsrv\fR(9E), \fBcopyin\fR(9F), \fBcopyout\fR(9F), \fBddi_copyin\fR(9F), @@ -273,7 +265,6 @@ xxioctl(dev_t dev, int cmd, intptr_t arg, int mode, .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp .LP Non-STREAMS driver \fBioctl()\fR routines must make sure that user data is copied into or out of the kernel address space explicitly using @@ -288,8 +279,6 @@ even when in user context. Failure to use the appropriate copying routines can result in panics under load on some platforms, and reproducible panics on others. .SH NOTES -.sp -.LP STREAMS drivers do not have \fBioctl()\fR routines. The stream head converts I/O control commands to \fBM_IOCTL\fR messages, which are handled by the driver's \fBput\fR(9E) or \fBsrv\fR(9E) routine. diff --git a/usr/src/man/man9e/mac.9e b/usr/src/man/man9e/mac.9e index 56762b7856..d3d066a564 100644 --- a/usr/src/man/man9e/mac.9e +++ b/usr/src/man/man9e/mac.9e @@ -10,8 +10,9 @@ .\" .\" .\" Copyright 2019 Joyent, Inc. +.\" Copyright 2020 RackTop Systems, Inc. .\" -.Dd July 22, 2019 +.Dd May 11, 2020 .Dt MAC 9E .Os .Sh NAME @@ -894,6 +895,57 @@ it has configured the device, not what the device has actually negotiated. When setting the property, it should update the hardware and allow the link to potentially perform auto-negotiation again. +.It Sy MAC_PROP_EN_FEC_CAP +.Bd -filled -compact +Type: +.Sy link_fec_t | +Permissions: +.Sy Read/Write +.Ed +.Pp +The +.Sy MAC_PROP_EN_FEC_CAP +property indicates which Forward Error Correction (FEC) code is advertised +by the device. +.Pp +The +.Sy link_fec_t +is an enumeration that may be a combination of the following bit values: +.Bl -tag -width Ds +.It Sy LINK_FEC_NONE +No FEC over the link. +.It Sy LINK_FEC_AUTO +The FEC coding to use is auto-negotiated, +.Sy LINK_FEC_AUTO +cannot be set along with any of the other values. +This is the default setting the device driver should use. +.It Sy LINK_FEC_RS +The link may use Reed-Solomon FEC coding. +.It Sy LINK_FEC_BASE_R +The link may use Base-R coding, also common referred to as FireCode. +.El +.Pp +When setting the property, it should update the hardware with the requested, or +combination of requested codings. +If a particular combination of codings is not supported by the hardware, +the device driver should return +.Er EINVAL . +When retrieving this property, the device driver should return the current +value of the property. +.It Sy MAC_PROP_ADV_FEC_CAP +.Bd -filled -compact +Type: +.Sy link_fec_t | +Permissions: +.Sy Read-Only +.Ed +.Pp +The +.Sy MAC_PROP_ADV_FEC_CAP +has the same values as +.Sy MAC_PROP_EN_FEC_CAP . +The property indicates which Forward Error Correction (FEC) code has been +negotiated over the link. .El .Pp The remaining properties are all about various auto-negotiation link |