path: root/usr/src/man/man1/ps.1

.\"
.\" 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 SunOS 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 and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" 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]
.\"
.\"
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
.\" Copyright (c) 2013 Gary Mills
.\" Copyright (c) 2018, Joyent, Inc.
.\"
.TH PS 1 "August 22, 2018"
.SH NAME
ps \- report process status
.SH SYNOPSIS
.LP
.nf
\fBps\fR [\fB-aAcdefjHlLPWyZ\fR] [\fB-g\fR \fIgrplist\fR] [\fB-h\fR \fIlgrplist\fR]
     [\fB-n\fR \fInamelist\fR] [\fB-o\fR \fIformat\fR]... [\fB-p\fR \fIproclist\fR]
     [\fB-s\fR \fIsidlist\fR] [\fB-t\fR \fIterm\fR] [\fB-u\fR \fIuidlist\fR] [\fB-U\fR \fIuidlist\fR]
     [\fB-G\fR \fIgidlist\fR] [\fB-z\fR \fIzonelist\fR]
.fi

.SH DESCRIPTION
.LP
The \fBps\fR command prints information about active processes. Without
options, \fBps\fR prints information about processes that have the same
effective user \fBID\fR and the same controlling terminal as the invoker. The
output contains only the process \fBID\fR, terminal identifier, cumulative
execution time, and the command name. Otherwise, the information that is
displayed is controlled by the options.
.sp
.LP
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.
.SH OPTIONS
.LP
The following options are supported:
.sp
.ne 2
.na
\fB\fB-a\fR\fR
.ad
.RS 15n
Lists information about \fBa\fRll processes most frequently requested: all
those except session leaders and processes not associated with a terminal.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-A\fR\fR
.ad
.RS 15n
Lists information for all processes. Identical to \fB-e\fR, below.
.RE

.sp
.ne 2
.na
\fB\fB-c\fR\fR
.ad
.RS 15n
Prints information in a format that reflects scheduler properties as described
in \fBpriocntl\fR(1). The \fB-c\fR option affects the output of the \fB-f\fR
and \fB-l\fR options, as described below.
.RE

.sp
.ne 2
.na
\fB\fB-d\fR\fR
.ad
.RS 15n
Lists information about all processes except session leaders.
.RE

.sp
.ne 2
.na
\fB\fB-e\fR\fR
.ad
.RS 15n
Lists information about \fBe\fRvery process now running.
.sp
When the \fB-e\fR option is specified, options \fB-z\fR, \fB-t\fR, \fB-u\fR,
\fB-U\fR, \fB-g\fR, \fB-G\fR, \fB-p\fR, \fB-h\fR, \fB-s\fR and \fB-a\fR
have no effect.
.RE

.sp
.ne 2
.na
\fB\fB-f\fR\fR
.ad
.RS 15n
Generates a \fBf\fRull listing. (See below for significance of columns in a
full listing.)
.RE

.sp
.ne 2
.na
\fB\fB-g\fR \fIgrplist\fR\fR
.ad
.RS 15n
Lists only process data whose group leader's \fBID\fR number(s) appears in
\fIgrplist\fR. (A group leader is a process whose process \fBID\fR number is
identical to its process group \fBID\fR number.)
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-G\fR \fIgidlist\fR\fR
.ad
.RS 15n
Lists information for processes whose real group ID numbers are given in
\fIgidlist\fR. The \fIgidlist\fR must be a single argument in the form of a
blank- or comma-separated list.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-h\fR \fIlgrplist\fR\fR
.ad
.RS 15n
Lists only the processes homed to the specified \fIlgrplist\fR. Nothing is
listed for any invalid group specified in \fIlgrplist\fR.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-H\fR\fR
.ad
.RS 15n
Prints the home lgroup of the process under an additional column header, LGRP.
.RE

.sp
.ne 2
.na
\fB\fB-j\fR\fR
.ad
.RS 15n
Prints session \fBID\fR and process group \fBID\fR.
.RE

.sp
.ne 2
.na
\fB\fB-l\fR\fR
.ad
.RS 15n
Generates a \fBl\fRong listing. (See below.)
.RE

.sp
.ne 2
.na
\fB\fB-L\fR\fR
.ad
.RS 15n
Prints information about each light weight process (\fIlwp\fR) in each selected
process. (See below.)
.RE

.sp
.ne 2
.na
\fB\fB-n\fR \fInamelist\fR\fR
.ad
.RS 15n
Specifies the name of an alternative system \fInamelist\fR file in place of the
default. This option is accepted for compatibility, but is ignored.
.RE

.sp
.ne 2
.na
\fB\fB-o\fR \fIformat\fR\fR
.ad
.RS 15n
Prints information according to the format specification given in \fIformat\fR.
This is fully described in \fBDISPLAY FORMATS\fR. Multiple \fB-o\fR options can
be specified; the format specification is interpreted as the
space-character-separated concatenation of all the \fIformat\fR
option-arguments.
.RE

.sp
.ne 2
.na
\fB\fB-p\fR \fIproclist\fR\fR
.ad
.RS 15n
Lists only process data whose process \fBID\fR numbers are given in
\fIproclist\fR.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-P\fR\fR
.ad
.RS 15n
Prints the number of the processor to which the process or lwp is bound, if
any, under an additional column header, \fBPSR\fR.
.RE

.sp
.ne 2
.na
\fB\fB-s\fR \fIsidlist\fR\fR
.ad
.RS 15n
Lists information on all session leaders whose \fBID\fRs appear in
\fIsidlist\fR.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-t\fR \fIterm\fR\fR
.ad
.RS 15n
Lists only process data associated with \fIterm\fR. Terminal identifiers are
specified as a device file name, and an identifier. For example, \fBterm/a\fR,
or \fBpts/0\fR.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-u\fR \fIuidlist\fR\fR
.ad
.RS 15n
Lists only process data whose effective user \fBID\fR number or login name is
given in \fIuidlist\fR. In the listing, the numerical user \fBID\fR is printed
unless you give the \fB-f\fR option, which prints the login name.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-U\fR \fIuidlist\fR\fR
.ad
.RS 15n
Lists information for processes whose real user \fBID\fR numbers or login names
are given in \fIuidlist\fR. The \fIuidlist\fR must be a single argument in the
form of a blank- or comma-separated list.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-W\fR\fR
.ad
.RS 15n
Truncate long names even when \fBps\fR would normally print them
in full.
A trailing asterisk marks a long name that has been truncated
to fit the column.
.RE

.sp
.ne 2
.na
\fB\fB-y\fR\fR
.ad
.RS 15n
Under a long listing (\fB-l\fR), omits the obsolete \fBF\fR and \fBADDR\fR
columns and includes an \fBRSS\fR column to report the resident set size of the
process. Under the \fB-y\fR option, both \fBRSS\fR and \fBSZ\fR (see below) is
reported in units of kilobytes instead of pages.
.RE

.sp
.ne 2
.na
\fB\fB-z\fR \fIzonelist\fR\fR
.ad
.RS 15n
Lists only processes in the specified zones. Zones can be specified either by
name or ID. This option is only useful when executed in the global zone.
.sp
This option is ignored when the \fB-e\fR option is also specified.
.RE

.sp
.ne 2
.na
\fB\fB-Z\fR\fR
.ad
.RS 15n
Prints the name of the zone with which the process is associated under an
additional column header, \fBZONE\fR. The \fBZONE\fR column width is limited to
8 characters. Use \fBps\fR \fB-eZ\fR for a quick way to see information about
every process now running along with the associated zone name. Use
.sp
.in +2
.nf
ps -eo zone,uid,pid,ppid,time,comm,...
.fi
.in -2
.sp

to see zone names wider than 8 characters.
.RE

.sp
.LP
Many of the options shown are used to select processes to list. If any are
specified, the default list is ignored and \fBps\fR selects the processes
represented by the inclusive OR of all the selection-criteria options.
.SH DISPLAY FORMATS
.LP
Under the \fB-f\fR option, \fBps\fR tries to determine the command name and
arguments given when the process was created by examining the user block.
Failing this, the command name is printed, as it would have appeared without
the \fB-f\fR option, in square brackets.
.sp
.LP
The column headings and the meaning of the columns in a \fBps\fR listing are
given below; the letters \fBf\fR and \fBl\fR indicate the option (f\fBull\fR or
\fBl\fRong, respectively) that causes the corresponding heading to appear;
\fBall\fR means that the heading always appears. \fBNote:\fR These two options
determine only what information is provided for a process; they do not
determine which processes are listed.
.sp
.ne 2
.na
\fB\fBF\fR(l)\fR
.ad
.RS 14n
Flags (hexadecimal and additive) associated with the process. These flags are
available for historical purposes; no meaning should be currently ascribed to
them.
.RE

.sp
.ne 2
.na
\fB\fBS\fR (l)\fR
.ad
.RS 14n
The state of the process:
.sp
.ne 2
.na
\fBO\fR
.ad
.RS 5n
Process is running on a processor.
.RE

.sp
.ne 2
.na
\fBS\fR
.ad
.RS 5n
Sleeping: process is waiting for an event to complete.
.RE

.sp
.ne 2
.na
\fBR\fR
.ad
.RS 5n
Runnable: process is on run queue.
.RE

.sp
.ne 2
.na
\fBT\fR
.ad
.RS 5n
Process is stopped, either by a job control signal or because it is being
traced.
.RE

.sp
.ne 2
.na
\fBW\fR
.ad
.RS 5n
Waiting: process is waiting for CPU usage to drop to the CPU-caps enforced
limits.
.RE

.sp
.ne 2
.na
\fBZ\fR
.ad
.RS 5n
Zombie state: process terminated and parent not waiting.
.RE

.RE

.sp
.ne 2
.na
\fB\fBUID\fR (f,l)\fR
.ad
.RS 14n
The effective user \fBID\fR number of the process (the login name is printed
under the \fB-f\fR option).
A trailing asterisk marks a long name that has been truncated
to fit the column.
.RE

.sp
.ne 2
.na
\fB\fBPID\fR(all)\fR
.ad
.RS 14n
The process \fBID\fR of the process (this datum is necessary in order to kill a
process).
.RE

.sp
.ne 2
.na
\fB\fBPPID\fR(f,l)\fR
.ad
.RS 14n
The process \fBID\fR of the parent process.
.RE

.sp
.ne 2
.na
\fB\fBC\fR(f,l)\fR
.ad
.RS 14n
Processor utilization for scheduling (obsolete). Not printed when the \fB-c\fR
option is used.
.RE

.sp
.ne 2
.na
\fB\fBCLS\fR(f,l)\fR
.ad
.RS 14n
Scheduling class. Printed only when the \fB-c\fR option is used.
.RE

.sp
.ne 2
.na
\fB\fBPRI\fR(l)\fR
.ad
.RS 14n
The priority of the process. Without the \fB-c\fR option, higher numbers mean
lower priority. With the \fB-c\fR option, higher numbers mean higher priority.
.RE

.sp
.ne 2
.na
\fB\fBNI\fR(l)\fR
.ad
.RS 14n
Nice value, used in priority computation. Not printed when the \fB-c\fR option
is used. Only processes in the certain scheduling classes have a nice value.
.RE

.sp
.ne 2
.na
\fB\fBADDR\fR(l)\fR
.ad
.RS 14n
The memory address of the process.
.RE

.sp
.ne 2
.na
\fB\fBSZ\fR(l)\fR
.ad
.RS 14n
The total size of the process in virtual memory, including all mapped files and
devices, in pages. See \fBpagesize\fR(1).
.RE

.sp
.ne 2
.na
\fB\fBWCHAN\fR(l)\fR
.ad
.RS 14n
The address of an event for which the process is sleeping (if blank, the
process is running).
.RE

.sp
.ne 2
.na
\fB\fBSTIME\fR(f)\fR
.ad
.RS 14n
The starting time of the process, given in hours, minutes, and seconds. (A
process begun more than twenty-four hours before the \fBps\fR inquiry is
executed is given in months and days.)
.RE

.sp
.ne 2
.na
\fB\fBTTY\fR(all)\fR
.ad
.RS 14n
The controlling terminal for the process (the message, \fB?\fR, is printed when
there is no controlling terminal).
.RE

.sp
.ne 2
.na
\fB\fBTIME\fR(all)\fR
.ad
.RS 14n
The cumulative execution time for the process.
.RE

.sp
.ne 2
.na
\fB\fBLTIME\fR(all)\fR
.ad
.RS 14n
The execution time for the lwp being reported.
.RE

.sp
.ne 2
.na
\fB\fBCMD\fR(all)\fR
.ad
.RS 14n
The command name (the full command name and its arguments, up to a limit of 80
characters, are printed under the \fB-f\fR option).
.RE

.sp
.LP
The following two additional columns are printed when the \fB-j\fR option is
specified:
.sp
.ne 2
.na
\fB\fBPGID\fR\fR
.ad
.RS 8n
The process ID of the process group leader.
.RE

.sp
.ne 2
.na
\fB\fBSID\fR\fR
.ad
.RS 8n
The process ID of the session leader.
.RE

.sp
.LP
The following two additional columns are printed when the \fB-L\fR option is
specified:
.sp
.ne 2
.na
\fB\fBLWP\fR\fR
.ad
.RS 8n
The lwp ID of the lwp being reported.
.RE

.sp
.ne 2
.na
\fB\fBNLWP\fR\fR
.ad
.RS 8n
The number of lwps in the process (if \fB-f\fR is also specified).
.RE

.sp
.LP
Under the \fB-L\fR option, one line is printed for each lwp in the process and
the time-reporting fields \fBSTIME\fR and \fBLTIME\fR show the values for the
lwp, not the process. A traditional single-threaded process contains only one
lwp.
.sp
.LP
A process that has exited and has a parent, but has not yet been waited for by
the parent, is marked \fB<defunct>\fR\&.
.SS "\fB-o\fR format"
.LP
The \fB-o\fR option allows the output format to be specified under user
control.
.sp
.LP
The format specification must be a list of names presented as a single
argument, blank- or comma-separated. Each variable has a default header. The
default header can be overridden by appending an equals sign and the new text
of the header. The rest of the characters in the argument is used as the header
text. The fields specified are written in the order specified on the command
line, and should be arranged in columns in the output. The field widths are
selected by the system to be at least as wide as the header text (default or
overridden value). If the header text is null, such as \fB-o\fR \fIuser=,\fR
the field width is at least as wide as the default header text.
Long names are not truncated in this mode.
If all header text fields are null, no header line is written.
.sp
.LP
The following names are recognized in the POSIX locale:
.sp
.ne 2
.na
\fB\fBuser\fR\fR
.ad
.RS 10n
The effective user \fBID\fR of the process. This is the textual user \fBID\fR,
if it can be obtained and the field width permits, or a decimal representation
otherwise.
.RE

.sp
.ne 2
.na
\fB\fBruser\fR\fR
.ad
.RS 10n
The real user \fBID\fR of the process. This is the textual user \fBID\fR, if it
can be obtained and the field width permits, or a decimal representation
otherwise.
.RE

.sp
.ne 2
.na
\fB\fBgroup\fR\fR
.ad
.RS 10n
The effective group \fBID\fR of the process. This is the textual group
\fBID,\fR if it can be obtained and the field width permits, or a decimal
representation otherwise.
.RE

.sp
.ne 2
.na
\fB\fBrgroup\fR\fR
.ad
.RS 10n
The real group \fBID\fR of the process. This is the textual group \fBID,\fR if
it can be obtained and the field width permits, or a decimal representation
otherwise.
.RE

.sp
.ne 2
.na
\fB\fBpid\fR\fR
.ad
.RS 10n
The decimal value of the process \fBID\fR.
.RE

.sp
.ne 2
.na
\fB\fBppid\fR\fR
.ad
.RS 10n
The decimal value of the parent process \fBID\fR.
.RE

.sp
.ne 2
.na
\fB\fBpgid\fR\fR
.ad
.RS 10n
The decimal value of the process group \fBID.\fR
.RE

.sp
.ne 2
.na
\fB\fBpcpu\fR\fR
.ad
.RS 10n
The ratio of CPU time used recently to CPU time available in the same period,
expressed as a percentage. The meaning of ``recently'' in this context is
unspecified. The CPU time available is determined in an unspecified manner.
.RE

.sp
.ne 2
.na
\fB\fBvsz\fR\fR
.ad
.RS 10n
The total size of the process in virtual memory, in kilobytes.
.RE

.sp
.ne 2
.na
\fB\fBnice\fR\fR
.ad
.RS 10n
The decimal value of the system scheduling priority of the process. See
\fBnice\fR(1).
.RE

.sp
.ne 2
.na
\fB\fBetime\fR\fR
.ad
.RS 10n
In the POSIX locale, the elapsed time since the process was started, in the
form:
.sp
\fB[[\fR\fIdd\fR-\fB]\fR\fIhh\fR:\fB]\fR\fImm\fR:\fIss\fR
.sp
where
.sp
.ne 2
.na
\fB\fIdd\fR\fR
.ad
.RS 6n
is the number of days
.RE

.sp
.ne 2
.na
\fB\fIhh\fR\fR
.ad
.RS 6n
is the number of hours
.RE

.sp
.ne 2
.na
\fB\fImm\fR\fR
.ad
.RS 6n
is the number of minutes
.RE

.sp
.ne 2
.na
\fB\fIss\fR\fR
.ad
.RS 6n
is the number of seconds
.RE

The \fIdd\fR field is a decimal integer. The \fIhh\fR, \fImm\fR and \fIss\fR
fields is two-digit decimal integers padded on the left with zeros.
.RE

.sp
.ne 2
.na
\fB\fBtime\fR\fR
.ad
.RS 10n
In the POSIX locale, the cumulative CPU time of the process in the form:
.sp
\fB[\fR\fIdd\fR-\fB]\fR\fIhh\fR:\fImm\fR:\fIss\fR
.sp
The \fIdd\fR, \fIhh\fR, \fImm\fR, and \fIss\fR fields is as described in the
\fBetime\fR specifier.
.RE

.sp
.ne 2
.na
\fB\fBtty\fR\fR
.ad
.RS 10n
The name of the controlling terminal of the process (if any) in the same format
used by the \fBwho\fR(1) command.
.RE

.sp
.ne 2
.na
\fB\fBcomm\fR\fR
.ad
.RS 10n
The name of the command being executed (\fBargv[0]\fR value) as a string.
.RE

.sp
.ne 2
.na
\fB\fBargs\fR\fR
.ad
.RS 10n
The command with all its arguments as a string. The implementation might
truncate this value to the field width; it is implementation-dependent whether
any further truncation occurs. It is unspecified whether the string represented
is a version of the argument list as it was passed to the command when it
started, or is a version of the arguments as they might have been modified by
the application. Applications cannot depend on being able to modify their
argument list and having that modification be reflected in the output of
\fBps\fR. The illumos implementation limits the string to 80 bytes; the string
is the version of the argument list as it was passed to the command when it
started.
.RE

.sp
.LP
The following names are recognized in the illumos implementation:
.sp
.ne 2
.na
\fB\fBf\fR\fR
.ad
.RS 11n
Flags (hexadecimal and additive) associated with the process.
.RE

.sp
.ne 2
.na
\fB\fBs\fR\fR
.ad
.RS 11n
The state of the process.
.RE

.sp
.ne 2
.na
\fB\fBc\fR\fR
.ad
.RS 11n
Processor utilization for scheduling (obsolete).
.RE

.sp
.ne 2
.na
\fB\fBuid\fR\fR
.ad
.RS 11n
The effective user \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBruid\fR\fR
.ad
.RS 11n
The real user \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBgid\fR\fR
.ad
.RS 11n
The effective group \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBrgid\fR\fR
.ad
.RS 11n
The real group \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBprojid\fR\fR
.ad
.RS 11n
The project \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBproject\fR\fR
.ad
.RS 11n
The project \fBID\fR of the process as a textual value if that value can be
obtained; otherwise, as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBzoneid\fR\fR
.ad
.RS 11n
The zone \fBID\fR number of the process as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBzone\fR\fR
.ad
.RS 11n
The zone \fBID\fR of the process as a textual value if that value can be
obtained; otherwise, as a decimal integer.
.RE

.sp
.ne 2
.na
\fB\fBsid\fR\fR
.ad
.RS 11n
The process ID of the session leader.
.RE

.sp
.ne 2
.na
\fB\fBtaskid\fR\fR
.ad
.RS 11n
The task \fBID\fR of the process.
.RE

.sp
.ne 2
.na
\fB\fBclass\fR\fR
.ad
.RS 11n
The scheduling class of the process.
.RE

.sp
.ne 2
.na
\fB\fBpri\fR\fR
.ad
.RS 11n
The priority of the process. Higher numbers mean higher priority.
.RE

.sp
.ne 2
.na
\fB\fBopri\fR\fR
.ad
.RS 11n
The obsolete priority of the process. Lower numbers mean higher priority.
.RE

.sp
.ne 2
.na
\fB\fBlwp\fR\fR
.ad
.RS 11n
The decimal value of the lwp \fBID\fR. Requesting this formatting option causes
one line to be printed for each lwp in the process.
.RE

.sp
.ne 2
.na
\fB\fBlwpname\fR\fR
.ad
.RS 11n
The name of the lwp, if set. Requesting this formatting option causes
one line to be printed for each lwp in the process.
.RE

.sp
.ne 2
.na
\fB\fBnlwp\fR\fR
.ad
.RS 11n
The number of lwps in the process.
.RE

.sp
.ne 2
.na
\fB\fBpsr\fR\fR
.ad
.RS 11n
The number of the processor to which the process or lwp is bound.
.RE

.sp
.ne 2
.na
\fB\fBpset\fR\fR
.ad
.RS 11n
The \fBID\fR of the processor set to which the process or lwp is bound.
.RE

.sp
.ne 2
.na
\fB\fBaddr\fR\fR
.ad
.RS 11n
The memory address of the process.
.RE

.sp
.ne 2
.na
\fB\fBosz\fR\fR
.ad
.RS 11n
The total size of the process in virtual memory, in pages.
.RE

.sp
.ne 2
.na
\fB\fBwchan\fR\fR
.ad
.RS 11n
The address of an event for which the process is sleeping (if \(mi, the process
is running).
.RE

.sp
.ne 2
.na
\fB\fBstime\fR\fR
.ad
.RS 11n
The starting time or date of the process, printed with no blanks.
.RE

.sp
.ne 2
.na
\fB\fBrss\fR\fR
.ad
.RS 11n
The resident set size of the process, in kilobytes. The \fBrss\fR value
reported by \fBps\fR is an estimate provided by \fBproc\fR(5) that might
underestimate the actual resident set size. Users who wish to get more accurate
usage information for capacity planning should use \fBpmap\fR(1) \fB-x\fR
instead.
.RE

.sp
.ne 2
.na
\fB\fBpmem\fR\fR
.ad
.RS 11n
The ratio of the process's resident set size to the physical memory on the
machine, expressed as a percentage.
.RE

.sp
.ne 2
.na
\fB\fBfname\fR\fR
.ad
.RS 11n
The first 8 bytes of the base name of the process's executable file.
.RE

.sp
.ne 2
.na
\fB\fBctid\fR\fR
.ad
.RS 11n
The contract ID of the process contract the process is a member of as a decimal
integer.
.RE

.sp
.ne 2
.na
\fB\fBlgrp\fR\fR
.ad
.RS 11n
The home lgroup of the process.
.RE

.sp
.ne 2
.na
\fB\fBdmodel\fR\fR
.ad
.RS 11n
The data model of the process, printed in the same manner as via
\fBpflags\fR(1). The currently supported data models are _ILP32 and _LP64.
.RE

.sp
.LP
Only \fBcomm\fR, \fBlwpname\fR, and \fBargs\fR are allowed to contain blank
characters; all others, including the illumos implementation variables, are not.
.sp
.LP
The following table specifies the default header to be used in the POSIX locale
corresponding to each format specifier.
.sp

.sp
.TS
box;
c c c c
c c c c .
Format	Default	Format	Default
Specifier	Header	Specifier	Header
_
args	COMMAND	ppid	PPID
comm	COMMAND	rgroup	RGROUP
etime	ELAPSED	ruser	RUSER
group	GROUP	time	TIME
nice	NI	tty	TT
pcpu	%CPU	user	USER
pgid	PGID	vsz	VSZ
pid	PID
.TE

.sp
.LP
The following table lists the illumos implementation format specifiers and the
default header used with each.
.sp

.sp
.TS
box;
c c c c
c c c c .
Format	Default	Format	Default
Specifier	Header	Specifier	Header
_
addr	ADDR	projid	PROJID
c	C	project	PROJECT
class	CLS	psr	PSR
f	F	rgid	RGID
fname	COMMAND	rss	RSS
gid	GID	ruid	RUID
lgrp	LGRP	s	S
lwp	LWP	sid	SID
lwpname	LWPNAME	stime	STIME
nlwp	NLWP	taskid	TASKID
opri	PRI	uid	UID
osz	SZ	wchan	WCHAN
pmem	%MEM	zone	ZONE
pri	PRI	zoneid	ZONEID
ctid	CTID
.TE

.SH EXAMPLES
.LP
\fBExample 1 \fRUsing \fBps\fR Command
.sp
.LP
The command:

.sp
.in +2
.nf
example% \fBps -o user,pid,ppid=MOM -o args\fR
.fi
.in -2
.sp

.sp
.LP
writes the following in the POSIX locale:

.sp
.in +2
.nf
 USER  PID   MOM   COMMAND
helene  34    12   ps -o uid,pid,ppid=MOM -o args
.fi
.in -2
.sp

.sp
.LP
The contents of the \fBCOMMAND\fR field need not be the same due to possible
truncation.

.SH ENVIRONMENT VARIABLES
.LP
See \fBenviron\fR(7) for descriptions of the following environment variables
that affect the execution of \fBps\fR: \fBLANG\fR, \fBLC_ALL\fR,
\fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR, and \fBNLSPATH\fR.
.sp
.ne 2
.na
\fB\fBCOLUMNS\fR\fR
.ad
.RS 11n
Override the system-selected horizontal screen size, used to determine the
number of text columns to display.
.RE

.SH EXIT STATUS
.LP
The following exit values are returned:
.sp
.ne 2
.na
\fB\fB0\fR\fR
.ad
.RS 6n
Successful completion.
.RE

.sp
.ne 2
.na
\fB\fB>0\fR\fR
.ad
.RS 6n
An error occurred.
.RE

.SH FILES
.ne 2
.na
\fB\fB/dev/pts/*\fR\fR
.ad
.RS 15n

.RE

.sp
.ne 2
.na
\fB\fB/dev/term/*\fR\fR
.ad
.RS 15n
terminal (``tty'') names searcher files
.RE

.sp
.ne 2
.na
\fB\fB/etc/passwd\fR\fR
.ad
.RS 15n
\fBUID\fR information supplier
.RE

.sp
.ne 2
.na
\fB\fB/proc/*\fR\fR
.ad
.RS 15n
process control files
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
CSI	Enabled (see USAGE)
_
Interface Stability	Committed
_
Standard	See \fBstandards\fR(7).
.TE

.SH SEE ALSO
.LP
.BR kill (1),
.BR lgrpinfo (1),
.BR nice (1),
.BR pagesize (1),
.BR pmap (1),
.BR priocntl (1),
.BR who (1),
.BR proc (5),
.BR ttysrch (5),
.BR attributes (7),
.BR environ (7),
.BR resource_controls (7),
.BR standards (7),
.BR zones (7),
.BR getty (8)
.SH NOTES
.LP
Things can change while \fBps\fR is running. The snapshot it gives is true only
for a split-second, and it might not be accurate by the time you see it. Some
data printed for defunct processes is irrelevant.
.sp
.LP
If no options to select processes are specified, \fBps\fR reports all processes
associated with the controlling terminal. If there is no controlling terminal,
there is no report other than the header.
.sp
.LP
\fBps\fR \fB-ef\fR or \fBps\fR \fB-o\fR \fBstime\fR might not report the actual
start of a tty login session, but rather an earlier time, when a getty was last
respawned on the tty line.
.sp
.LP
\fBps\fR is \fBCSI\fR-enabled except for login names (usernames).