diff options
Diffstat (limited to 'usr/src/man')
39 files changed, 2315 insertions, 145 deletions
diff --git a/usr/src/man/man1/crontab.1 b/usr/src/man/man1/crontab.1 index c93255f406..aae9ad44f1 100644 --- a/usr/src/man/man1/crontab.1 +++ b/usr/src/man/man1/crontab.1 @@ -1,6 +1,7 @@ '\" te .\" Copyright 1989 AT&T .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text @@ -86,6 +87,15 @@ users' crontabs. .LP If \fBcrontab\fR is invoked with \fIfilename\fR, this overwrites an existing \fBcrontab\fR entry for the user that invokes it. +.sp +.LP +Cron supports a merged crontab with entries coming from either the user's +\fB/var/spool/cron/crontabs\fR file or from the user's +\fB/etc/cron.d/crontabs\fR file. The entries in the user's +\fB/var/spool/cron/crontabs\fR file are meant to be editable whereas those in +\fB/etc/cron.d/crontabs\fR are meant as system-defined entries which are not +intended to be customized by the user. The dual set of crontab entries is only +of interest to system-defined users such as \fBroot\fR. .SS "\fBcrontab\fR Access Control" .sp .LP @@ -343,6 +353,9 @@ file using the \fB-r\fR option. If \fIusername\fR is specified, the specified user's \fBcrontab\fR file is edited, rather than the current user's \fBcrontab\fR file. This can only be done by root or by a user with the \fBsolaris.jobs.admin\fR authorization. +.sp +Only the entries in the user's \fB/var/spool/cron/crontabs\fR file are +editable. .RE .sp @@ -354,6 +367,9 @@ done by root or by a user with the \fBsolaris.jobs.admin\fR authorization. Lists the \fBcrontab\fR file for the invoking user. Only root or a user with the \fBsolaris.jobs.admin\fR authorization can specify a username following the \fB-l\fR option to list the \fBcrontab\fR file of the specified user. +.sp +Entries from both the user's \fB/var/spool/cron/crontabs\fR file and thhe user's +\fB/etc/cron.d/crontabs\fR file will be merged in the output. .RE .sp @@ -583,6 +599,17 @@ list of denied users .sp .ne 2 .na +\fB\fB/etc/cron.d/crontabs\fR\fR +.ad +.RS 28n +.rt +system spool area for \fBcrontab\fR +.RE + +.sp +.ne 2 +.mk +.na \fB\fB/var/cron/log\fR\fR .ad .RS 28n diff --git a/usr/src/man/man1/date.1 b/usr/src/man/man1/date.1 index 08c3b0b878..b996174472 100644 --- a/usr/src/man/man1/date.1 +++ b/usr/src/man/man1/date.1 @@ -155,6 +155,12 @@ Century (a year divided by 100 and truncated to an integer) as a decimal number [00-99]. .RE +In addition, the nonstandard conversion specification \fB%N\fR is also +supported, and is converted to the zero-padded number of nanoseconds since the +last second. Note that the actual resolution of this number is limited to the +resolution of the system's \fBCLOCK_REALTIME\fR clock. See +\fBclock_gettime\fR(3C). + The string is always terminated with a NEWLINE. An argument containing blanks must be quoted; see the EXAMPLES section. .RE diff --git a/usr/src/man/man1/ld.1 b/usr/src/man/man1/ld.1 index 634f16e0d1..be9394d829 100644 --- a/usr/src/man/man1/ld.1 +++ b/usr/src/man/man1/ld.1 @@ -24,7 +24,7 @@ ld \- link-editor for object files [\fB-z\fR combreloc | nocombreloc ] [\fB-z\fR defs | nodefs] [\fB-z\fR direct | nodirect] [\fB-z\fR endfiltee] [\fB-z\fR fatal-warnings | nofatal-warnings ] [\fB-z\fR finiarray=\fIfunction\fR] -[\fB-z\fR globalaudit] [\fB-z\fR groupperm | nogroupperm] +[\fB-z\fR globalaudit] [\fB-z\fR groupperm | nogroupperm] [\fB-z\fR help ] [\fB-z\fR guidance[=\fIid1\fR,\fIid2\fR...] [\fB-z\fR help ] [\fB-z\fR ignore | record] [\fB-z\fR initarray=\fIfunction\fR] [\fB-z\fR initfirst] [\fB-z\fR interpose] [\fB-z\fR lazyload | nolazyload] diff --git a/usr/src/man/man1/ps.1 b/usr/src/man/man1/ps.1 index 8e97b196c2..674e326e29 100644 --- a/usr/src/man/man1/ps.1 +++ b/usr/src/man/man1/ps.1 @@ -37,6 +37,9 @@ displayed is controlled by the options. Some options accept lists as arguments. Items in a list can be either separated by commas or else enclosed in quotes and separated by commas or spaces. Values for \fIproclist\fR and \fIgrplist\fR must be numeric. +.sp +.LP +The \fBps\fR command also accepts BSD-style options. See \fBps\fR(1b). .SH OPTIONS .sp .LP @@ -1295,7 +1298,8 @@ Standard See \fBstandards\fR(5). .sp .LP \fBkill\fR(1), \fBlgrpinfo\fR(1), \fBnice\fR(1), \fBpagesize\fR(1), -\fBpmap\fR(1), \fBpriocntl\fR(1), \fBwho\fR(1), \fBgetty\fR(1M), \fBproc\fR(4), +\fBpmap\fR(1), \fBpriocntl\fR(1), \fBps\fR(1b), \fBwho\fR(1), \fBgetty\fR(1M), +\fBproc\fR(4), \fBttysrch\fR(4), \fBattributes\fR(5), \fBenviron\fR(5), \fBresource_controls\fR(5), \fBstandards\fR(5), \fBzones\fR(5) .SH NOTES diff --git a/usr/src/man/man1/sed.1 b/usr/src/man/man1/sed.1 index ded1c15fa3..9ec2b67dd9 100644 --- a/usr/src/man/man1/sed.1 +++ b/usr/src/man/man1/sed.1 @@ -1,8 +1,6 @@ .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. .\" -.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. -.\" .\" This code is derived from software contributed to Berkeley by .\" the Institute of Electrical and Electronics Engineers, Inc. .\" @@ -30,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.TH SED 1 "Nov 2, 2011" +.TH SED 1 "May 24, 2009" .SH NAME \fBsed\fP \- stream editor @@ -45,7 +43,8 @@ [\fB\-Ealnr\fP] [\fB\-e\fP \fIcommand\fP] [\fB\-f\fP \fIcommand_file\fP] -[\fB\-I\fP[\fIextension\fP] | \fB\-i\fP[\fIextension\fP]] +[\fB\-I\fP \fIextension\fP] +[\fB\-i\fP \fIextension\fP] [\fIfile ...\fP] .SH DESCRIPTION The @@ -98,11 +97,16 @@ Append the editing commands found in the file to the list of commands. The editing commands should each be listed on a separate line. .TP -\fB\-I\fP[\fIextension\fP] -Edit files in-place, saving backups if \fIextension\fP was specified. -It is not recommended to omit saving backups when in-place editing files, -as you risk corruption or partial content in situations where disk -space is exhausted, etc. +\fB\-I\fP \fIextension\fP +Edit files in-place, saving backups with the specified +\fIextension\fP. +If a zero-length +\fIextension\fP +is given, no backup will be saved. +It is not recommended to give a zero-length +\fIextension\fP +when in-place editing files, as you risk corruption or partial content +in situations where disk space is exhausted, etc. Note that in-place editing with \fB\-I\fP @@ -120,7 +124,7 @@ where using \fB\-i\fP is desired. .TP -\fB\-i\fP[\fIextension\fP] +\fB\-i\fP \fIextension\fP Edit files in-place similarly to \fB\-I\fP, but treat each file independently from other files. diff --git a/usr/src/man/man1/tail.1 b/usr/src/man/man1/tail.1 index aca819269e..b96e6400dd 100644 --- a/usr/src/man/man1/tail.1 +++ b/usr/src/man/man1/tail.1 @@ -23,12 +23,12 @@ tail \- deliver the last part of a file .LP .nf -\fB/usr/bin/tail\fR [\(+- \fInumber\fR [lbcf]] [\fIfile\fR] +\fB/usr/bin/tail\fR [\(+- \fInumber\fR [lbcfF]] [\fIfile\fR] .fi .LP .nf -\fB/usr/bin/tail\fR [\fB-lbcf\fR] [\fIfile\fR] +\fB/usr/bin/tail\fR [\fB-lbcfF\fR] [\fIfile\fR] .fi .LP @@ -92,11 +92,24 @@ Units of bytes. \fB\fB-f\fR \fR .ad .RS 7n -Follow. If the input-file is not a pipe, the program does not terminate after -the line of the input-file has been copied, but enters an endless loop, wherein -it sleeps for a second and then attempts to read and copy further records from -the input-file. Thus it can be used to monitor the growth of a file that is -being written by some other process. +Follow. If the input-file is not a pipe, \fBtail\fR does not terminate after +the last line of the input-file has been copied, but enters an endless loop, +wherein it watches the file for modifications and attempts to read and copy +further records from the input-file. Thus it can be used to monitor the growth +of a file that is being written by some other process. If the watched file is +truncated \fBtail\fR will begin reading records from the start of the file. +.RE + +.sp +.ne 2 +.na +\fB\fB-F\fR \fR +.ad +.RS 7n +Follow named file. Operates as with \fB-f\fR, except that if the file is moved +(e.g. if a watched log file is rotated) \fBtail\fR will close the original file +and begin reading records from the start of the file with the specified name +if and when that file is recreated. .RE .sp diff --git a/usr/src/man/man1/tar.1 b/usr/src/man/man1/tar.1 index fd21f6c53c..0641851b2f 100644 --- a/usr/src/man/man1/tar.1 +++ b/usr/src/man/man1/tar.1 @@ -43,7 +43,7 @@ tar \- create tape archives and add or extract files .LP .nf \fBtar\fR x[BeFhilmnopqTvw@/[0-7]][fk][X...][j|J|z|Z] [\fItarfile\fR] [\fIsize\fR] - [\fIexclude-file\fR]... [\fIfile\fR]... + [\fIexclude-file\fR]... [\(miC \fIdirectory\fR] [\fIfile\fR]... .fi .SH DESCRIPTION @@ -81,6 +81,10 @@ performs the \fBc\fR (create) or \fBr\fR (replace) operation on \fIfile\fR. Use short relative path names for \fIfile\fR. If \fIfile\fR is "\fB\&.\fR", archive all files in \fIdirectory\fR. This operand enables archiving files from multiple directories not related by a close common parent. +.sp +This option may also be passed once to \fBx\fR (extract). In this case the +program will \fBchdir\fR to \fIdirectory\fR after opening the archive, but +before extracting its contents. .RE .sp diff --git a/usr/src/man/man1m/Makefile b/usr/src/man/man1m/Makefile index ede32ed164..afb8908d0e 100644 --- a/usr/src/man/man1m/Makefile +++ b/usr/src/man/man1m/Makefile @@ -11,6 +11,7 @@ # # Copyright 2011, Richard Lowe +# Copyright (c) 2012 Joyent, Inc. All rights reserved. # Copyright 2012 Nexenta Systems, Inc. All rights reserved. # @@ -236,6 +237,8 @@ COMMON_MANFILES = 6to4relay.1m \ intrstat.1m \ iostat.1m \ ipaddrsel.1m \ + ipadm.1m \ + ipdadm.1m \ ipf.1m \ ipfs.1m \ ipfstat.1m \ diff --git a/usr/src/man/man1m/dladm.1m b/usr/src/man/man1m/dladm.1m index bf20443ad8..a2050328b7 100644 --- a/usr/src/man/man1m/dladm.1m +++ b/usr/src/man/man1m/dladm.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical @@ -15,7 +16,7 @@ dladm \- administer data links .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] \fIlink\fR \fInew-link\fR +\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR .fi .LP @@ -98,9 +99,11 @@ dladm \- administer data links .LP .nf -\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR -\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIprop\fR[,...]] \fIlink\fR -\fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR] +\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] + \fIlink\fR +\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] [\fB-p\fR \fIprop\fR[,...]] \fIlink\fR +\fBdladm show-linkprop\fR [\fB-P\fR] [\fB-z\fR \fIzonename\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] + [\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR] .fi .LP @@ -115,9 +118,9 @@ dladm \- administer data links \fBdladm create-vnic\fR [\fB-t\fR] \fB-l\fR \fIlink\fR [\fB-R\fR \fIroot-dir\fR] [\fB-m\fR \fIvalue\fR | auto | {factory \fB-n\fR \fIslot-identifier\fR]} | {random [\fB-r\fR \fIprefix\fR]}] [\fB-v\fR \fIvlan-id\fR] [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIvnic-link\fR -\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIvnic-link\fR +\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIvnic-link\fR \fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] - [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR] + [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIvnic-link\fR] .fi .LP @@ -570,8 +573,7 @@ will be displayed only once. .sp .ne 2 .na -\fB\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR -\fInew-link\fR\fR +\fB\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR\fR .ad .sp .6 .RS 4n @@ -589,6 +591,17 @@ examples of how this subcommand is used. See "Options," above. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +A link assigned to a zone can only be renamed while the zone is in the ready state. +.RE + .RE .sp @@ -3135,8 +3148,7 @@ Extended output is displayed for \fBPTYPE\fR values of \fBcurrent\fR, .sp .ne 2 .na -\fB\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR -\fIprop\fR=\fIvalue\fR[,...] \fIlink\fR\fR +\fB\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR\fR .ad .sp .6 .RS 4n @@ -3168,6 +3180,17 @@ See "Options," above. .sp .ne 2 .na +\fB\fB-z\fR \fIzonenme\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.mk +.na \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR \fIprop\fR=\fIvalue\fR[,...]\fR .ad @@ -3187,8 +3210,7 @@ same value. .sp .ne 2 .na -\fB\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR -\fIprop\fR,...] \fIlink\fR\fR +\fB\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] [\fB-p\fR \fIprop\fR,...] \fIlink\fR\fR .ad .sp .6 .RS 4n @@ -3220,6 +3242,17 @@ See "Options," above. .sp .ne 2 .na +\fB\fB-z\fR \fIzonenme\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.mk +.na \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR .ad .sp .6 @@ -3234,8 +3267,7 @@ the same value. .sp .ne 2 .na -\fB\fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR -\fIfield\fR[,...]][\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]\fR +\fB\fBdladm show-linkprop\fR [\fB-P\fR] [\fB-z\fR \fIzonename\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]][\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]\fR .ad .sp .6 .RS 4n @@ -3353,6 +3385,17 @@ Display persistent link property information .sp .ne 2 .na +\fB\fB-z\fR \fIzonenme\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.mk +.na \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR .ad .sp .6 @@ -3670,8 +3713,7 @@ A comma-separated list of properties to set to the specified values. .sp .ne 2 .na -\fB\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] -\fIvnic-link\fR\fR +\fB\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIvnic-link\fR\fR .ad .sp .6 .RS 4n @@ -3697,13 +3739,23 @@ next reboot. See "Options," above. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-z\fR \fIzonenme\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp .ne 2 .na -\fB\fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] -[\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR]\fR +\fB\fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIvnic-link\fR]\fR .ad .sp .6 .RS 4n @@ -3846,6 +3898,17 @@ will be displayed only once. Display information for all VNICs on the named link. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-z\fR \fIzonenme\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp diff --git a/usr/src/man/man1m/flowadm.1m b/usr/src/man/man1m/flowadm.1m index b12ce6af96..a64a703612 100644 --- a/usr/src/man/man1m/flowadm.1m +++ b/usr/src/man/man1m/flowadm.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -11,14 +12,14 @@ services, containers, and virtual machines .LP .nf \fBflowadm show-flow\fR [\fB-pP\fR] [\fB-S\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-l\fR \fIlink\fR] - [\fB-o\fR \fIfield\fR[,...]] [\fIflow\fR] + [\fB-o\fR \fIfield\fR[,...]] [\fB-z\fR \fIzonename\fR] [\fIflow\fR] .fi .LP .nf -\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] - \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR -\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] {\fB-l\fR \fIlink\fR | \fIflow\fR} +\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR \fIlink\fR + \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR +\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] {\fB-l\fR \fIlink\fR | \fIflow\fR} .fi .LP @@ -77,8 +78,7 @@ The following subcommands are supported: .sp .ne 2 .na -\fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] -[\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIflow\fR]\fR +\fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIflow\fR]\fR .ad .sp .6 .RS 4n @@ -223,14 +223,23 @@ Display information for all flows on the named link or information for the named flow. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp .ne 2 .na -\fB\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR -\fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR -\fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR +\fB\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR .ad .sp .6 .RS 4n @@ -268,6 +277,17 @@ persistent creation. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.mk +.na \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR .ad .sp .6 @@ -300,8 +320,7 @@ A comma-separated list of properties to be set to the specified values. .sp .ne 2 .na -\fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR -{\fIlink\fR | \fIflow\fR}\fR +\fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR {\fIlink\fR | \fIflow\fR}\fR .ad .sp .6 .RS 4n @@ -331,6 +350,17 @@ persistent removal. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.mk +.na \fB\fB-l\fR \fIlink\fR | \fIflow\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR .ad .sp .6 diff --git a/usr/src/man/man1m/ipadm.1m b/usr/src/man/man1m/ipadm.1m new file mode 100644 index 0000000000..13eb6ec5f0 --- /dev/null +++ b/usr/src/man/man1m/ipadm.1m @@ -0,0 +1,1245 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH IPADM 1M "May 14, 2012" +.SH NAME +ipadm \- configure IP network interfaces and protocol properties. +.SH SYNOPSIS +.LP +.nf +\fBipadm\fR create-if [\fB-t\fR] \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR disable-if \fB-t\fR \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR enable-if \fB-t\fR \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR delete-if \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR show-if [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR] +.fi + +.LP +.nf +\fBipadm\fR set-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR reset-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR +.fi + +.LP +.nf +\fBipadm\fR show-ifprop [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR] + [\fIinterface\fR] +.fi + +.LP +.nf +\fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR static [\fB-d\fR] + \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR] + [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR down-addr [\fB-t\fR] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR up-addr [\fB-t\fR] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR disable-addr \fB-t\fR \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR enable-addr \fB-t\fR \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR refresh-addr [\fB-i\fR] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR delete-addr [\fB-r\fR] \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR show-addr [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR] +.fi + +.LP +.nf +\fBipadm\fR set-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR reset-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR +.fi + +.LP +.nf +\fBipadm\fR show-addrprop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fIaddrobj\fR] +.fi + +.LP +.nf +\fBipadm\fR set-prop [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR +.fi + +.LP +.nf +\fBipadm\fR reset-prop [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR +.fi + +.LP +.nf +\fBipadm\fR show-prop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIprotocol\fR] +.fi + +.SH DESCRIPTION +.sp +.LP + +The \fBipadm\fR command is a stable replacement for the \fBifconfig\fR(1M) and +\fBndd\fR(1M) commands. It is used to create IP interfaces and to confgure IP +addresses on those interfaces. It is also used to get, set or reset properties +on interfaces, addresses and protocols. +.LP +For subcommands that take an \fIaddrobj\fR, the \fIaddrobj\fR specifies a +unique address on the system. It is made up of two parts, delimited by a '/'. +The first part is the name of the interface and the second part is a string up +to 32 characters long. For example, "lo0/v4" is a loopback interface +addrobj name. +.LP +For subcommands that take a \fIprotocol\fR, this can be one of +the following values: ip, ipv4, ipv6, icmp, tcp, sctp or udp. + +.SH SUBCOMMANDS +.sp +.LP +The following subcommands are supported: +.sp +.ne 2 +.na +\fB\fBcreate-if\fR [\fB-t\fR] \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBcreate-if\fR subcommand is used to create an IP interface that will +handle both IPv4 and IPv6 packets. The interface will be enabled as part of +the creation process. The IPv4 interface will have the address 0.0.0.0. +The IPv6 interface will have the adress ::. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the creation is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBdisable-if\fR \fB-t\fR \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBdisable-if\fR subcommand is used to disable an IP interface. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBenable-if\fR \fB-t\fR \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBenable-if\fR subcommand is used to enable an IP interface. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the enable is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fbdelete-if\fR \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBdelete-if\fR subcommand is used to permanently delete an IP interface. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBshow-if\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR]\fR +.ad +.sp .6 +.RS 4n +The \fBshow-if\fR subcommand is used to show the current IP interface +configuration. +.sp +The \fB-p\fR option (also \fB--parsable\fR) prints +the output in a parsable format. +.sp +The \fB-o\fR option (also \fB--output\fR) is used +to select which fields will be shown. The field value can be one of the +following names: +.sp +.ne 2 +.na +.RS 4n +\fBALL\fR +.ad +.RS 4n +Display all fields +.RE + +.sp +.ne 2 +.na +\fBIFNAME\fR +.ad +.RS 4n +The name of the interface +.RE + +.sp +.ne 2 +.na +\fBSTATE\fR +.ad +.RS 4n +The state can be one of the following values: +.sp +.ne 2 +.na +.RS 4n +ok - resources for the interface have been allocated +.sp +offline - the interface is offline +.sp +failed - the interface's datalink is down +.sp +down - the interface is down +.sp +disabled - the interface is disabled +.RE +.RE + +.sp +.ne 2 +.na +\fBCURRENT\fR +.ad +.RS 4n +A set of single character flags indicating the following: +.sp +.ne 2 +.na +.RS 4n +b - broadcast (mutually exclusive with 'p') +.br +m - multicast +.br +p - point-to-point (mutually exclusive with 'b') +.br +v - virtual interface +.br +I - IPMP +.br +s - IPMP standby +.br +i - IPMP inactive +.br +V - VRRP +.br +a - VRRP accept mode +.br +4 - IPv4 +.br +6 - IPv6 +.RE +.RE + +.sp +.ne 2 +.na +\fBPERSISTENT\fR +.ad +.RS 4n +A set of single character flags showing what configuration will be used the +next time the interface is enabled: +.sp +.ne 2 +.na +.RS 4n +s - IPMP standby +.br +4 - IPv4 +.br +6 - IPv6 +.RE +.RE +.RE + +.RE + +.sp +.ne 2 +.na +\fB\fBset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBset-ifprop\fR subcommand is used to set a property's value(s) on the IP +interface. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the setting is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name and +value(s). The property name can be one of the following: +.sp +.ne 2 +.na + +.RS 4n + +\fBarp\fR +.ad +.RS 4n +Enables ("on") or disables ("off") ARP. +.RE + +.sp +.ne 2 +.na +\fBexchange_routes\fR +.ad +.RS 4n +Enables ("on") or disables ("off") the exchange of routing data. +.RE + +.sp +.ne 2 +.na +\fBforwarding\fR +.ad +.RS 4n +Enables ("on") or disables ("off") IP forwarding. +.RE + +.sp +.ne 2 +.na +\fBmetric\fR +.ad +.RS 4n +Set the routing metric to the numeric value. The value is treated as extra +hops to the destination. +.RE + +.sp +.ne 2 +.na +\fBmtu\fR +.ad +.RS 4n +Set the maximum transmission unit to the numeric value. +.RE + +.sp +.ne 2 +.na +\fBnud\fR +.ad +.RS 4n +Enables ("on") or disables ("off") neighbor unreachability detection. +.RE + +.sp +.ne 2 +.na +\fBusesrc\fR +.ad +.RS 4n +Indicates which interface to use for source address selection. A value +"none" may also be used. +.RE +.RE + +.sp +The \fB-m\fR option (also \fB--module\fR) specifies which protocol +the setting applies to. +.sp + +.RE +.RE + +.sp +.ne 2 +.na +\fB\fBreset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR +.ad +.sp .6 +.RS 4n +The \fBreset-ifprop\fR subcommand is used to reset an IP interface's property +value to the default. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name. +See the \fBset-ifprop\fR subcommand for the list of property names. +.sp +The \fB-m\fR option (also \fB--module\fR) specifies which protocol +the setting applies to. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBshow-ifprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR] + [\fIinterface\fR]\fR +.ad +.sp .6 +.RS 4n +The \fBshow-ifprop\fR subcommand is used to display the property values +for one or all of the IP interfaces. +.sp +The \fB-c\fR option (also \fB--parsable\fR) prints +the output in a parsable format. +.sp +The \fB-o\fR option (also \fB--output\fR) is used +to select which fields will be shown. The field value can be one of the +following names: +.sp +.ne 2 +.na +.RS 4n +\fBALL\fR +.ad +.RS 4n +Display all fields +.RE + +.sp +.ne 2 +.na +\fBIFNAME\fR +.ad +.RS 4n +The name of the interface +.RE + +.sp +.ne 2 +.na +\fBPROPERTY\fR +.ad +.RS 4n +The name of the property +.RE + +.sp +.ne 2 +.na +\fBPROTO\fR +.ad +.RS 4n +The name of the protocol +.RE + +.sp +.ne 2 +.na +\fBPERM\fR +.ad +.RS 4n +If the property is readable ("r") and/or writable ("w"). +.RE + +.sp +.ne 2 +.na +\fBCURRENT\fR +.ad +.RS 4n +The value of the property +.RE + +.sp +.ne 2 +.na +\fBPERSISTENT\fR +.ad +.RS 4n +The persistent value of the property +.RE + +.sp +.ne 2 +.na +\fBDEFAULT\fR +.ad +.RS 4n +The default value of the property +.RE + +.sp +.ne 2 +.na +\fBPOSSIBLE\fR +.ad +.RS 4n +The possible values for the property +.RE +.RE + +.sp +The \fB-p\fR option (also \fB--prop\fR) is used +to specify which properties to display. See the \fBset-ifprop\fR +subcommand for the list of property names. +.sp +The \fB-m\fR option (also \fB--module\fR) specifies which protocol +to display. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR static [\fB-d\fR] \\ + \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR\fR +.br +\fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR\fR +.br +\fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR] \\ + [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBcreate-addr\fR subcommand is used to set an address on an IP interface. +The address will be enabled but can disabled using the \fBdisable-addr\fR +subcommand. This subcommand has three different forms, depending on the +value of the \fB-T\fR option. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the address is temporary and will not be persistent across reboots. +.sp +The \fB-T\fR static option creates a static addrobj. This takes the following +options: +.RS 4n + +The \fB-d\fR option (also \fB--down\fR) means the address is down. +.sp +The \fB-a\fR option (also \fB--address\fR) specifies the address. +The "local" or "remote" prefix can be used for a point-to-point interface. +In this case, both addresses must be given. +Otherwise, the equal sign ("=") should be omitted and the address should be +provided by itself and with no second address. +.sp + +.RE + +The \fB-T\fR dhcp option causes the address to be obtained via DHCP. +This takes the following options: +.RS 4n + +The \fB-w\fR option (also \fB--wait\fR) gives the time, in seconds, +that the command should wait to obtain an address. +.sp + +.RE + +The \fB-T\fR addrconf option creates an auto-configured address. +This takes the following options: +.RS 4n + +The \fB-i\fR option (also \fB--interface-id\fR) gives the interface ID to +be used. +.sp +The \fB-p\fR option (also \fB--prop\fR) indicates which method of +auto-configuration should be used. +.sp + +.RE +.RE + +.sp +.ne 2 +.na +\fB\fBdown-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBdown-addr\fR subcommand is used to down the address. This will +stop packets from being sent or received. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the down is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBup-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBup-addr\fR subcommand is used to up the address. This will +enable packets to be sent and received. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the up is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBdisable-addr\fR \fB-t\fR \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBdisable-addr\fR subcommand is used to disable the address. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBenable-addr\fR \fB-t\fR \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBenable-addr\fR subcommand is used to enable the address. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBrefresh-addr\fR [\fB-i\fR] \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBrefresh-addr\fR subcommand is used to extend the lease for DHCP +addresses. It also restarts duplicate address detection for Static addresses. +.sp +The \fB-i\fR option (also \fB--inform\fR) means +that the network configuration will be obtained from DHCP without taking +a lease on the address. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBdelete-addr\fR [\fB-r\fR] \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBdelete-addr\fR subcommand deletes the given address. +.sp +The \fB-r\fR option (also \fB--release\fR) is used for DHCP-assigned +addresses to indicate that the address should be released. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBshow-addr\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]\fR +.ad +.sp .6 +.RS 4n +The \fBshow-addr\fR subcommand is used to show the current address properties. +.sp +The \fB-p\fR option (also \fB--parsable\fR) prints +the output in a parsable format. +.sp +The \fB-o\fR option (also \fB--output\fR) is used +to select which fields will be shown. The field value can be one of the +following names: +.sp +.ne 2 +.na +.RS 4n +\fBALL\fR +.ad +.RS 4n +Display all fields +.RE + +.sp +.ne 2 +.na +\fBADDROBJ\fR +.ad +.RS 4n +The name of the address +.RE + +.sp +.ne 2 +.na +\fBTYPE\fR +.ad +.RS 4n +The type of the address. It can be "static", "dhcp" or "addrconf". +.RE + +.sp +.ne 2 +.na +\fBSTATE\fR +.ad +.RS 4n +The state of the address. It can be one of the following values: +.sp +.ne 2 +.na +.RS 4n +disabled s see the \fBdisable-addr\fR subcommand +.sp +down - see the \fBdown-addr\fR subcommand +.sp +duplicate - the address is a duplicate +.sp +inaccessible - the interface for this address has failed +.sp +ok - the address is up +.sp +tentative - duplicate address detection in progress +.RE +.RE + +.sp +.ne 2 +.na +\fBCURRENT\fR +.ad +.RS 4n +A set of single character flags indicating the following: +.sp +.ne 2 +.na +.RS 4n +U - up +.br +u - unnumbered (matches another local address) +.br +p - private, not advertised to routing +.br +t - temporary IPv6 address +.br +d - deprecated (not used for outgoing packets) +.RE +.RE + +.sp +.ne 2 +.na +\fBPERSISTENT\fR +.ad +.RS 4n +A set of single character flags showing the configuration which will be used +when the address is enabled. +.sp +.ne 2 +.na +.RS 4n +U - up +.br +p - private, not advertised to routing +.br +d - deprecated (not used for outgoing packets) +.RE +.RE + +.sp +.ne 2 +.na +\fBADDR\fR +.ad +.RS 4n +The address +.RE +.RE + +.RE + +.sp +.ne 2 +.na +\fB\fBset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR +.ad +.sp .6 +.RS 4n +The \fBset-addrprop\fR subcommand is used to set a property's value(s) on the +addrobj. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the setting is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name and +value(s). The property name can be one of the following: +.sp +.ne 2 +.na + +.RS 4n + +\fBbroadcast\fR +.ad +.RS 4n +The broadcast address (read-only) +.RE + +.sp +.ne 2 +.na +\fBdeprecated\fR +.ad +.RS 4n +The address should not be used to send packets but can still receive packets. +Can be "on" or "off". +.RE + +.sp +.ne 2 +.na +\fBprefixlen\fR +.ad +.RS 4n +The number of bits in the IPv4 netmask or IPv6 prefix. +.RE + +.sp +.ne 2 +.na +\fBprivate\fR +.ad +.RS 4n +The address is not advertised to routing. +Can be "on" or "off". +.RE + +.sp +.ne 2 +.na +\fBtransmit\fR +.ad +.RS 4n +Packets can be transmitted. +Can be "on" or "off". +.RE + +.sp +.ne 2 +.na +\fBzone\fR +.ad +.RS 4n +The zone the addrobj is in. +.RE + +.RE +.RE + +.sp +.ne 2 +.na +\fB\fBreset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIaddrobj\fR\fR +.ad +.sp .6 +.RS 4n +The \fBreset-addrprop\fR subcommand is used to reset an addrobj's property +value to the default. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name. +See the \fBset-addrprop\fR subcommand for the list of property names. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBshow-addrprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIaddrobj\fR] +.ad +.sp .6 +.RS 4n +The \fBshow-addrprop\fR subcommand is used to display the property values +for one or all of the addrobjs. +.sp +The \fB-c\fR option (also \fB--parsable\fR) prints +the output in a parsable format. +.sp +The \fB-o\fR option (also \fB--output\fR) is used +to select which fields will be shown. The field value can be one of the +following names: +.sp +.ne 2 +.na +.RS 4n +\fBALL\fR +.ad +.RS 4n +Display all fields +.RE + +.sp +.ne 2 +.na +\fBADDROBJ\fR +.ad +.RS 4n +The name of the addrobj +.RE + +.sp +.ne 2 +.na +\fBPROPERTY\fR +.ad +.RS 4n +The name of the property +.RE + +.sp +.ne 2 +.na +\fBPERM\fR +.ad +.RS 4n +If the property is readable ("r") and/or writable ("w"). +.RE + +.sp +.ne 2 +.na +\fBCURRENT\fR +.ad +.RS 4n +The value of the property +.RE + +.sp +.ne 2 +.na +\fBPERSISTENT\fR +.ad +.RS 4n +The persistent value of the property +.RE + +.sp +.ne 2 +.na +\fBDEFAULT\fR +.ad +.RS 4n +The default value of the property +.RE + +.sp +.ne 2 +.na +\fBPOSSIBLE\fR +.ad +.RS 4n +The possible values for the property +.RE +.RE + +.sp +The \fB-p\fR option (also \fB--prop\fR) is used +to specify which properties to display. See the \fBset-addrprop\fR +subcommand for the list of property names. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR +.ad +.sp .6 +.RS 4n +The \fBset-prop\fR subcommand is used to set a property's value(s) on the +protocol. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the setting is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name and +value(s). The optional [+|-] syntax can be used to add/remove values from the +current list of values on the property. +The property name can be one of the following: +.sp +.ne 2 +.na + +.RS 4n + +\fBecn\fR +.ad +.RS 4n +Explicit congestion control (TCP-only) +Can be "never", "passive" or "active". +.RE + +\fBextra_priv_ports\fR +.ad +.RS 4n +Additional privileged ports (SCTP, TCP or UDP) +.RE + +\fBforwarding\fR +.ad +.RS 4n +Packet forwarding is enabled. +Can be "on" or "off". +.RE + +\fBhoplimit\fR +.ad +.RS 4n +The IPv6 hoplimit. +.RE + +\fBlargest_anon_port\fR +.ad +.RS 4n +Largest ephemeral port (SCTP, TCP or UDP) +.RE + +\fBrecv_maxbuf\fR +.ad +.RS 4n +Receive buffer size (ICMP, SCTP, TCP or UDP) +.RE + +\fBsack\fR +.ad +.RS 4n +Selective acknowledgement (TCP). +Can be "active", "passive" or "never". +.RE + +\fBsend_maxbuf\fR +.ad +.RS 4n +Send buffer size (ICMP, SCTP, TCP or UDP) +.RE + +\fBsmallest_anon_port\fR +.ad +.RS 4n +Smallest ephemeral port (SCTP, TCP or UDP) +.RE + +\fBsmallest_nonpriv_port\fR +.ad +.RS 4n +Smallest non-privileged port (SCTP, TCP or UDP) +.RE + +\fBttl\fR +.ad +.RS 4n +The IPv4 time-to-live. +.RE + +.RE +.RE + +.sp +.ne 2 +.na +\fB\fBreset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR\fR +.ad +.sp .6 +.RS 4n +The \fBreset-prop\fR subcommand is used to reset a protocol's property +value to the default. +.sp +The \fB-t\fR option (also \fB--temporary\fR) means +that the disable is temporary and will not be persistent across reboots. +.sp +The \fB-p\fR option (also \fB--prop\fR) specifies the property name. +See the \fBset-prop\fR subcommand for the list of property names. +.sp + +.RE + +.sp +.ne 2 +.na +\fB\fBshow-prop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIprotocol\fR] +.ad +.sp .6 +.RS 4n +The \fBshow-prop\fR subcommand is used to display the property values +for one or all of the protocols. +.sp +The \fB-c\fR option (also \fB--parsable\fR) prints +the output in a parsable format. +.sp +The \fB-o\fR option (also \fB--output\fR) is used +to select which fields will be shown. The field value can be one of the +following names: +.sp +.ne 2 +.na +.RS 4n +\fBALL\fR +.ad +.RS 4n +Display all fields +.RE + +.sp +.ne 2 +.na +\fBPROTO\fR +.ad +.RS 4n +The name of the protocol +.RE + +.sp +.ne 2 +.na +\fBPROPERTY\fR +.ad +.RS 4n +The name of the property +.RE + +.sp +.ne 2 +.na +\fBPERM\fR +.ad +.RS 4n +If the property is readable ("r") and/or writable ("w"). +.RE + +.sp +.ne 2 +.na +\fBCURRENT\fR +.ad +.RS 4n +The value of the property +.RE + +.sp +.ne 2 +.na +\fBPERSISTENT\fR +.ad +.RS 4n +The persistent value of the property +.RE + +.sp +.ne 2 +.na +\fBDEFAULT\fR +.ad +.RS 4n +The default value of the property +.RE + +.sp +.ne 2 +.na +\fBPOSSIBLE\fR +.ad +.RS 4n +The possible values for the property +.RE +.RE + +.sp +The \fB-p\fR option (also \fB--prop\fR) is used +to specify which properties to display. See the \fBset-prop\fR +subcommand for the list of property names. +.sp + +.RE + +.SH SEE ALSO +.sp +.LP +\fBifconfig\fR(1M), \fBdladm\fR(1M), \fBndd\fR(1M), \fBzonecfg\fR(1M), +\fBarp\fR(1M), \fBcfgadm\fR(1M), \fBif_mpadm\fR(1M), \fBnsswitch.conf\fR(4), +and \fBdhcp\fR(5). diff --git a/usr/src/man/man1m/ipdadm.1m b/usr/src/man/man1m/ipdadm.1m new file mode 100644 index 0000000000..8d5eec4331 --- /dev/null +++ b/usr/src/man/man1m/ipdadm.1m @@ -0,0 +1,223 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the +.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH IPDADM 1M "Mar 1, 2012" +.SH NAME +ipdadm \- administer the Internet packet disturber +.SH SYNOPSIS +.LP +.nf +\fBipdadm\fR [\fB-z\fR \fIzonename\fR] \fIsubcommand\fR [\fIsubcommand-options\fR] +.fi + +.SH DESCRIPTION +.sp +.LP +The ipdadm utility is used to administer the illumos facility for simulating +pathological networks by induce packet drops, delays, and corruption. + +This functionality is only able to the global zone and zones with exclusive +networking stacks. If this is enabled for the global zone, any zone with a +shared networking stack will be affected. + +.SH OPTIONS +.sp +.LP +The following options are supported: +.sp +.ne 2 +.na +\fB-z\fR +.ad +.sp .6 +.RS 4n +The string of the zonename to control. If this is not specified, the current +zone is used. For the list subcommand, this option is not supported. +.RE + +.SH SUBCOMMANDS +.sp +.LP +The following subcommands are supported: + +.sp +.ne 2 +.na +\fBcorrupt\fR \fIpercent\fR +.ad +.sp .6 +.RS 4n +Sets the chance for packets to be corrupted to \fIpercent\fR which must be an +integer between 0 and 100. Setting \fIpercent\fR to 0 disables packet corruption +and is equivalent to calling \fBremove\fR \fIcorrupt\fR. When enabled, a random +byte will have a single bit flipped. +.sp +.RE + +.sp +.ne 2 +.na +\fBdelay\fR \fImicroseconds\fR +.ad +.sp .6 +.RS 4n +Inserts \fImicroseconds\fR of delay between both the transmit and receive of +each packet. Setting \fImicroseconds\fR to zero is equivalent to calling +\fBremove\fR \fIdelay\fR. +.sp +.RE + +.sp +.ne 2 +.na +\fBdrop\fR \fIpercent\fR +.ad +.sp .6 +.RS 4n +Sets the chance for packets to be dropped to \fIpercent\fR. \fIpercent\fR must +be an integer between 0 and 100. Setting \fIpercent\fR to zero is equivalent to +calling \fBremove\fR \fIdrop\fR. +.sp +.RE + +.sp +.ne 2 +.na +\fBinfo\fR +.ad +.sp .6 +.RS 4n +Prints the current values for packet corruption, packet dropping, and packet +delay for the zone. +.sp +.RE + +.sp +.ne 2 +.na +\fBlist\fR +.ad +.sp .6 +.RS 4n +Prints out the zonename of each zone that has active (non-zero) packet +corruption, packet delay, and packet drop. +.sp +.RE + +.sp +.ne 2 +.na +\fBremove\fR \fIcorrupt\fR,\fIdelay\fI,\fIdrop\fR +.ad +.sp .6 +.RS 4n +Disables the requested forms of packet perturbation for the zone. This is +functionally equivalent to setting the value to zero. One or more of +\fIcorrupt\fR, \fIdelay\fR, and \fIdrop\fR can be specified as a comma separated +list. +.sp +.RE + +.SH EXAMPLES +.LP +\fBExample 1 \fRViewing zone information +.sp +.LP +The following command illustrates how to obtain information about a specific +zone while in the global zone. + +.sp +.in +2 +.nf +# \fBipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 info\fR +ipd information for zone 949860c5-52e2-4f32-965d-02e60e116b72: + corrupt: 0% chance of packet corruption + drop: 0% chance of packet drop + delay: 0 microsecond delay per packet +.fi +.in -2 +.sp + +.LP +\fBExample 2 \fRRemoving multiple perturbations +.sp +.LP +The following command illustrates the use of the \fBremove\fR subcommand from +inside of a zone. + +.sp +.in +2 +.nf +# \fBipdadm remove corrupt,drop\fR +.fi +.in -2 +.sp + +.LP +\fBExample 3 \fREnabling packet drops +.sp +.LP +The following command illustrates the use of the \fBdrop\fR subcommand from the +global zone. + +.sp +.in +2 +.nf +# \fBipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 drop 25\fR +.fi +.in -2 +.sp + + +.SH EXIT STATUS +.sp +.LP +The following exit values are returned: +.sp +.ne 2 +.na +\fB0\fR +.ad +.RS 5n +Successful completion. +.RE + +.sp +.ne 2 +.na +\fB\fB1\fR\fR +.ad +.RS 5n +An error occurred. +.sp +.sp +.ne 2 +.na +\fB\fB2\fR\fR +.ad +.RS 5n +Invalid command line options or arguments were specified. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Interface Stability Evolving +.TE + +.SH SEE ALSO +.sp +.LP +\fBzonename\fR(1),\fBzoneadm\fR(1M), \fBattributes\fR(5), \fBzones(5)\fR diff --git a/usr/src/man/man1m/lofiadm.1m b/usr/src/man/man1m/lofiadm.1m index 493223c3b2..71c74a2658 100644 --- a/usr/src/man/man1m/lofiadm.1m +++ b/usr/src/man/man1m/lofiadm.1m @@ -76,9 +76,11 @@ association, or print information about the current associations. Encryption and compression options are mutually exclusive on the command line. Further, an encrypted file cannot be compressed later, nor can a compressed file be encrypted later. + +In the global zone, \fBlofiadm\fR can be used on both the global +zone devices and all devices owned by other non-global zones on the system. .sp .LP -The \fBlofi\fR driver is not available and will not work inside a zone. .SH OPTIONS .sp .LP @@ -239,6 +241,10 @@ restrictions apply (such as restricted root access over \fBNFS\fR). The file is held open until the association is removed. It is not actually accessed until the block device is used, so it will never be written to if the block device is only opened read-only. + +Note that the filename may appear as "?" if it is not possible to resolve the +path in the current context (for example, if it's an NFS path in a non-global +zone). .RE .sp diff --git a/usr/src/man/man1m/mount_tmpfs.1m b/usr/src/man/man1m/mount_tmpfs.1m index a4f38d3b1f..3520a3f31b 100644 --- a/usr/src/man/man1m/mount_tmpfs.1m +++ b/usr/src/man/man1m/mount_tmpfs.1m @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH MOUNT_TMPFS 1M "Nov 24, 2003" +.TH MOUNT_TMPFS 1M "Dec 2, 2011" .SH NAME mount_tmpfs \- mount tmpfs file systems .SH SYNOPSIS @@ -45,6 +46,17 @@ available: .sp .ne 2 .na +\fB\fBremount\fR\fR +.ad +.sp .6 +.RS 19n +Remounts a file system with a new size. A size not explicitly +set with \fBremount\fR reverts to no limit. +.RE + +.sp +.ne 2 +.na \fBsize=\fIsz\fR\fR .ad .RS 19n diff --git a/usr/src/man/man1m/prstat.1m b/usr/src/man/man1m/prstat.1m index b70124b9b8..5b884da8d5 100644 --- a/usr/src/man/man1m/prstat.1m +++ b/usr/src/man/man1m/prstat.1m @@ -1,15 +1,16 @@ '\" te .\" Copyright (c) 2006, 2009 Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PRSTAT 1M "Jun 25, 2009" +.TH PRSTAT 1M "Sep 5, 2012" .SH NAME prstat \- report active process statistics .SH SYNOPSIS .LP .nf -\fBprstat\fR [\fB-acHJLmRrtTv\fR] [\fB-d\fR u | d] [\fB-C\fR \fIpsrsetlist\fR] [\fB-h\fR \fIlgrplist\fR] +\fBprstat\fR [\fB-acHJLmRrtTvV\fR] [\fB-d\fR u | d] [\fB-C\fR \fIpsrsetlist\fR] [\fB-h\fR \fIlgrplist\fR] [\fB-j\fR \fIprojlist\fR] [\fB-k\fR \fItasklist\fR] [\fB-n\fR \fIntop\fR[,\fInbottom\fR]] [\fB-p\fR \fIpidlist\fR] [\fB-P\fR \fIcpulist\fR] [\fB-s\fR \fIkey\fR | \fB-S\fR \fIkey\fR ] [\fB-u\fR \fIeuidlist\fR] [\fB-U\fR \fIuidlist\fR] [\fB-z\fR \fIzoneidlist\fR] [\fB-Z\fR] @@ -173,10 +174,10 @@ waiting for user locks and waiting for \fBCPU\fR (latency time). .RS 4n Restrict number of output lines. The \fIntop\fR argument determines how many lines of process or \fBlwp\fR statistics are reported, and the \fInbottom\fR -argument determines how many lines of user, task, or projects statistics are -reported if the \fB-a\fR, \fB-t\fR, \fB-T\fR, or \fB-J\fR options are -specified. By default, \fBprstat\fR displays as many lines of output that fit -in a window or terminal. When you specify the \fB-c\fR option or direct the +argument determines how many lines of user, task, project or zone statistics +are reported if the \fB-a\fR, \fB-t\fR, \fB-T\fR, \fB-J\fR or \fB-Z\fR options +are specified. By default, \fBprstat\fR displays as many lines of output that +fit in a window or terminal. When you specify the \fB-c\fR option or direct the output to a file, the default values for \fBntop\fR and \fBnbottom\fR are \fB15\fR and \fB5\fR. .RE @@ -364,6 +365,18 @@ with the \fB-\fR sign. .sp .ne 2 .na +\fB\fB-V\fR\fR +.ad +.sp .6 +.RS 4n +Report accurate aggregated RSS values when used with the \fB-J\fR, \fB-t\fR, +\fB-T\fR or \fB-Z\fR options. This uses an accurate, but more expensive, +calculation to determine the aggregated RSS value for the specified grouping. +.RE + +.sp +.ne 2 +.na \fB\fB-z\fR \fIzoneidlist\fR\fR .ad .sp .6 @@ -429,9 +442,11 @@ devices, in kilobytes (\fBK\fR), megabytes (\fBM\fR), or gigabytes (\fBG\fR). .RS 4n The resident set size of the process (\fBRSS\fR), in kilobytes (\fBK\fR), megabytes (\fBM\fR), or gigabytes (\fBG\fR). The RSS value is an estimate -provided by \fBproc\fR(4) that might underestimate the actual resident set -size. Users who want to get more accurate usage information for capacity -planning should use the \fB-x\fR option to \fBpmap\fR(1) instead. +provided by \fBproc\fR(4) that might underestimate the actual +per-process resident set size and usually overestimates the aggregated +resident set size. Users who want to get more accurate usage information for +capacity planning should use either the \fB-V\fR option or, for per-process +results, the \fB-x\fR option to \fBpmap\fR(1) instead. .RE .sp diff --git a/usr/src/man/man1m/prtconf.1m b/usr/src/man/man1m/prtconf.1m index bd93c39ec6..e3f50e60b5 100644 --- a/usr/src/man/man1m/prtconf.1m +++ b/usr/src/man/man1m/prtconf.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright 1989 AT&T Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2012, Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -9,7 +10,7 @@ prtconf \- print system configuration .SH SYNOPSIS .LP .nf -\fB/usr/sbin/prtconf\fR [\fB-V\fR] | [\fB-F\fR] | [\fB-x\fR] | [\fB-bpv\fR] | [\fB-acdDPv\fR] +\fB/usr/sbin/prtconf\fR [\fB-V\fR] | [\fB-F\fR] | [\fB-m\fr] | [\fB-x\fR] | [\fB-bpv\fR] | [\fB-acdDPv\fR] [\fIdev_path\fR] .fi @@ -67,7 +68,8 @@ command line. .ad .RS 6n Display vendor ID and device ID for PCI and PCI Express devices, in addition to -the nodename. +the nodename. If the information is known, the vendor name and device name will +also be showed. .RE .sp @@ -98,6 +100,16 @@ console frame buffer on a SUNW,Ultra-30 is \fBffb\fR, the command returns: .sp .ne 2 .na +\fB\fB-m\fR\fR +.ad +.RS 6n +Displays the amount system memory in megabytes. +This flag must be used by itself. +.RE + +.sp +.ne 2 +.na \fB\fB-p\fR\fR .ad .RS 6n diff --git a/usr/src/man/man1m/reboot.1m b/usr/src/man/man1m/reboot.1m index 1ff92b6f33..8eadedf18d 100644 --- a/usr/src/man/man1m/reboot.1m +++ b/usr/src/man/man1m/reboot.1m @@ -144,8 +144,7 @@ This option is currently available only on x86 systems. The \fB-p\fR and .ad .sp .6 .RS 4n -Quick. Reboot quickly and ungracefully, without shutting down running processes -first. +Quick. Reboot quickly without halting running zones first. .RE .SH OPERANDS diff --git a/usr/src/man/man1m/svc.startd.1m b/usr/src/man/man1m/svc.startd.1m index 726e556de1..103c6b5fec 100644 --- a/usr/src/man/man1m/svc.startd.1m +++ b/usr/src/man/man1m/svc.startd.1m @@ -1,10 +1,10 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2011, Joyent Inc +.\" Copyright 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SVC.STARTD 1M "Mar 18, 2011" +.TH SVC.STARTD 1M "Aug 23, 2012" .SH NAME svc.startd \- Service Management Facility master restarter .SH SYNOPSIS @@ -372,10 +372,13 @@ properties listed below in the \fBstartd\fR property group. .RS 4n The \fBcritical_failure_count\fR and \fBcritical_failure_period\fR properties together specify the maximum number of service failures allowed in a given -time interval before \fBsvc.startd\fR transitions the service to maintenance. +number of seconds before \fBsvc.startd\fR transitions the service to +maintenance. If the number of failures exceeds \fBcritical_failure_count\fR in any period of \fBcritical_failure_period\fR seconds, \fBsvc.startd\fR will transition the -service to maintenance. +service to maintenance. The \fBcritical_failure_count\fR value is limited +to the range 1-10 and defaults to 10. The \fBcritical_failure_period\fR +defaults to 600 seconds. .RE .sp @@ -488,7 +491,9 @@ conditions occurs. "\fBWait\fR" model services are restarted whenever the child process associated with the service exits. A child process that exits is not considered an error for "\fBwait\fR" model services, and repeated failures do not lead to a -transition to maintenance state. +transition to maintenance state. However, a wait service which is repeatedly +exiting with an error that exceeds the default rate (5 failures/second) will be +throttled back so that the service only restarts once per second. .SS "LEGACY SERVICES" .sp .LP diff --git a/usr/src/man/man1m/zfs.1m b/usr/src/man/man1m/zfs.1m index d2af571347..3cb4d5a7f7 100644 --- a/usr/src/man/man1m/zfs.1m +++ b/usr/src/man/man1m/zfs.1m @@ -26,7 +26,7 @@ .\" Copyright (c) 2012, Joyent, Inc. All rights reserved. .\" Copyright 2012 Nexenta Systems, Inc. All Rights Reserved. .\" -.TH ZFS 1M "Sep 16, 2012" +.TH ZFS 1M "Aug 16, 2012" .SH NAME zfs \- configures ZFS file systems .SH SYNOPSIS @@ -94,7 +94,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]] +\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ... .fi @@ -105,7 +105,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-t\fR \fItype\fR[,...]] +\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hpc\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ... .fi @@ -886,16 +886,19 @@ This property is not inherited. .sp .ne 2 .na -\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR | -\fBsha256\fR\fR +\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | +\fBsha256\fR | \fBnoparity\fR \fR .ad .sp .6 .RS 4n Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, -\fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR -disables integrity checking on user data. Disabling checksums is \fBNOT\fR a -recommended practice. +\fBfletcher2\fR, but this may change in future releases). The value \fBoff\fR +disables integrity checking on user data. The value \fBnoparity\fR not only +disables integrity but also disables maintaining parity for user data. This +setting is used internally by a dump device residing on a RAID-Z pool and should +not be used by any other dataset. Disabling checksums is \fBNOT\fR a recommended +practice. .sp Changing this property affects only newly-written data. .RE @@ -2057,7 +2060,7 @@ only dataset that can be renamed recursively. .sp .ne 2 .na -\fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR +\fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...\fR @@ -2205,6 +2208,17 @@ A comma-separated list of types to display, where \fItype\fR is one of specifying \fB-t snapshot\fR displays only snapshots. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-p\fR\fR +.ad +.sp .6 +.RS 4n +Display numbers in parseable (exact) values. +.RE + .RE .sp @@ -2228,7 +2242,7 @@ Properties" section. .sp .ne 2 .na -\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR +\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hpc\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR .ad @@ -2323,6 +2337,19 @@ is all sources. Display numbers in parseable (exact) values. .RE +.sp +.ne 2 +.na +\fB\fB-c\fR\fR +.ad +.sp .6 +.RS 4n +Only display properties which can be retrieved without issuing any I/O requests, +i.e. properties which are already cached. Most properties are cached except for +create-time properties (normalization, utf8only, casesensitivity) as well as a +volume's size and block size. +.RE + .RE .sp @@ -2733,7 +2760,7 @@ Unshare the specified filesystem. The command can also be given a path to a .sp .ne 2 .na -\fBzfs send\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR +\fBzfs send\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR .ad .sp .6 .RS 4n @@ -2809,6 +2836,18 @@ will be much better if the filesystem uses a dedup-capable checksum (eg. .sp .ne 2 .na +\fB\fB-r\fR\fR +.ad +.sp .6 +.RS 4n +Recursively send all descendant snapshots. This is similar to the \fB-R\fR +flag, but information about deleted and renamed datasets is not included, and +property information is only included if the \fB-p\fR flag is specified. +.RE + +.sp +.ne 2 +.na \fB\fB-p\fR\fR .ad .sp .6 diff --git a/usr/src/man/man1m/zoneadm.1m b/usr/src/man/man1m/zoneadm.1m index 13612b3ed1..00a4013a90 100644 --- a/usr/src/man/man1m/zoneadm.1m +++ b/usr/src/man/man1m/zoneadm.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2011 Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -131,12 +132,14 @@ Use the following command to attach a zone: .sp .ne 2 .na -\fB\fBboot\fR [\fB--\fR \fIboot_options\fR]\fR +\fB\fBboot\fR [\fB-X\fR] [\fB--\fR \fIboot_options\fR]\fR .ad .sp .6 .RS 4n Boot (or activate) the specified zones. .sp +The \fI-X\fR option enables debug for the zone's brand while booting. +.sp The following \fIboot_options\fR are supported: .sp .ne 2 @@ -251,13 +254,15 @@ The source zone must be halted before this subcommand can be used. .sp .ne 2 .na -\fB\fBhalt\fR\fR +\fB\fBhalt [\fB-X\fR]\fR\fR .ad .sp .6 .RS 4n Halt the specified zones. \fBhalt\fR bypasses running the shutdown scripts inside the zone. It also removes run time resources of the zone. .sp +The \fI-X\fR option enables debug for the zone's brand while halting. +.sp Use: .sp .in +2 @@ -417,23 +422,27 @@ and normal restrictions for \fIzonepath\fR apply. .sp .ne 2 .na -\fB\fBready\fR\fR +\fB\fBready [\fB-X\fR]\fR\fR .ad .sp .6 .RS 4n Prepares a zone for running applications but does not start any user processes in the zone. +.sp +The \fI-X\fR option enables debug for the zone's brand while readying. .RE .sp .ne 2 .na -\fB\fBreboot\fR\fR +\fB\fBreboot [\fB-X\fR]\fR\fR .ad .sp .6 .RS 4n Restart the zones. This is equivalent to a \fBhalt\fR \fBboot\fR sequence. This subcommand fails if the specified zones are not active. +.sp +The \fI-X\fR option enables debug for the zone's brand while rebooting. .RE .sp diff --git a/usr/src/man/man1m/zonecfg.1m b/usr/src/man/man1m/zonecfg.1m index 97cc6bbf57..88b6cdd770 100644 --- a/usr/src/man/man1m/zonecfg.1m +++ b/usr/src/man/man1m/zonecfg.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2004, 2009 Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2011 Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -9,17 +10,17 @@ zonecfg \- set up zone configuration .SH SYNOPSIS .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} .fi .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fIsubcommand\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fIsubcommand\fR .fi .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fB-f\fR \fIcommand_file\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fB-f\fR \fIcommand_file\fR .fi .LP @@ -42,7 +43,8 @@ The following synopsis of the \fBzonecfg\fR command is for interactive usage: .sp .in +2 .nf -zonecfg \fB-z\fR \fIzonename subcommand\fR +{\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} +zonecfg {\fB-z\fR \fIzonename | \fB-u\fR \fIuuid} subcommand\fR .fi .in -2 .sp @@ -164,6 +166,7 @@ Network interface. Resource control. .RE +.RE .SS "Properties" .sp .LP @@ -326,6 +329,27 @@ The following properties are supported: .sp .ne 2 .na +\fB(global)\fR +.ad +.sp .6 +.RS 4n +\fBfs-allowed\fR +.RE + +.sp +.ne 2 +.na +\fB(global)\fR +.ad +.sp .6 +.RS 4n +\fBzfs-io-priority\fR +.RE + +.sp +.ne 2 +.mk +.na \fB\fBfs\fR\fR .ad .sp .6 @@ -340,7 +364,7 @@ The following properties are supported: .ad .sp .6 .RS 4n -\fBaddress\fR, \fBphysical\fR, \fBdefrouter\fR +\fBaddress\fR, \fBallowed-address\fR, \fBdefrouter\fR, \fBglobal-nic\fR, \fBmac-addr\fR, \fBphysical\fR, \fBproperty\fR, \fBvlan-id\fR .RE .sp @@ -603,7 +627,17 @@ Values needed to determine how, where, and so forth to mount file systems. See .sp .ne 2 .na -\fB\fBnet\fR: address, physical, defrouter\fR +\fB\fBinherit-pkg-dir\fR: dir\fR +.ad +.sp .6 +.RS 4n +The directory path. +.RE + +.sp +.ne 2 +.na +\fB\fBnet\fR: address, allowed-address, defrouter, global-nic, mac-addr, physical, property, vlan-id\fR .ad .sp .6 .RS 4n @@ -642,6 +676,10 @@ zone. However, if the interface is not used by the global zone, it should be configured \fBdown\fR in the global zone, and the default router for the interface should be specified here. .sp +The global-nic is used for exclusive stack zones which will use a VNIC on-demand. When the zone boots, a VNIC named using the physical property will be created on the global NIC. If provided, the mac-addr and vlan-id will be set on this VNIC. +.sp +The \fBproperty\fR setting is a resource which can be used to set arbitrary name/value pairs on the network. These name/value pairs are made available to the zone's brand, which can use them as needed to set up the network interface. +.sp For an exclusive-IP zone, the physical property must be set and the address and default router properties cannot be set. .RE @@ -850,6 +888,37 @@ control and is related to the \fBzone.cpu-cap\fR resource control. See .RE .sp +.ne 2 +.mk +.na +\fBglobal: \fBfs-allowed\fR\fR +.ad +.sp .6 +.RS 4n +A comma-separated list of additional filesystems that may be mounted within +the zone; for example "ufs,pcfs". By default, only hsfs(7fs) and network +filesystems can be mounted. + +This property does not apply to filesystems mounted into the zone via "add fs" +or "add dataset". + +WARNING: allowing filesystem mounts other than the default may allow the zone +administrator to compromise the system with a malicious filesystem image, and +is not supported. +.RE + +.sp +.ne 2 +.mk +.na +\fBglobal: \fBzfs-io-priority\fR\fR +.ad +.sp .6 +.RS 4n +Specifies a priority for this zone's ZFS I/O. The priority is used by the ZFS I/O scheduler as in input to determine how to schedule I/O across zones. By default all zones have a priority of 1. The value can be increased for zones whose I/O is more critical. This property is the preferred way to set the \fBzone.zfs-io-priority\fR rctl. +.RE + +.sp .LP The following table summarizes resources, property-names, and types: .sp @@ -872,13 +941,22 @@ resource property-name type (global) max-shm-ids simple (global) max-shm-memory simple (global) scheduling-class simple +(global) zfs-io-priority simple fs dir simple special simple raw simple type simple options list of simple net address simple + allowed-address simple + defrouter simple + global-nic simple + mac-addr simple physical simple + property list of complex + name simple + value simple + vlan-id simple device match simple rctl name simple value list of complex @@ -1091,6 +1169,17 @@ name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and cannot be used. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-u\fR \fIuuid\fR\fR +.ad +.sp .6 +.RS 4n +Specify the uuid of a zone instead of the Zone name. +.RE + .SH SUBCOMMANDS .sp .LP @@ -1181,8 +1270,7 @@ correct to be committed, this operation automatically does a verify. .sp .ne 2 .na -\fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR -\fB-t\fR \fItemplate\fR\fB]\fR\fR +\fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR \fB-t\fR \fItemplate\fR\fB] [\fR\fB-X\fR\fB]\fR\fR .ad .sp .6 .RS 4n @@ -1204,6 +1292,8 @@ configured, it should be installed using the "\fBzoneadm attach\fR" command .sp Use the \fB-b\fR option to create a blank configuration. Without arguments, \fBcreate\fR applies the Sun default settings. +.sp +Use the \fB-X\fR option to facilitate creating a zone whose XML definition already exists on the host. The zone will be atomically added to the zone index file. .RE .sp diff --git a/usr/src/man/man1m/zpool.1m b/usr/src/man/man1m/zpool.1m index 90c2da4459..19d6dda8eb 100644 --- a/usr/src/man/man1m/zpool.1m +++ b/usr/src/man/man1m/zpool.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved. .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved. .\" Copyright (c) 2012 by Delphix. All rights reserved. .\" The contents of this file are subject to the terms of the Common Development @@ -61,7 +62,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ... +\fBzpool get\fR [\fB-p\fR] "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ... .fi .LP @@ -93,7 +94,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool list\fR [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... +\fBzpool list\fR [\fB-Hvp\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... .fi .LP @@ -1124,7 +1125,7 @@ is currently being used. This may lead to potential data corruption. .sp .ne 2 .na -\fB\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR +\fB\fBzpool get\fR [\fB-p\fR] "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR .ad .sp .6 .RS 4n @@ -1149,6 +1150,18 @@ properties. .sp .ne 2 .na +\fB\fB-p\fR\fR +.ad +.RS 6n +.rt +Display numbers in parseable (exact) values. +.RE + + +.sp +.ne 2 +.mk +.na \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR .ad .sp .6 @@ -1463,7 +1476,7 @@ the pool, in addition to the pool-wide statistics. .sp .ne 2 .na -\fB\fBzpool list\fR [\fB-Hv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR +\fB\fBzpool list\fR [\fB-Hvp\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR .ad .sp .6 .RS 4n @@ -1500,6 +1513,17 @@ Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wise statistics. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-p\fR\fR +.ad +.RS 12n +.rt +Display numbers in parseable (exact) values. +.RE + .RE .sp diff --git a/usr/src/man/man3c/port_associate.3c b/usr/src/man/man3c/port_associate.3c index d876b5c9d7..f6e66b0d65 100644 --- a/usr/src/man/man3c/port_associate.3c +++ b/usr/src/man/man3c/port_associate.3c @@ -73,21 +73,21 @@ the port. .LP Objects of type \fBPORT_SOURCE_FILE\fR are pointer to the structure \fBfile_obj\fR defined in \fB<sys/port.h>\fR. This event source provides event -notification when the specified file/directory is accessed or modified or when -its status changes. The path name of the file/directory to be watched is passed -in the \fBstruct file_obj\fR along with the \fBaccess\fR, \fBmodification\fR, -and \fBchange\fR time stamps acquired from a \fBstat\fR(2) call. If the file -name is a symbolic links, it is followed by default. The \fBFILE_NOFOLLOW\fR -needs to be passed in along with the specified events if the symbolic link -itself needs to be watched and \fBlstat()\fR needs to be used to get the file -status of the symbolic link file. +notification when the specified file/directory is accessed, modified, +truncated or when its status changes. The path name of the file/directory to +be watched is passed in the \fBstruct file_obj\fR along with the \fBaccess\fR, +\fBmodification\fR, and \fBchange\fR time stamps acquired from a \fBstat\fR(2) +call. If the file name is a symbolic link, it is followed by default. The +\fBFILE_NOFOLLOW\fR needs to be passed in along with the specified events if +the symbolic link itself needs to be watched and \fBlstat()\fR needs to be +used to get the file status of the symbolic link file. .sp .LP The \fBstruct file_obj\fR contains the following elements: .sp .in +2 .nf -timestruc_t fo_atime; /* Access time got from stat() */ +timestruc_t fo_atime; /* Access time from stat() */ timestruc_t fo_mtime; /* Modification time from stat() */ timestruc_t fo_ctime; /* Change time from stat() */ char *fo_name; /* Pointer to a null terminated path name */ @@ -104,11 +104,13 @@ occurs. .sp .LP The event types that can be specified at \fBport_associate()\fR time for -\fBPORT_SOURCE_FILE\fR are \fBFILE_ACCESS\fR, \fBFILE_MODIFIED\fR, and -\fBFILE_ATTRIB\fR, corresponding to the three time stamps. An \fBfo_atime\fR -change results in the \fBFILE_ACCESS\fR event, an \fBfo_mtime\fR change results -in the \fBFILE_MODIFIED\fR event, and an \fBfo_time\fR change results in the -\fBFILE_ATTRIB\fR event. +\fBPORT_SOURCE_FILE\fR are \fBFILE_ACCESS\fR, \fBFILE_MODIFIED\fR, +\fBFILE_ATTRIB\fR, and \fbFILE_TRUNC\fR. The first three of these correspond +to the three time stamps: an \fBfo_atime\fR change results in the +\fBFILE_ACCESS\fR event, an \fBfo_mtime\fR change results in the +\fBFILE_MODIFIED\fR event, and an \fBfo_ctime\fR change results in the +\fBFILE_ATTRIB\fR event. If the operation that induced the time stamp update +also truncated the file, \fBFILE_TRUNC\fR will be set in the resulting event. .sp .LP The following exception events are delivered when they occur. These event types diff --git a/usr/src/man/man3malloc/umem_alloc.3malloc b/usr/src/man/man3malloc/umem_alloc.3malloc index cc8e3df369..d8680ca083 100644 --- a/usr/src/man/man3malloc/umem_alloc.3malloc +++ b/usr/src/man/man3malloc/umem_alloc.3malloc @@ -174,6 +174,19 @@ Set the underlying function used to allocate memory. This option can be set to \fBmmap\fR(2)-based source. If set to a value that is not supported, \fBsbrk\fR will be used. .RE +.sp +.ne 2 +.na +\fB\fBperthread_cache\fR=\fBsize\fR\fR +.ad +.RS 16n +libumem allows for each thread to cache recently freed small allocations for +future allocations. The size argument, which accepts k, m, g, and t, suffixes +denotes the maximum amount of memory each thread can use for this purpose. The +default amount used is 1 MB. Any buffers in the per-thread cache are freed when +the thread exits. The efficacy of the per-thread cache can be determined with +the \fB::umastat\fR \fBmdb\fR(1) \fIdcmd\fR debugger command. +.RE .ne 2 .na diff --git a/usr/src/man/man4/ssh_config.4 b/usr/src/man/man4/ssh_config.4 index c3d8212d03..7f2a9bb64e 100644 --- a/usr/src/man/man4/ssh_config.4 +++ b/usr/src/man/man4/ssh_config.4 @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. .\" To view Portions Copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the specified path to access the file at the installed location. .\" 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 @@ -528,7 +529,7 @@ capabilities of the \fBssh\fR(1) client on that host should match that file. .sp .ne 2 .na -\fB\fBKeepAlive\fR\fR +\fB\fBTCPKeepAlive\fR\fR .ad .sp .6 .RS 4n diff --git a/usr/src/man/man4/sshd_config.4 b/usr/src/man/man4/sshd_config.4 index b26fa40bdb..d87b71d491 100644 --- a/usr/src/man/man4/sshd_config.4 +++ b/usr/src/man/man4/sshd_config.4 @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -169,9 +170,9 @@ Sets the number of client alive messages, (see \fBClientAliveInterval\fR), that can be sent without \fBsshd\fR receiving any messages back from the client. If this threshold is reached while client alive messages are being sent, \fBsshd\fR disconnects the client, terminating the session. The use of client -alive messages is very different from \fBKeepAlive\fR. The client alive +alive messages is very different from \fBTCPKeepAlive\fR. The client alive messages are sent through the encrypted channel and therefore are not -spoofable. The TCP keepalive option enabled by \fBKeepAlive\fR is spoofable. +spoofable. The TCP keepalive option enabled by \fBTCPKeepAlive\fR is spoofable. The client alive mechanism is valuable when a client or server depend on knowing when a connection has become inactive. .sp @@ -402,7 +403,7 @@ this parameter can only be set to \fByes\fR.) .sp .ne 2 .na -\fB\fBKeepAlive\fR\fR +\fB\fBTCPKeepAlive\fR\fR .ad .sp .6 .RS 4n diff --git a/usr/src/man/man5/privileges.5 b/usr/src/man/man5/privileges.5 index be969c17a8..138cd908b2 100644 --- a/usr/src/man/man5/privileges.5 +++ b/usr/src/man/man5/privileges.5 @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PRIVILEGES 5 "May 29, 2009" +.TH PRIVILEGES 5 "March 7, 2012" .SH NAME privileges \- process privilege model .SH DESCRIPTION @@ -283,6 +284,16 @@ Allow a process to perform privileged mappings through a graphics device. .sp .ne 2 .na +\fB\fBPRIV_HYPRLOFS_CONTROL\fR\fR +.ad +.sp .6 +.RS 4n +Allow a process to perform hyprlofs name space management. +.RE + +.sp +.ne 2 +.na \fB\fBPRIV_IPC_DAC_READ\fR\fR .ad .sp .6 diff --git a/usr/src/man/man5/resource_controls.5 b/usr/src/man/man5/resource_controls.5 index a600a79d5a..747f8406fa 100644 --- a/usr/src/man/man5/resource_controls.5 +++ b/usr/src/man/man5/resource_controls.5 @@ -1,16 +1,18 @@ '\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH RESOURCE_CONTROLS 5 "Jul 2, 2007" +.TH RESOURCE_CONTROLS 5 "Sep 16, 2012" .SH NAME -resource_controls \- resource controls available through project database +resource_controls \- resource controls available through projects and zones .SH DESCRIPTION .sp .LP -The resource controls facility is configured through the project database. See -\fBproject\fR(4). You can set and modify resource controls through the +For projects the resource controls facility is configured through the project +database. See \fBproject\fR(4). For zones, resource controls are configured +through \fBzonecfg\fR(1M). You can set and modify resource controls through the following utilities: .RS +4 .TP @@ -36,6 +38,12 @@ following utilities: .el o \fBrctladm\fR(1M) .RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBzonecfg\fR(1M) +.RE .sp .LP In a program, you use \fBsetrctl\fR(2) to set resource control values. @@ -273,6 +281,19 @@ Maximum allowable number of event ports, expressed as an integer. .sp .ne 2 .na +\fB\fBproject.max-processes\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of processes that can be active in a project. This rctl is +similar to \fBproject.max-lwps\fR, except that zombie processes are included. +This rctl prevents process-slot exhaustion which can occur due to an excessive +number of zombies. Expressed as an integer. +.RE + +.sp +.ne 2 +.na \fB\fBproject.max-sem-ids\fR\fR .ad .sp .6 @@ -361,6 +382,33 @@ The following zone-wide resource controls are available: .sp .ne 2 .na +\fB\fBzone.cpu-baseline\fR\fR +.ad +.sp .6 +.RS 4n +Sets a baseline amount of CPU time that a zone can use before it is considered +to be bursting. The unit used is the percentage of a single CPU that is being +used by all user threads in a zone. The value should be less than the +\fBzone.cpu-cap\fR rctl value and is expressed as an integer. +This resource control does not support the \fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na +\fB\fBzone.cpu-burst-time\fR\fR +.ad +.sp .6 +.RS 4n +Sets the number of seconds that a zone can exceed the \fBzone.cpu-baseline\fR +rctl value before being cpu-capped down to the \fBzone.cpu-baseline\fR. +A value of 0 means that \fBzone.cpu-baseline\fR can be exceeded indefinitely. +This resource control does not support the \fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na \fB\fBzone.cpu-cap\fR\fR .ad .sp .6 @@ -379,7 +427,7 @@ not support the \fBsyslog\fR action. .ad .sp .6 .RS 4n -Sets a limit on the number of fair share scheduler (FSS) CPU shares for a zone. +Sets a value on the number of fair share scheduler (FSS) CPU shares for a zone. CPU shares are first allocated to the zone, and then further subdivided among projects within the zone as specified in the \fBproject.cpu-shares\fR entries. Expressed as an integer. This resource control does not support the @@ -399,14 +447,25 @@ Total amount of physical locked memory available to a zone. .sp .ne 2 .na +\fB\fBzone.max-lofi\fR\fR +.ad +.sp .6 +.RS 4n +Sets a limit on the number of \fBLOFI\fR(7D) devices that can be created in a +zone. Expressed as an integer. This resource control does not support the +\fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na \fB\fBzone.max-lwps\fR\fR .ad .sp .6 .RS 4n -Enhances resource isolation by preventing too many LWPs in one zone from -affecting other zones. A zone's total LWPs can be further subdivided among -projects within the zone within the zone by using \fBproject.max-lwps\fR -entries. Expressed as an integer. +Sets a limit on how many LWPs can be active in a zone. A zone's total LWPs +can be further subdivided among projects within the zone within the zone by +using \fBproject.max-lwps\fR entries. Expressed as an integer. .RE .sp @@ -423,6 +482,33 @@ integer. .sp .ne 2 .na +\fB\fBzone.max-physical-memory\fR\fR +.ad +.sp .6 +.RS 4n +Sets a limit on the amount of physical memory (RSS) that can be used by a zone +before resident pages start being forcibly paged out. The unit used is bytes. +Expressed as an integer. This resource control does not support the +\fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na +\fB\fBzone.max-processes\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of processes that can be active in a zone. This rctl is +similar to \fBzone.max-lwps\fR, except that zombie processes are included. +This rctl prevents process-slot exhaustion which can occur due to an excessive +number of zombies. This rctl can be further subdivided among projects within +the zone using \fBproject.max-processes\fR. Expressed as an integer. +.RE + +.sp +.ne 2 +.na \fB\fBzone.max-sem-ids\fR\fR .ad .sp .6 @@ -464,6 +550,18 @@ mappings and \fBtmpfs\fR mounts for this zone. .RE .sp +.ne 2 +.na +\fB\fBzone.zfs-io-priority\fR\fR +.ad +.sp .6 +.RS 4n +Sets a value for the \fBzfs\fR(1M) I/O priority for a zone. This is used as +one of the inputs to determine if a zone's I/O should be throttled. Expressed +as an integer. This resource control does not support the \fBsyslog\fR action. +.RE + +.sp .LP See \fBzones\fR(5). .SS "Units Used in Resource Controls" diff --git a/usr/src/man/man7d/lofi.7d b/usr/src/man/man7d/lofi.7d index 72b2d9781b..81fffc6354 100644 --- a/usr/src/man/man7d/lofi.7d +++ b/usr/src/man/man7d/lofi.7d @@ -136,7 +136,3 @@ through the \fBlofi\fR file driver. .LP For compatibility purposes, a raw device is also exported with the block device. (For example, \fBnewfs\fR(1M)). -.sp -.LP -The \fBlofi\fR driver isn't available in a zone and will not work inside a -zone. diff --git a/usr/src/man/man7fs/Makefile b/usr/src/man/man7fs/Makefile index dc3755ed0d..e3f5c084b3 100644 --- a/usr/src/man/man7fs/Makefile +++ b/usr/src/man/man7fs/Makefile @@ -12,6 +12,7 @@ # # Copyright 2011, Richard Lowe # Copyright 2011 Nexenta Systems, Inc. All rights reserved. +# Copyright 2012 Joyent, Inc. All rights reserved. # include ../../Makefile.master @@ -24,7 +25,9 @@ MANFILES = ctfs.7fs \ devfs.7fs \ fd.7fs \ hsfs.7fs \ + hyprlofs.7fs \ lofs.7fs \ + lxproc.7fs \ objfs.7fs \ pcfs.7fs \ sharefs.7fs \ diff --git a/usr/src/man/man7fs/hyprlofs.7fs b/usr/src/man/man7fs/hyprlofs.7fs new file mode 100644 index 0000000000..8655791193 --- /dev/null +++ b/usr/src/man/man7fs/hyprlofs.7fs @@ -0,0 +1,62 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. +.\" 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 HYPRLOFS 7FS "March 7, 2012" +.SH NAME +hyprlofs \- fast name space virtual file system +.SH SYNOPSIS +.LP +.nf +#include <sys/fs/hyprlofs.h> + +\fB\fR\fBmount\fR (\fB\fR\fIspecial\fR, \fB\fR\fIdirectory\fR, \fB\fR\fIMS_DATA\fR, \fB\fR\fI"hyprlofs"\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBhyprlofs\fR is a hybrid file system combining features from +\fBtmpfs(7FS)\fR and \fBlofs(7FS)\fR. +As with \fBlofs\fR, the \fBhyprlofs\fR file system allows new, virtual file +systems to be created which provide access to existing files using alternate +pathnames. In addition, the files themselves may have alternate names and +paths within the mount. +Unlike \fBlofs\fR, files cannot be created and backing files cannot be removed. +The name space is completely managed through ioctls on the mount. +Entries in the name space are not mounts and thus, they will not appear in the +mnttab. The file system is designed to provide a very fast name space to the +backing files. The name space can be modified very quickly through the ioctl +interface. +.sp +.LP +\fBhyprlofs\fR file systems can be mounted with the command: +.sp +.in +2 +.nf +\fBmount \fR\fB-F\fR\fB hyprlofs swap \fR\fIdirectory\fR +.fi +.in -2 + +.sp +.LP +The name space used by \fBhyprlofs\fR exists only in-memory so it will consume +a small amount of the system's virtual memory. The files themselves are backed +by the original file as with \fBlofs\fR. + +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), \fBmount\fR(1M), \fBswap\fR(1M), +\fBmount\fR(2), \fBumount\fR(2) +.sp +.LP +\fISystem Administration Guide: Basic Administration\fR +.SH DIAGNOSTICS +.sp +.LP +\fBdf\fR(1M) output is of limited accuracy since +the space available to \fBhyprlofs\fR is dependent on the swap +space demands of the entire system and the files in the name space are not +included. diff --git a/usr/src/man/man7fs/lxproc.7fs b/usr/src/man/man7fs/lxproc.7fs new file mode 100644 index 0000000000..fe8a0d6d35 --- /dev/null +++ b/usr/src/man/man7fs/lxproc.7fs @@ -0,0 +1,115 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. +.\" 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 LXPROC 7FS "April 25, 2012" +.SH NAME +lxproc \- a loosely Linux-compatible /proc +.SH SYNOPSIS +.LP +.nf +\fB\fR\fBmount\fR (\fB\fR\fI"lxproc"\fR, \fB\fR\fIdirectory\fR, \fB\fR\fIMS_DATA\fR, \fB\fR\fI"lxproc"\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBlxproc\fR is an implementation of the \fB/proc\fR filesystem that +loosely matches the Linux semantics of providing human-readable text files +that correspond to elements of the system. +As with both \fBproc\fR(4) and Linux \fB/proc\fR, \fBlxproc\fR makes available +a directory for every process, with each directory containing a number +of files; like Linux \fB/proc\fR but unlike \fBproc\fR(4), \fBlxproc\fR also +makes available a number of files related to system-wide information. +To ascertain the meaning and structure of the files provided via +\fBlxproc\fR, users should consult the Linux documentation. +.sp +.LP +The \fBlxproc\fR compatibility layer is +provided only as a best-effort for simple Linux \fB/proc\fR readers; it +is not intended to exactly mimic Linux semantics and nor does it attempt to +somehow fool a consumer into believing that it is operating within a Linux +environment. As such, \fBlxproc\fR should only be used by Linux-specific +programs that are willing to trade precision in understanding the +system in return for Linux compatibility. To programmatically understand +the system precisely and in terms of its native constructs, +one should not use \fBlxproc\fR, but rather \fBproc\fR(4) or +\fBkstat\fR(3KSTAT). +To understand +a process or group of processes from either a shell script or the command line, +one should not use \fBlxproc\fR, but rather \fBproc\fR(4)-based tools like +\fBprstat\fR(1M), +\fBpfiles\fR(1), +\fBpargs\fR(1), +\fBpmap\fR(1), +\fBptree\fR(1), +\fBplimit\fR(1), +\fBpflags\fR(1), +\fBpcred\fR(1), +\fBpstack\fR(1), +\fBpldd\fR(1), +\fBpsig\fR(1), +or +\fBpwdx\fR(1). +To understand system-wide constructs from either a shell script or the +command line, one should not use \fBlxproc\fR, but rather +\fBkstat\fR(3KSTAT)-based tools like +\fBkstat\fR(1M), +\fBmpstat\fR(1M), +\fBiostat\fR(1M), +\fBnetstat\fR(1M) or +\fBpsrinfo\fR(1M). +.sp +.LP +Like \fB/proc\fR, \fBlxproc\fR can be mounted on any mount point, but the +preferred mount point is \fB/system/lxproc\fR; if a zone brand elects to +mount it by default, this will (or should) generally be the mount point. +.sp +.LP +\fBlxproc\fR can be mounted with the command: +.sp +.in +2 +.nf +\fBmount \fR\fB-F\fR\fB lxproc lxproc \fR\fIdirectory\fR +.fi +.in -2 + +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), +\fBiostat\fR(1M), +\fBkstat\fR(1M), +\fBmpstat\fR(1M), +\fBmount\fR(1M), +\fBnetstat\fR(1M), +\fBpargs\fR(1), +\fBpcred\fR(1), +\fBpfiles\fR(1), +\fBpflags\fR(1), +\fBpldd\fR(1), +\fBplimit\fR(1), +\fBpmap\fR(1), +\fBprstat\fR(1M), +\fBpsig\fR(1), +\fBpsrinfo\fR(1M), +\fBpstack\fR(1), +\fBptree\fR(1), +\fBpwdx\fR(1), +\fBmount\fR(2), \fBumount\fR(2), \fBkstat\fR(3KSTAT), \fBproc\fR(4), +\fBkstat\fR(9S) + +.SH NOTES +.sp +.LP +When choosing between offering +Linux compatibility and telling the truth, \fBlxproc\fR emphatically picks +the truth. A particular glaring example of this is the Linux notion of +"tasks" (that is, threads), which -- due to historical misadventures on +Linux -- allocate their identifiers from the process identifier space. +(That is, each thread has in effect a pid.) Some Linux \fB/proc\fR readers +have come to depend on this attribute, and become confused when threads +appear with proper identifiers, so \fBlxproc\fR simply opts for the pre-2.6 +behavior, and does not present the tasks directory at all. + diff --git a/usr/src/man/man9e/detach.9e b/usr/src/man/man9e/detach.9e index b5e1ec78b8..d003dbba1e 100644 --- a/usr/src/man/man9e/detach.9e +++ b/usr/src/man/man9e/detach.9e @@ -14,7 +14,7 @@ detach \- detach or suspend a device -\fBint prefix\fR \fBdetach\fR(\fBdev_info_t\fR \fIdip\fR, \fBddi_detach_cmd_t\fR \fIcmd\fR); +\fBint prefix\fR \fBdetach\fR(\fBdev_info_t\fR *\fIdip\fR, \fBddi_detach_cmd_t\fR \fIcmd\fR); .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9f/net_hook_register.9f b/usr/src/man/man9f/net_hook_register.9f index 6cffdc1e64..3d10a10524 100644 --- a/usr/src/man/man9f/net_hook_register.9f +++ b/usr/src/man/man9f/net_hook_register.9f @@ -1,9 +1,10 @@ '\" te .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NET_HOOK_REGISTER 9F "May 1, 2008" +.TH NET_HOOK_REGISTER 9F "Mar 5, 2012" .SH NAME net_hook_register \- add a hook to be called in event processing .SH SYNOPSIS @@ -11,7 +12,7 @@ net_hook_register \- add a hook to be called in event processing .nf #include <sys/neti.h> -\fBnet_hook_t\fR \fBnet_hook_register\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBhook_t\fR *\fIhook\fR); +\fBint\fR \fBnet_hook_register\fR(\fBnet_handle_t\fR \fIinfo\fR, \fBchar\fR *\fIevent\fR, \fBhook_t\fR *\fIhook\fR); .fi .SH INTERFACE LEVEL @@ -22,7 +23,7 @@ Solaris DDI specific (Solaris DDI). .sp .ne 2 .na -\fB\fInet\fR\fR +\fB\fIinfo\fR\fR .ad .RS 8n value returned from a successful call to \fBnet_protocol_register()\fR. @@ -31,6 +32,15 @@ value returned from a successful call to \fBnet_protocol_register()\fR. .sp .ne 2 .na +\fB\fIname\fR\fR +.ad +.RS 8n +unique name for this hook. +.RE + +.sp +.ne 2 +.na \fB\fIhook\fR\fR .ad .RS 8n @@ -42,9 +52,10 @@ pointer to a \fBhook_t\fR structure. .LP The \fBnet_hook_register()\fR function uses hooks that allow callbacks to be registered with events that belong to a network protocol. A successful call to -\fBnet_hook_register()\fR requires that a valid handle for a network protocol -be provided (the \fInet\fR parameter), along with a hook description that -includes a reference to an available event. +\fBnet_hook_register()\fR requires that a valid handle for a network protocol be +provided (the \fIinfo\fR parameter), along with a unique name and a hook +description that includes a reference to an available event. No two hooks on the +same netstack may share a name. .sp .LP While it is possible to use the same \fBhook_t\fR structure with multiple calls @@ -154,6 +165,14 @@ because it conflicts with another hook. An example of this might be specifying with this value. .RE +.sp +.ne 2 +.na +\fBESHUTDOWN\fR +.ad +.RS 10n +The netstack corresponding to \fIinfo\fR is condemned or no longer exists. + .SH CONTEXT .sp .LP diff --git a/usr/src/man/man9f/net_instance_alloc.9f b/usr/src/man/man9f/net_instance_alloc.9f index 0f51ce67d6..146054f5d4 100644 --- a/usr/src/man/man9f/net_instance_alloc.9f +++ b/usr/src/man/man9f/net_instance_alloc.9f @@ -1,9 +1,10 @@ '\" te .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NET_INSTANCE_ALLOC 9F "May 1, 2008" +.TH NET_INSTANCE_ALLOC 9F "Mar 5, 2012" .SH NAME net_instance_alloc \- allocate a net_instance_t structure .SH SYNOPSIS @@ -25,7 +26,7 @@ Solaris DDI specific (Solaris DDI). \fB\fIversion\fR\fR .ad .RS 11n -must always be the symbol \fBNETI_VERSION\fR. +must always be the symbol \fBNETINFO_VERSION\fR. .RE .SH DESCRIPTION diff --git a/usr/src/man/man9f/net_protocol_lookup.9f b/usr/src/man/man9f/net_protocol_lookup.9f index d6707d7c9e..cafa4c2c4f 100644 --- a/usr/src/man/man9f/net_protocol_lookup.9f +++ b/usr/src/man/man9f/net_protocol_lookup.9f @@ -1,9 +1,10 @@ '\" te .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NET_PROTOCOL_LOOKUP 9F "May 1, 2008" +.TH NET_PROTOCOL_LOOKUP 9F "Mar 5, 2012" .SH NAME net_protocol_lookup \- locate an implementation of a network layer protocol .SH SYNOPSIS @@ -11,7 +12,7 @@ net_protocol_lookup \- locate an implementation of a network layer protocol .nf #include <sys/neti.h> -\fBnet_data_t\fR \fBnet_protocol_lookup\fR(\fBnetid_t\fR \fIid\fR, \fBconst\fR \fBchar\fR *\fIprotocol\fR); +\fBnet_handle_t\fR \fBnet_protocol_lookup\fR(\fBnetid_t\fR \fIid\fR, \fBconst\fR \fBchar\fR *\fIprotocol\fR); .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9f/net_protocol_release.9f b/usr/src/man/man9f/net_protocol_release.9f index 5f9d1c5be5..f1759d099d 100644 --- a/usr/src/man/man9f/net_protocol_release.9f +++ b/usr/src/man/man9f/net_protocol_release.9f @@ -1,9 +1,10 @@ '\" te .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NET_PROTOCOL_RELEASE 9F "May 1, 2008" +.TH NET_PROTOCOL_RELEASE 9F "Mar 5, 2012" .SH NAME net_protocol_release \- indicate that a reference to a network protocol is no longer required @@ -12,7 +13,7 @@ longer required .nf #include <sys/neti.h> -\fBint\fR \fBnet_protocol_release\fR(\fBnet_data_t\fR *\fInet\fR); +\fBint\fR \fBnet_protocol_release\fR(\fBnet_handle_t\fR \fIinfo\fR); .fi .SH INTERFACE LEVEL @@ -23,7 +24,7 @@ Solaris DDI specific (Solaris DDI). .sp .ne 2 .na -\fB\fInet\fR\fR +\fB\fIinfo\fR\fR .ad .RS 7n value returned from a successful call to \fBnet_protocol_lookup\fR(9F). diff --git a/usr/src/man/man9s/hook_t.9s b/usr/src/man/man9s/hook_t.9s index b8abef07a5..818603ba59 100644 --- a/usr/src/man/man9s/hook_t.9s +++ b/usr/src/man/man9s/hook_t.9s @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2012 Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HOOK_T 9S "May 1, 2008" +.TH HOOK_T 9S "Mar 5, 2012" .SH NAME hook_t \- callback structure for subscribing to netinfo events .SH SYNOPSIS @@ -38,6 +39,16 @@ typedef int (*hook_func_t)(net_event_t token, hook_data_t info, .fi .in -2 +.SS "CALLBACK RETURN VALUES" +.sp +.LP +The value returned by the \fBhook_func_t\fR function indicates whether or not +the packet should still be considered valid. If the callback function has +modified the packet in such a way that it should no longer be processed or +considered valid, e.g. called \fBfreemsg\fR(9F), then the callback should return +\fB1\fR. Otherwise it should return \fB0\fR. +.sp + .SS "HINT TYPES" .sp .LP diff --git a/usr/src/man/man9s/net_instance_t.9s b/usr/src/man/man9s/net_instance_t.9s index 956bbcdb3a..4f4b143276 100644 --- a/usr/src/man/man9s/net_instance_t.9s +++ b/usr/src/man/man9s/net_instance_t.9s @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2012 Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NET_INSTANCE_T 9S "May 1, 2008" +.TH NET_INSTANCE_T 9S "Mar 5, 2012" .SH NAME net_instance_t \- packet event structure passed through to hooks .SH SYNOPSIS @@ -51,7 +52,8 @@ Name of the owner of the instance. \fB\fBnin_create\fR\fR .ad .RS 16n -Function to be called when a new instance of \fBIP\fR is created. +Function to be called when a new instance of \fBIP\fR is created. It may not +return \fBNULL\fR. .RE .sp |