diff options
Diffstat (limited to 'usr/src/man/man1')
| -rw-r--r-- | usr/src/man/man1/Makefile | 14 | ||||
| -rw-r--r-- | usr/src/man/man1/column.1 | 129 | ||||
| -rw-r--r-- | usr/src/man/man1/crontab.1 | 47 | ||||
| -rw-r--r-- | usr/src/man/man1/dis.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/dump.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/elfdump.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/gprof.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/hostname.1 | 17 | ||||
| -rw-r--r-- | usr/src/man/man1/ld.so.1.1 | 21 | ||||
| -rw-r--r-- | usr/src/man/man1/machid.1 | 25 | ||||
| -rw-r--r-- | usr/src/man/man1/mdb.1 | 24 | ||||
| -rw-r--r-- | usr/src/man/man1/nawk.1 | 148 | ||||
| -rw-r--r-- | usr/src/man/man1/nm.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/pfexec.1 | 6 | ||||
| -rw-r--r-- | usr/src/man/man1/ps.1 | 6 | ||||
| -rw-r--r-- | usr/src/man/man1/pvs.1 | 4 | ||||
| -rw-r--r-- | usr/src/man/man1/sed.1 | 22 | ||||
| -rw-r--r-- | usr/src/man/man1/zlogin.1 | 81 |
18 files changed, 454 insertions, 110 deletions
diff --git a/usr/src/man/man1/Makefile b/usr/src/man/man1/Makefile index 6257a9c763..a4d59dadcc 100644 --- a/usr/src/man/man1/Makefile +++ b/usr/src/man/man1/Makefile @@ -72,6 +72,7 @@ MANFILES= acctcom.1 \ clear.1 \ cmp.1 \ col.1 \ + column.1 \ comm.1 \ command.1 \ compress.1 \ @@ -218,6 +219,7 @@ MANFILES= acctcom.1 \ m4.1 \ mac.1 \ mach.1 \ + machid.1 \ madv.so.1.1 \ mail.1 \ mailcompat.1 \ @@ -469,6 +471,9 @@ MANLINKS= batch.1 \ helpuid.1 \ helpyorn.1 \ hist.1 \ + i286.1 \ + i386.1 \ + i486.1 \ if.1 \ intro.1 \ jsh.1 \ @@ -516,9 +521,11 @@ MANLINKS= batch.1 \ sh.1 \ snca.1 \ source.1 \ + sparc.1 \ spellin.1 \ stop.1 \ strconf.1 \ + sun.1 \ switch.1 \ ulimit.1 \ unalias.1 \ @@ -653,6 +660,12 @@ unlimit.1 := LINKSRC = limit.1 dumpkeys.1 := LINKSRC = loadkeys.1 +i286.1 := LINKSRC = machid.1 +i386.1 := LINKSRC = machid.1 +i486.1 := LINKSRC = machid.1 +sparc.1 := LINKSRC = machid.1 +sun.1 := LINKSRC = machid.1 + rmail.1 := LINKSRC = mail.1 page.1 := LINKSRC = more.1 @@ -710,7 +723,6 @@ hashcheck.1 := LINKSRC = spell.1 hashmake.1 := LINKSRC = spell.1 spellin.1 := LINKSRC = spell.1 - strconf.1 := LINKSRC = strchg.1 settime.1 := LINKSRC = touch.1 diff --git a/usr/src/man/man1/column.1 b/usr/src/man/man1/column.1 new file mode 100644 index 0000000000..a8c23310ba --- /dev/null +++ b/usr/src/man/man1/column.1 @@ -0,0 +1,129 @@ +.\" Copyright (c) 1989, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)column.1 8.1 (Berkeley) 6/6/93 +.\" $FreeBSD$ +.\" +.\" Portions Copyright (c) 2013 Joyent, Inc. All rights reserved. +.\" +.TH COLUMN 1 "Jan 10, 2013" +.SH NAME +column \- columnate lists +.SH SYNOPSIS +.LP +.nf +\fBcolumn\fR [\fB-tx\fR] [\fB-c\fR \fIcolumns\fR] [\fB-s\fR \fIsep\fR] [\fIfile\fR ... ] +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBcolumn\fR +utility formats its input into multiple columns. +Rows are filled before columns. +Input is taken from +\fIfile\fR +operands, or, by default, from the standard input. +Empty lines are ignored. +.SH OPTIONS +.sp +.LP +The options are as follows: +.sp +.ne 2 +.na +\fB\fB-c\fR \fIcolumns\fR\fR +.ad +.RS 17n +Output is formatted for a display \fIcolumns\fR +wide. +.RE + +.sp +.ne 2 +.na +\fB\fB-s\fR \fIsep\fR\fR +.ad +.RS 17n +Specify a set of characters to be used to delimit columns for the +\fB-t\fR option. +.RE + +.sp +.ne 2 +.na +\fB\fB-t\fR\fR +.ad +.RS 17n +Determine the number of columns the input contains and create a table. +Columns are delimited with whitespace, by default, or with the characters +supplied using the \fBs\fR +option. +Useful for pretty-printing displays. +.RE + +.sp +.ne 2 +.na +\fB-x\fR +.ad +.RS 17n +Fill columns before filling rows. +.RE + +.SH ENVIRONMENT +The COLUMNS , LANG , LC_ALL +and +LC_CTYPE +environment variables affect the execution of +\fBcolumn\fR +as described in +\fBenviron\fR(5). + +.SH EXIT STATUS +The \fBcolumn\fR utility exits 0 on success and >0 if an error occurs. + +.SH EXAMPLES +.sp +.in +2 +.nf +(printf \&"PERM LINKS OWNER GROUP SIZE MONTH DAY \&"\ \&;\ \&\e +printf \&"HH:MM/YEAR NAME\en\&"\ \&;\ \&\e +ls -l \&| sed 1d) \&| column -t +.fi +.in -2 +.sp + + +.SH SEE ALSO +\fBls\fR(1), \fBpaste\fR(1), \fBsort\fR(1) + +.SH HISTORY +The \fBcolumn\fR command appeared in 4.3BSD-Reno. + +.SH BUGS +Input lines are limited to LINE_MAX bytes in length. diff --git a/usr/src/man/man1/crontab.1 b/usr/src/man/man1/crontab.1 index df6c3a8619..5a83c44530 100644 --- a/usr/src/man/man1/crontab.1 +++ b/usr/src/man/man1/crontab.1 @@ -41,6 +41,8 @@ .\" .\" .\" 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 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved .\" @@ -60,7 +62,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -80,7 +82,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/xpg4/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/xpg4/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -100,7 +102,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/xpg6/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/xpg6/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -119,6 +121,17 @@ 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 editable whereas those in +\fB/etc/cron.d/crontabs\fR are system-defined entries which may not +be customized by the user. The dual set of crontab entries is only +of interest to system-defined users such as \fBroot\fR. Except where +otherwise explicitly indicated, all variants of the \fBcrontab\fR command +act only on the editable crontab files found in \fB/var/spool/cron/crontabs\fR. .SS "\fBcrontab\fR Access Control" .LP Users: Access to \fBcrontab\fR is allowed: @@ -371,6 +384,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 @@ -382,6 +398,22 @@ 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 the user's \fB/var/spool/cron/crontabs\fR file are listed, unless +the \fB-g\fR option is given, in which case only entries from the user's +\fB/etc/cron.d/crontabs\fR file are listed. +.RE + +.sp +.ne 2 +.na +\fB\fB-g\fR\fR +.ad +.RS 6n +In conjunction with the \fB-l\fR option, lists the global \fBcrontab\fR file +for the invoking or specified user (if authorized) instead of the editable +\fBcrontab\fR file. This option is not valid unless the \fB-l\fR option is +also given. .RE .sp @@ -605,6 +637,15 @@ list of denied users .sp .ne 2 .na +\fB\fB/etc/cron.d/crontabs\fR\fR +.ad +.RS 28n +system spool area for \fBcrontab\fR +.RE + +.sp +.ne 2 +.na \fB\fB/var/cron/log\fR\fR .ad .RS 28n diff --git a/usr/src/man/man1/dis.1 b/usr/src/man/man1/dis.1 index bff3a55372..dcb12b50b6 100644 --- a/usr/src/man/man1/dis.1 +++ b/usr/src/man/man1/dis.1 @@ -44,7 +44,7 @@ .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved .\" -.TH DIS 1 "Aug 24, 2009" +.TH DIS 1 "Dec 19, 2018" .SH NAME dis \- object code disassembler .SH SYNOPSIS @@ -74,7 +74,7 @@ The following options are supported: \fB\fB-C\fR\fR .ad .RS 15n -Displays demangled C++ symbol names in the disassembly. +Displays demangled symbol names in the disassembly. .RE .sp diff --git a/usr/src/man/man1/dump.1 b/usr/src/man/man1/dump.1 index 50540b462d..ebe40fe09a 100644 --- a/usr/src/man/man1/dump.1 +++ b/usr/src/man/man1/dump.1 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH DUMP 1 "Sep 6, 2002" +.TH DUMP 1 "Dec 19, 2018" .SH NAME dump \- dump selected parts of an object file .SH SYNOPSIS @@ -65,7 +65,7 @@ Dumps the string table(s). \fB\fB-C\fR\fR .ad .RS 20n -Dumps decoded C++ symbol table names. +Dumps decoded symbol table names. .RE .sp diff --git a/usr/src/man/man1/elfdump.1 b/usr/src/man/man1/elfdump.1 index c27e7aef0b..01a9963189 100644 --- a/usr/src/man/man1/elfdump.1 +++ b/usr/src/man/man1/elfdump.1 @@ -11,7 +11,7 @@ .\" 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 ELFDUMP 1 "Apr 3, 2009" +.TH ELFDUMP 1 "Dec 19, 2018" .SH NAME elfdump \- dumps selected parts of an object file .SH SYNOPSIS @@ -111,7 +111,7 @@ Dumps section header information. \fB\fB-C\fR\fR .ad .RS 18n -Demangles C++ symbol names. +Demangles symbol names. .RE .sp diff --git a/usr/src/man/man1/gprof.1 b/usr/src/man/man1/gprof.1 index 4e2d0bf807..a6bfc0f2b4 100644 --- a/usr/src/man/man1/gprof.1 +++ b/usr/src/man/man1/gprof.1 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH GPROF 1 "Feb 8, 2007" +.TH GPROF 1 "Dec 19, 2018" .SH NAME gprof \- display call-graph profile data .SH SYNOPSIS @@ -109,7 +109,7 @@ shared objects' text segments are not examined. \fB\fB-C\fR\fR .ad .RS 19n -Demangle C++ symbol names before printing them out. +Demangle symbol names before printing them out. .RE .sp diff --git a/usr/src/man/man1/hostname.1 b/usr/src/man/man1/hostname.1 index 8d81482755..74e9c16938 100644 --- a/usr/src/man/man1/hostname.1 +++ b/usr/src/man/man1/hostname.1 @@ -1,8 +1,9 @@ .\" Copyright (c) 1992, Sun Microsystems, Inc. +.\" Copyright 2016 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] -.Dd May 12, 2016 +.Dd Aug 26, 2016 .Dt HOSTNAME 1 .Os .Sh NAME @@ -20,6 +21,19 @@ command prints the name of the current host, as given before the prompt. The super-user can set the hostname by giving .Ar name-of-host . +.Pp +While setting the hostname changes the hostname for the running system, +it does not persist the change. +The proper way to update the hostname will vary depending on how the +system is configured. +For most systems, the persistent hostname is stored in the file +.Pa /etc/nodename . +See +.Xr nodename 4 +for more information on how to update it. +Note, the +.Pa /etc/nodename +file may be ignored in cases where the system is configured to use DHCP. .Sh OPTIONS .Bl -tag -width Ds .It Fl s @@ -27,4 +41,5 @@ Prints only the part of the hostname preceding the first dot. .El .Sh SEE ALSO .Xr uname 1 , +.Xr nodename 4 , .Xr attributes 5 diff --git a/usr/src/man/man1/ld.so.1.1 b/usr/src/man/man1/ld.so.1.1 index 4b14ca4f1a..19afbbf3d6 100644 --- a/usr/src/man/man1/ld.so.1.1 +++ b/usr/src/man/man1/ld.so.1.1 @@ -1,9 +1,10 @@ '\" .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2014, 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 LD.SO.1 1 "Oct 5, 2012" +.TH LD.SO.1 1 "May 8, 2014" .SH NAME ld.so.1 \- runtime linker for dynamic objects .SH SYNOPSIS @@ -574,6 +575,24 @@ aid debugging. See also the \fBRTLD_DI_SETSIGNAL\fR request to .RE .sp +.ne 2 +.na +.BR LD_TOXIC_PATH, +.BR LD_TOXIC_PATH_32, +.BR LD_TOXIC_PATH_64, +.ad +.sp .6 +.RS 4n +The toxic path refers to a set of paths where by, if +.B ld.so.1 +were to load a dependency on that path, rather than loading it, it +should kill the process. This is useful when having built libraries that +while matching the native architecture of the system, are not suitable +to be used, for example, libraries that that correspond to an alternate +release of an operating system. +.RE + +.sp .LP Notice that environment variable names beginning with the characters '\fBLD_\fR' are reserved for possible future enhancements to \fBld\fR(1) and diff --git a/usr/src/man/man1/machid.1 b/usr/src/man/man1/machid.1 new file mode 100644 index 0000000000..cb95fa36b6 --- /dev/null +++ b/usr/src/man/man1/machid.1 @@ -0,0 +1,25 @@ +'\" te +.\" Copyright 1989 AT&T +.\" Copyright (c) 1999, Sun Microsystems, Inc. +.\" All Rights Reserved +.\" Copyright 2015, 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 MACHID 1 "Feb 27, 2015" +.SH NAME +machid, sun, i286, i386, i486, sparc \- get processor type truth value + +.SH DESCRIPTION +.sp +.LP +These commands are obsolete and may be removed in a future version of the +software. +.sp +.ne 2 +.na +.SH NOTES +.sp +.LP +The \fBmachid\fR family of commands is obsolete. Use \fBuname\fR \fB-p\fR and +\fBuname\fR \fB-m\fR instead. diff --git a/usr/src/man/man1/mdb.1 b/usr/src/man/man1/mdb.1 index 8fdd91e661..e197836a1c 100644 --- a/usr/src/man/man1/mdb.1 +++ b/usr/src/man/man1/mdb.1 @@ -11,7 +11,7 @@ mdb \- modular debugger .SH SYNOPSIS .LP .nf -\fBmdb\fR [\fB-fkmuwyAFKMSUW\fR] [\(+-o \fIoption\fR] [\fB-p\fR \fIpid\fR] [\fB-s\fR \fIdistance\fR] +\fBmdb\fR [\fB-fkmuwyAFKMSUW\fR] [\(+-o \fIoption\fR] [\fB-b\fR \fIVM\fR] [\fB-p\fR \fIpid\fR] [\fB-s\fR \fIdistance\fR] [\fB-I\fR \fIpath\fR] [\fB-L\fR \fIpath\fR] [\fB-P\fR \fIprompt\fR] [\fB-R\fR \fIroot\fR] [\fB-V\fR \fIdis-version\fR] [\fB-e\fR \fIexpr\fR] [object [core] | core | suffix] .fi @@ -50,12 +50,13 @@ different contexts, including live and post-mortem. .LP The \fItarget\fR is the program being inspected by the debugger. \fBmdb\fR currently provides support for the following types of targets: user processes, -user process core files, the live operating system (via \fB/dev/kmem\fR and -\fB/dev/ksyms\fR), operating system crash dumps, user process images recorded -inside an operating system crash dump, \fBELF\fR object files, and raw binary -files. Each target exports a standard set of properties, including one or more -address spaces, one or more symbol tables, a set of load objects, and a set of -threads that can be examined using the debugger commands described below. +user process core files, live bhyve VMs, the live operating system (via +\fB/dev/kmem\fR and \fB/dev/ksyms\fR), operating system crash dumps, user +process images recorded inside an operating system crash dump, \fBELF\fR object +files, and raw binary files. Each target exports a standard set of properties, +including one or more address spaces, one or more symbol tables, a set of load +objects, and a set of threads that can be examined using the debugger commands +described below. .sp .LP A debugger command, or \fIdcmd\fR (pronounced dee-command) in \fBmdb\fR @@ -3698,6 +3699,15 @@ system or an operating system crash dump. .sp .ne 2 .na +\fB\fB-b\fR \fIVM\fR\fR +.ad +.RS 15n +Attaches to and stops the specified bhyve VM. +.RE + +.sp +.ne 2 +.na \fB\fB-e\fR \fIexpr\fR\fR .ad .RS 15n diff --git a/usr/src/man/man1/nawk.1 b/usr/src/man/man1/nawk.1 index 4b321c6bd6..5fec573a52 100644 --- a/usr/src/man/man1/nawk.1 +++ b/usr/src/man/man1/nawk.1 @@ -43,13 +43,20 @@ .\" Copyright 1989 AT&T .\" Copyright 1992, X/Open Company Limited All Rights Reserved .\" Portions Copyright (c) 2005, 2006 Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2018, Joyent, Inc. .\" -.TH NAWK 1 "May 24, 2006" +.TH NAWK 1 "Nov 9, 2018" .SH NAME nawk \- pattern scanning and processing language .SH SYNOPSIS .LP .nf +\fB/usr/bin/awk\fR [\fB-F\fR \fIERE\fR] [\fB-v\fR \fIassignment\fR] \fI\&'program'\fR | \fB-f\fR \fIprogfile\fR... + [\fIargument\fR]... +.fi + +.LP +.nf \fB/usr/bin/nawk\fR [\fB-F\fR \fIERE\fR] [\fB-v\fR \fIassignment\fR] \fI\&'program'\fR | \fB-f\fR \fIprogfile\fR... [\fIargument\fR]... .fi @@ -61,9 +68,9 @@ nawk \- pattern scanning and processing language .fi .SH DESCRIPTION -.sp .LP -The \fB/usr/bin/nawk\fR and \fB/usr/xpg4/bin/awk\fR utilities execute +The \fB/usr/bin/awk\fR, \fB/usr/bin/nawk\fR and \fB/usr/xpg4/bin/awk\fR +utilities execute \fIprogram\fRs written in the \fBnawk\fR programming language, which is specialized for textual data manipulation. A \fBnawk\fR \fIprogram\fR is a sequence of patterns and corresponding actions. The string specifying @@ -88,8 +95,8 @@ utility denotes the first field in a record \fB$1\fR, the second \fB$2\fR, and so forth. The symbol \fB$0\fR refers to the entire record; setting any other field causes the reevaluation of \fB$0\fR. Assigning to \fB$0\fR resets the values of all fields and the \fBNF\fR built-in variable. + .SH OPTIONS -.sp .LP The following options are supported: .sp @@ -129,8 +136,18 @@ before executing the \fBnawk\fR program, including the actions associated with specified. .RE -.SH OPERANDS .sp +.ne 2 +.na +\fB\fB-safe\fR\fR +.ad +.RS 17n +When passed to \fBnawk\fR, this flag will prevent the program from opening new +files or running child processes. The \fBENVIRON\fR array will also not be +initialized. +.RE + +.SH OPERANDS .LP The following operands are supported: .sp @@ -193,7 +210,6 @@ assignments are executed before processing the standard input. .RE .SH INPUT FILES -.sp .LP Input files to the \fBnawk\fR program from any of the following sources: .RS +4 @@ -230,8 +246,8 @@ program. .LP The standard input are used only if no \fIfile\fR operands are specified, or if a \fIfile\fR operand is \fB\(mi\fR\&. + .SH EXTENDED DESCRIPTION -.sp .LP A \fBnawk\fR program is composed of pairs of the form: .sp @@ -263,8 +279,8 @@ program in the order of occurrence, and executing the action associated with each pattern that matches the current record. The action for a matching pattern is executed before evaluating subsequent patterns. Last, the actions associated with all \fBEND\fR patterns is executed in the order they occur in the program. + .SS "Expressions in nawk" -.sp .LP Expressions describe computations used in \fIpatterns\fR and \fIactions\fR. In the following table, valid expression operations are given in groups from @@ -288,9 +304,9 @@ _ $\fIexpr\fR Field reference string n/a _ ++ \fIlvalue\fR Pre-increment numeric n/a - \(mi\(mi\fIlvalue\fR Pre-decrement numeric n/a +\(mi\(mi \fIlvalue\fR Pre-decrement numeric n/a \fIlvalue\fR ++ Post-increment numeric n/a -\fIlvalue\fR \(mi\(mi Post-decrement numeric n/a +\fIlvalue\fR \(mi\(mi Post-decrement numeric n/a _ \fIexpr\fR ^ \fIexpr\fR Exponentiation numeric right _ @@ -303,7 +319,7 @@ _ \fIexpr\fR % \fIexpr\fR Modulus numeric left _ \fIexpr\fR + \fIexpr\fR Addition numeric left -\fIexpr\fR \(mi \fIexpr\fR Subtraction numeric left +\fIexpr\fR \(mi \fIexpr\fR Subtraction numeric left _ \fIexpr\fR \fIexpr\fR String concatenation string left _ @@ -319,20 +335,20 @@ _ _ \fIexpr\fR in array Array membership numeric left ( \fIindex\fR ) in Multi-dimension array numeric left - \fIarray\fR membership + \fIarray\fR membership _ \fBexpr\fR && \fIexpr\fR Logical AND numeric left _ \fBexpr\fR |\|| \fIexpr\fR Logical OR numeric left _ \fIexpr1\fR ? \fIexpr2\fR Conditional expression type of selected right - : \fIexpr3\fR \fIexpr2\fR or \fIexpr3\fR + : \fIexpr3\fR \fIexpr2\fR or \fIexpr3\fR _ \fIlvalue\fR ^= \fIexpr\fR Exponentiation numeric right - assignment + assignment \fIlvalue\fR %= \fIexpr\fR Modulus assignment numeric right \fIlvalue\fR *= \fIexpr\fR Multiplication numeric right - assignment + assignment \fIlvalue\fR /= \fIexpr\fR Division assignment numeric right \fIlvalue\fR += \fIexpr\fR Addition assignment numeric right \fIlvalue\fR \(mi= \fIexpr\fR Subtraction assignment numeric right @@ -479,8 +495,8 @@ A multi-dimensioned \fIindex\fR used with the \fBin\fR operator must be put in parentheses. The \fBin\fR operator, which tests for the existence of a particular array element, does not create the element if it does not exist. Any other reference to a non-existent array element automatically creates it. + .SS "Variables and Special Variables" -.sp .LP Variables can be used in an \fBnawk\fR program by referencing them. With the exception of function parameters, they are not explicitly declared. @@ -503,8 +519,8 @@ occurrence of the decimal-point character from the current locale changed to a period character, is considered a \fInumeric string\fR (see \fBExpressions in nawk\fR above), the field variable also has the numeric value of the \fInumeric string\fR. + .SS "/usr/bin/nawk, /usr/xpg4/bin/awk" -.sp .LP \fBnawk\fR sets the following special variables that are supported by both \fB/usr/bin/nawk\fR and \fB/usr/xpg4/bin/awk\fR: @@ -539,6 +555,16 @@ argument. .sp .ne 2 .na +\fB\fBCONVFMT\fR\fR +.ad +.RS 12n +The \fBprintf\fR format for converting numbers to strings (except for output +statements, where \fBOFMT\fR is used). The default is \fB%.6g\fR. +.RE + +.sp +.ne 2 +.na \fB\fBENVIRON\fR\fR .ad .RS 12n @@ -644,7 +670,7 @@ The \fBprint\fR output record separator; a newline character by default. .sp .ne 2 .na -\fB\fBLENGTH\fR\fR +\fB\fBRLENGTH\fR\fR .ad .RS 12n The length of the string matched by the \fBmatch\fR function. @@ -685,22 +711,21 @@ The subscript separator string for multi-dimensional arrays. The default value is \fB\e034\fR\&. .RE -.SS "/usr/xpg4/bin/awk" -.sp +.SS "/usr/bin/nawk" .LP -The following variable is supported for \fB/usr/xpg4/bin/awk\fR only: +The following variable is supported for \fB/usr/bin/nawk\fR only: .sp .ne 2 .na -\fB\fBCONVFMT\fR\fR +\fB\fBRT\fR\fR .ad -.RS 11n -The \fBprintf\fR format for converting numbers to strings (except for output -statements, where \fBOFMT\fR is used). The default is \fB%.6g\fR. +.RS 12n +The record terminator for the most recent record read. For most records this +will be the same value as \fBRS\fR. At the end of a file with no trailing +separator value, though, this will be set to the empty string (\fB""\fR). .RE .SS "Regular Expressions" -.sp .LP The \fBnawk\fR utility makes use of the extended regular expression notation (see \fBregex\fR(5)) except that it allows the use of C-language conventions to @@ -817,14 +842,14 @@ character and the record separator) can be embedded in the pattern and an appropriate pattern matches any character. However, in all \fBnawk\fR regular expression matching, the use of one or more NULL characters in the pattern, input record or text string produces undefined results. + .SS "Patterns" -.sp .LP A \fIpattern\fR is any valid \fIexpression,\fR a range specified by two expressions separated by comma, or one of the two special patterns \fBBEGIN\fR or \fBEND\fR. + .SS "Special Patterns" -.sp .LP The \fBnawk\fR utility recognizes two special patterns, \fBBEGIN\fR and \fBEND\fR. Each \fBBEGIN\fR pattern is matched once and its associated action @@ -848,23 +873,23 @@ without reading its input when the last statement in the last \fBBEGIN\fR action is executed. If an \fBnawk\fR program consists of only actions with the pattern \fBEND\fR or only actions with the patterns \fBBEGIN\fR and \fBEND\fR, the input is read before the statements in the \fBEND\fR actions are executed. + .SS "Expression Patterns" -.sp .LP An expression pattern is evaluated as if it were an expression in a Boolean context. If the result is true, the pattern is considered to match, and the associated action (if any) is executed. If the result is false, the action is not executed. + .SS "Pattern Ranges" -.sp .LP A pattern range consists of two expressions separated by a comma. In this case, the action is performed for all records between a match of the first expression and the following match of the second expression, inclusive. At this point, the pattern range can be repeated starting at input records subsequent to the end of the matched range. + .SS "Actions" -.sp .LP An action is a sequence of statements. A statement can be one of the following: .sp @@ -876,6 +901,7 @@ do \fIstatement\fR while ( \fIexpression\fR ) for ( \fIexpression\fR ; \fIexpression\fR ; \fIexpression\fR ) \fIstatement\fR for ( \fIvar\fR in \fIarray\fR ) \fIstatement\fR delete \fIarray\fR[\fIsubscript\fR] #delete an array element +delete \fIarray\fR #delete all elements within an array break continue { [ \fIstatement\fR ] .\|.\|. } @@ -883,6 +909,7 @@ continue print [ \fIexpression-list\fR ] [ >\fIexpression\fR ] printf format [ ,\fIexpression-list\fR ] [ >\fIexpression\fR ] next # skip remaining patterns on this input line +nextfile # skip remaining patterns on this input file exit [expr] # skip the rest of the input; exit status is expr return [expr] .fi @@ -900,6 +927,12 @@ record to be abandoned. The behavior is undefined if a \fBnext\fR statement appears or is invoked in a \fBBEGIN\fR or \fBEND\fR action. .sp .LP +The \fBnextfile\fR statement is similar to \fBnext\fR, but also skips all other +records in the current file, and moves on to processing the next input file if +available (or exits the program if there are none). (Note that this keyword is +not supported by \fB/usr/xpg4/bin/awk\fR.) +.sp +.LP The \fBexit\fR statement invokes all \fBEND\fR actions in the order in which they occur in the program source and then terminate the program without reading further input. An \fBexit\fR statement inside an \fBEND\fR action terminates @@ -907,8 +940,8 @@ the program without further execution of \fBEND\fR actions. If an expression is specified in an \fBexit\fR statement, its numeric value is the exit status of \fBnawk\fR, unless subsequent errors are encountered or a subsequent \fBexit\fR statement with an expression is executed. + .SS "Output Statements" -.sp .LP Both \fBprint\fR and \fBprintf\fR statements write to standard output by default. The output is written to the location specified by @@ -1046,13 +1079,13 @@ unspecified. .sp .LP Both \fBprint\fR and \fBprintf\fR can output at least \fB{LINE_MAX}\fR bytes. + .SS "Functions" -.sp .LP The \fBnawk\fR language has a variety of built-in functions: arithmetic, string, input/output and general. + .SS "Arithmetic Functions" -.sp .LP The arithmetic functions, except for \fBint\fR, are based on the \fBISO\fR \fBC\fR standard. The behavior is undefined in cases where the \fBISO\fR @@ -1144,7 +1177,6 @@ Set the seed value for \fBrand\fR to \fIexpr\fR or use the time of day if .RE .SS "String Functions" -.sp .LP The string functions in the following list shall be supported. Although the grammar permits built-in functions to appear with no arguments or parentheses, @@ -1176,12 +1208,15 @@ string \fIt\fR first occurs, or zero if it does not occur at all. .sp .ne 2 .na -\fB\fBlength\fR[([\fIs\fR])]\fR +\fB\fBlength\fR[([\fIv\fR])]\fR .ad .sp .6 .RS 4n -Return the length, in characters, of its argument taken as a string, or of the -whole record, \fB$0\fR, if there is no argument. +Given no argument, this function returns the length of the whole record, +\fB$0\fR. If given an array as an argument (and using \fB/usr/bin/nawk\fR), +then this returns the number of elements it contains. Otherwise, this function +interprets the argument as a string (performing any needed conversions) and +returns its length in characters. .RE .sp @@ -1294,8 +1329,8 @@ string by the upper-case letter specified by the mapping. Other characters in All of the preceding functions that take \fIERE\fR as a parameter expect a pattern or a string valued expression that is a regular expression as defined below. + .SS "Input/Output and General Functions" -.sp .LP The input/output and general functions are: .sp @@ -1313,6 +1348,20 @@ non-zero. .sp .ne 2 .na +\fB\fBfflush(\fR\fIexpression\fR)\fR +.ad +.RS 27n +Flush any buffered output for the file or pipe opened by a \fBprint\fR or +\fBprintf\fR statement or a call to \fBgetline\fR with the same string-valued +\fIexpression\fR. If the flush was successful, the function returns \fB0\fR; +otherwise, it returns \fBEOF\fR. If no arguments or the empty string +(\fB""\fR) are given, then all open files will be flushed. (Note that +\fBfflush\fR is supported in \fB/usr/bin/nawk\fR only.) +.RE + +.sp +.ne 2 +.na \fB\fIexpression\fR|\fBgetline\fR[\fIvar\fR]\fR .ad .RS 27n @@ -1343,7 +1392,7 @@ parentheses properly. .na \fB\fBgetline\fR\fR .ad -.RS 30n +.RS 27n Set \fB$0\fR to the next input record from the current input file. This form of \fBgetline\fR sets the \fBNF\fR, \fBNR\fR, and \fBFNR\fR variables. .RE @@ -1353,7 +1402,7 @@ Set \fB$0\fR to the next input record from the current input file. This form of .na \fB\fBgetline\fR \fIvar\fR\fR .ad -.RS 30n +.RS 27n Set variable \fIvar\fR to the next input record from the current input file. This form of \fBgetline\fR sets the \fBFNR\fR and \fBNR\fR variables. .RE @@ -1363,7 +1412,7 @@ This form of \fBgetline\fR sets the \fBFNR\fR and \fBNR\fR variables. .na \fB\fBgetline\fR [\fIvar\fR] \fB<\fR \fIexpression\fR\fR .ad -.RS 30n +.RS 27n Read the next record of input from a named file. The \fIexpression\fR is evaluated to produce a string that is used as a full pathname. If the file of that name is not currently open, it is opened. As long as the stream remains @@ -1385,7 +1434,7 @@ portable applications must be put in parentheses properly. .na \fB\fBsystem\fR(\fIexpression\fR)\fR .ad -.RS 30n +.RS 27n Execute the command given by \fIexpression\fR in a manner equivalent to the \fBsystem\fR(3C) function and return the exit status of the command. .RE @@ -1400,8 +1449,8 @@ Where strings are used as the name of a file or pipeline, the strings must be textually identical. The terminology ``same string value'' implies that ``equivalent strings'', even those that differ only by space characters, represent different files. + .SS "User-defined Functions" -.sp .LP The \fBnawk\fR language also provides user-defined functions. Such functions can be defined as: @@ -1453,8 +1502,8 @@ outside of a function definition, the behavior is undefined. In the function definition, newline characters are optional before the opening brace and after the closing brace. Function definitions can appear anywhere in the program where a \fIpattern-action\fR pair is allowed. + .SH USAGE -.sp .LP The \fBindex\fR, \fBlength\fR, \fBmatch\fR, and \fBsubstr\fR functions should not be confused with similar functions in the \fBISO C\fR standard; the @@ -1469,8 +1518,8 @@ enforce the proper evaluation precedence. .LP See \fBlargefile\fR(5) for the description of the behavior of \fBnawk\fR when encountering files greater than or equal to 2 Gbyte (2^31 bytes). + .SH EXAMPLES -.sp .LP The \fBnawk\fR program specified in the command line is most easily specified within single-quotes (for example, \fB\&'\fR\fIprogram\fR\fB\&'\fR) for @@ -1750,7 +1799,6 @@ then the command line prints the file \fBinput\fR, filling in page numbers starting at 5. .SH ENVIRONMENT VARIABLES -.sp .LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect execution: \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and @@ -1769,7 +1817,6 @@ programs (including assignments in command-line arguments). .RE .SH EXIT STATUS -.sp .LP The following exit values are returned: .sp @@ -1796,7 +1843,6 @@ The exit status can be altered within the program by using an \fBexit\fR expression. .SH SEE ALSO -.sp .LP \fBawk\fR(1), \fBed\fR(1), \fBegrep\fR(1), \fBgrep\fR(1), \fBlex\fR(1), \fBsed\fR(1), \fBpopen\fR(3C), \fBprintf\fR(3C), \fBsystem\fR(3C), @@ -1806,8 +1852,8 @@ expression. .LP Aho, A. V., B. W. Kernighan, and P. J. Weinberger, \fIThe AWK Programming Language\fR, Addison-Wesley, 1988. + .SH DIAGNOSTICS -.sp .LP If any \fIfile\fR operand is specified and the named file cannot be accessed, \fBnawk\fR writes a diagnostic message to standard error and terminate without @@ -1817,8 +1863,8 @@ any further action. If the program specified by either the \fIprogram\fR operand or a \fIprogfile\fR operand is not a valid \fBnawk\fR program (as specified in \fBEXTENDED DESCRIPTION\fR), the behavior is undefined. + .SH NOTES -.sp .LP Input white space is not preserved on output if fields are involved. .sp diff --git a/usr/src/man/man1/nm.1 b/usr/src/man/man1/nm.1 index eba513cc07..8e6b82a346 100644 --- a/usr/src/man/man1/nm.1 +++ b/usr/src/man/man1/nm.1 @@ -45,7 +45,7 @@ .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2019, Joyent, Inc. .\" -.TH NM 1 "March 7, 2019" +.TH NM 1 "March 26, 2019" .SH NAME nm \- print name list of an object file .SH SYNOPSIS @@ -87,7 +87,7 @@ Writes the full path name or library name of an object on each line. \fB\fB-C\fR\fR .ad .RS 13n -Demangles C++ symbol names before printing them out. +Demangles symbol names before printing them out. .RE .sp diff --git a/usr/src/man/man1/pfexec.1 b/usr/src/man/man1/pfexec.1 index 66e5e08420..5d5c9048ed 100644 --- a/usr/src/man/man1/pfexec.1 +++ b/usr/src/man/man1/pfexec.1 @@ -58,6 +58,12 @@ For \fBpfexec\fR to function correctly, the \fBpfexecd\fR daemon must be running in the current zone. This is normally managed by the "\fBsvc:/system/pfexec:default\fR" SMF service (see \fBsmf\fR(5)). .SH USAGE +.sp +.LP +For \fBpfexec\fR to function correctly, the \fBpfexecd\fR daemon must be running +in the current zone. This is normally managed by the +"\fBsvc:/system/pfexec:default\fR" SMF service (see \fBsmf\fR(5)). +.SH USAGE .LP \fBpfexec\fR is used to execute commands with predefined process attributes, such as specific user or group \fBID\fRs. diff --git a/usr/src/man/man1/ps.1 b/usr/src/man/man1/ps.1 index 3c838729fd..2ed67d399e 100644 --- a/usr/src/man/man1/ps.1 +++ b/usr/src/man/man1/ps.1 @@ -71,6 +71,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 .LP The following options are supported: @@ -1367,7 +1370,8 @@ Standard See \fBstandards\fR(5). .SH SEE ALSO .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/pvs.1 b/usr/src/man/man1/pvs.1 index 8304261cd3..9375613b36 100644 --- a/usr/src/man/man1/pvs.1 +++ b/usr/src/man/man1/pvs.1 @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PVS 1 "Sep 25, 2008" +.TH PVS 1 "Dec 19, 2018" .SH NAME pvs \- display the internal version information of dynamic objects .SH SYNOPSIS @@ -63,7 +63,7 @@ options are specified, both are enabled. \fB\fB-C\fR\fR .ad .RS 18n -Demangles C++ symbol names. +Demangles symbol names. .RE .sp diff --git a/usr/src/man/man1/sed.1 b/usr/src/man/man1/sed.1 index 126402343c..cd805bd841 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. .\" @@ -44,7 +42,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 @@ -97,11 +96,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 @@ -119,7 +123,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/zlogin.1 b/usr/src/man/man1/zlogin.1 index 7c99eb6cb1..476faab86f 100644 --- a/usr/src/man/man1/zlogin.1 +++ b/usr/src/man/man1/zlogin.1 @@ -13,43 +13,43 @@ .\" Portions Copyright [yyyy] [name of copyright owner] .\" Copyright 2013 DEY Storage Systems, Inc. .\" Copyright (c) 2014 Gary Mills +.\" Copyright (c) 2015, Joyent, Inc. All Rights Reserved .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.TH ZLOGIN 1 "Mar 17, 2015" +.TH ZLOGIN 1 "Mar 30, 2015" .SH NAME zlogin \- enter a zone .SH SYNOPSIS .LP .nf -\fBzlogin\fR [\fB-dCEQ\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR +\fBzlogin\fR [\fB-dCEINQ\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR .fi .LP .nf -\fBzlogin\fR [\fB-nEQS\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR \fIutility\fR +\fBzlogin\fR [\fB-inEQS\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR \fIutility\fR [\fIargument\fR]... .fi .SH DESCRIPTION -.sp .LP The \fBzlogin\fR utility is used by the administrator to enter an operating system zone. Only a superuser operating in the global system zone can use this utility. .sp .LP -\fBzlogin\fR operates in one of three modes: +\fBzlogin\fR operates in one of four modes: .sp .ne 2 .na \fBInteractive Mode\fR .ad .RS 24n -If no utility argument is given and the stdin file descriptor for the -\fBzlogin\fR process is a tty device, \fBzlogin\fR operates in \fBinteractive -mode\fR. In this mode, \fBzlogin\fR creates a new pseudo terminal for use -within the login session. Programs requiring a tty device, for example, -\fBvi\fR(1), work properly in this mode. In this mode, \fBzlogin\fR invokes -\fBlogin\fR(1) to provide a suitable login session. +If no utility argument is given or if the \fB-i\fR option is specified, and the +stdin file descriptor for the \fBzlogin\fR process is a tty device, \fBzlogin\fR +operates in \fBinteractive mode\fR. In this mode, \fBzlogin\fR creates a new +pseudo terminal for use within the login session. Programs requiring a tty +device, for example, \fBvi\fR(1), work properly in this mode. In this mode, +\fBzlogin\fR invokes \fBlogin\fR(1) to provide a suitable login session. .RE .sp @@ -58,11 +58,12 @@ within the login session. Programs requiring a tty device, for example, \fBNon-Interactive Mode\fR .ad .RS 24n -If a utility is specified, \fBzlogin\fR operates in \fBnon-interactive mode\fR. -This mode can be useful for script authors since stdin, stdout, and stderr are -preserved and the exit status of \fIutility\fR is returned upon termination. In -this mode, \fBzlogin\fR invokes \fBsu\fR(1M) in order to set up the user's -environment and to provide a login environment. +If a utility is specified and the \fB-i\fR option is not specified, \fBzlogin\fR +operates in \fBnon-interactive mode\fR. This mode can be useful for script +authors since stdin, stdout, and stderr are preserved and the exit status of +\fIutility\fR is returned upon termination. In this mode, \fBzlogin\fR invokes +\fBsu\fR(1M) in order to set up the user's environment and to provide a login +environment. .sp The specified command is passed as a string and interpreted by a shell running in the non-global zone. See \fBrsh\fR(1). @@ -80,8 +81,17 @@ available once the zone is in the installed state. Connections to the console are persistent across reboot of the zone. .RE -.SH OPTIONS .sp +.ne 2 +.na +\fBStandalone-processs Interactive Mode\fR +.ad +.RS 24n +If the \fB-I\fR option is specified the user is connected to the zone's stdin, +stdout and stderr \fBzfd(7D)\fR devices. +.RE + +.SH OPTIONS .LP The following options are supported: .sp @@ -127,6 +137,25 @@ login by using the escape sequence character. .sp .ne 2 .na +\fB\fB-i\fR\fR +.ad +.RS 15n +Forces interactive mode when a utility argument is specified. +.RE + +.sp +.ne 2 +.na +\fB\fB-I\fR\fR +.ad +.RS 15n +Connects to the zone's \fBzfd(7D)\fR devices. +.RE + +.sp +.sp +.ne 2 +.na \fB\fB-l\fR \fIusername\fR\fR .ad .RS 15n @@ -149,6 +178,17 @@ and the shell which invokes \fBzlogin\fR both read from standard input. .sp .ne 2 .na +\fB-N\fR +.ad +.RS 15n +Nohup. This may only be used with the -I option to avoid sending EOF to the zfd +device when zlogin's stdin receives EOF. It can also be toggled by sending +\fBSIGUSR1\fR to an attached zlogin process. +.RE + +.sp +.ne 2 +.na \fB-Q\fR .ad .RS 15n @@ -172,7 +212,6 @@ other forms of login have become impossible. .RE .SS "Escape Sequences" -.sp .LP Lines that you type that start with the tilde character (\fB~\fR) are "escape sequences". The escape character can be changed using the \fB-e\fR option. @@ -187,12 +226,10 @@ host breaks the connection with no warning to the zone's end. .RE .SH SECURITY -.sp .LP Once a process has been placed in a zone other than the global zone, the process cannot change zone again, nor can any of its children. .SH OPERANDS -.sp .LP The following operands are supported: .sp @@ -223,7 +260,6 @@ Arguments passed to the utility. .RE .SH EXIT STATUS -.sp .LP In interactive and non-interactive modes, the \fBzlogin\fR utility exits when the command or shell in the non-global zone exits. In non-interactive mode, the @@ -268,7 +304,6 @@ mode. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -284,12 +319,10 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp .LP \fBlogin\fR(1), \fBrsh\fR(1), \fBvi\fR(1), \fBsu\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M), \fBattributes\fR(5), \fBzones\fR(5) .SH NOTES -.sp .LP \fBzlogin\fR fails if its open files or any portion of its address space corresponds to an NFS file. This includes the executable itself or the shared |
