delete "rusage" alias; delete -s option; change "trs" to "trss"

[unix-history] / usr / src / bin / ps / ps.1

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)ps.1	6.13 (Berkeley) %G%
.\"
.TH PS 1 "March 10, 1988"
.UC 4
.SH NAME
ps \- process status
.SH SYNOPSIS
.nf
.ft B
ps [ \-aChjlmrSTuvwx ] [ \-O|o fmt ] [ \-p pid ] [ \-t tty \] [ system ] [ core ] [ swap ]
ps [ \-L ]
.ft R
.fi
.SH DESCRIPTION
.I Ps
displays a header line followed by lines containing information about your
processes that have controlling terminals.
This information is sorted by process ID.
.PP
The information displayed is selected based on a set of keywords (see the
\-L, \-O and \-o options).
The default output format includes, for each process, the process' ID,
controlling terminal, cpu time (including both user and system time),
state, and associated command.
.PP
The options are as follows:
.TP
\-a
Display information about other users' processes as well as your own.
.TP
\-C
Change the way the cpu percentage is calculated by using a ``raw''
cpu calculation that ignores ``resident'' time (this normally has
no effect).
.TP
\-h
Repeat the information header as often as necessary to guarantee one
header per page of information.
.TP
\-j
Print information associated with the following keywords:
user, pid, ppid, pgid, sess, jobc, state, tt, time and command.
.TP
\-L
List the set of available keywords.
If the \-L option is specified more than once,
.I ps
will display a long listing of the keywords and their meanings.
.TP
\-l
Display information associated with the following keywords:
uid, pid, ppid, cpu, pri, nice, vsz, rss, wchan, state, tt, time
and command.
.TP
\-m
Sort by memory usage, instead of by process ID.
.TP
\-O
Add the information associated with the space or comma separated list
of keywords specifed, after the process ID, in the default information
display.
Keywords may be appended with an equals (``='') sign and a string.
This causes the printed header to use the specified string instead of
the standard header.
.TP
\-o
Display information associated with the space or comma separated list
of keywords specifed.
Keywords may be appended with an equals (``='') sign and a string.
This causes the printed header to use the specified string instead of
the standard header.
.TP
\-p
Display information associated with the specified process ID.
.TP
\-r
Sort by current cpu usage, instead of by process ID.
.TP
\-S
Change the way the process time is calculated by summing all exited
children to their parent process.
.TP
\-T
Display information about processes attached to the device associated
with the standard input.
.TP
\-t
Display information about processes attached to the specified terminal
device.
.TP
\-u
Display information associated with the following keywords:
user, pid, %cpu, %mem, vsz, rss, tt, state, start, time and command.
The \-u option implies the \-r option.
.TP
\-v
Display information associated with the following keywords:
pid, state, time, sl, re, pagein, vsz, rss, lim, tsiz, trss,
%cpu, %mem and command.
The \-v option implies the \-m option.
.TP
\-w
Use 132 columns to display information, instead of the default which
is your window size.
If the \-w option is specified more than once,
.I ps
will use as many columns as necessary without regard for your window size.
.TP
\-x
Display information about processes without controlling terminals.
.PP
Three additional arguments may be specified.
The first additional argument is the file to read for the system namelist
(instead of the default ``/vmunix'').
The second additional argument is a core file to use for kernel memory
(instead of the default ``/dev/mem'').
The third addition argument is a file to be used for swap
(instead of the default ``/dev/swap'').
.PP
A complete list of the available keywords are listed below.
Some of these keywords are further specifed as follows:
.TP
%cpu
The cpu utilization of the process; this is a decaying average over up to
a minute of previous (real) time.
Since the time base over which this is computed varies (since processes may
be very young) it is possible for the sum of all %CPU fields to exceed 100%.
.TP
%mem
The percentage of real memory used by this process.
.TP
flags
The flags (in hexadecimal) associated with the process as in
the include file ``sys/proc.h'':
.sp
.nf
.RS
.ta \w'SNOCLDSTOP  'u +\w'0040000  'u
SLOAD	0000001	in core
SSYS	0000002	swapper or pager process
SLOCK	0000004	process being swapped out
SSWAP	0000008	save area flag
STRC	0000010	process is being traced
SWTED	0000020	another tracing flag
SSINTR	0000040	sleep is interruptible
SPAGE	0000080	process in page wait state
SKEEP	0000100	another flag to prevent swap out
SOMASK	0000200	restore old mask after taking signal
SWEXIT	0000400	working on exiting
SPHYSIO	0000800	doing physical i/o
SVFORK	0001000	process resulted from vfork()
SVFDONE	0002000	another vfork flag
SNOVM	0004000	no vm, parent in a vfork()
SPAGV	0008000	init data space on demand, from vnode
SSEQL	0010000	user warned of sequential vm behavior
SUANOM	0020000	user warned of random vm behavior
STIMO	0040000	timing out during sleep
SNOCLDSTOP	0080000	no SIGCHLD when children stop
SCTTY	0100000	has a controlling terminal
SOWEUPC	0200000	owe process an addupc() call at next ast
SSEL	0400000	selecting; wakeup/waiting danger
SEXEC	0800000	process called exec
SHPUX	1000000	HP-UX process (HPUXCOMPAT)
SULOCK	2000000	locked in core after swap error
SPTECHG	4000000	pte's for process have changed
.fi
.RE
.TP
lim
The soft limit on memory used, specified via a call to
.IR setrlimit (2).
.TP
lstart
The exact time the command started, using the ``%C'' format described in
.IR strftime (3).
.TP
nice
The process scheduling increment (see
.IR setpriority (2)).
.TP
rss
the real memory (resident set) size of the process (in 1024 byte units).
.TP
start
The time the command started.
If the command started less than 24 hours ago, the start time is
displayed using the ``%l:ps.1p'' format described in 
.IR strftime (3).
If the command started less than 7 days ago, the start time is
displayed using the ``%a6.13p'' format.
Otherwise, the start time is displayed using the ``%e%b%y'' format.
.TP
state
The state is given by a sequence of letters, e.g., ``RWNA''.
The first letter indicates the run state of the process:
.sp
.PD 0
.RS
.IP D
Marks a process in disk (or other short term, uninterruptable) wait.
.IP I
Marks a process that is idle (sleeping for longer than about 20 seconds).
.IP P
Marks a process in page wait.
.IP R
Marks a runnable process.
.IP S
Marks a process that is sleeping for less than about 20 seconds.
.IP T
Marks a stopped process.
.IP Z
Marks a dead process (a ``zombie'').
.sp
.PP
Additional characters after these, if any, indicate additional state
information:
.sp
.IP +
The process is in the foreground process group of its control terminal.
.IP <
The process has raised CPU scheduling priority.
.IP >
The process has specified a soft limit on memory requirements and is
currently exceeding that limit; such a process is (necessarily) not
swapped.
.IP A
the process has asked for random page replacement (VA_ANOM, from
.IR vadvise (2),
e.g.,
.IR lisp (1)
in a garbage collect).
.IP E
The process is trying to exit.
.IP L
The process has pages locked in core (e.g., for raw I/O).
.IP N
The process has reduced CPU scheduling priority (see
.IR setpriority (2)).
.IP S
The process has asked for FIFO page replacement (VA_SEQL, from
.IR vadvise (2),
e.g., a large image processing program using virtual memory to
sequentially address voluminous data).
.IP s
The process is a session leader.
.IP V
The process is suspended during a vfork.
.IP W
The process is swapped out.
.IP X
The process is being traced or debugged.
.RE
.PD
.TP
tt
An abbreviation for the pathname of the controlling terminal, if any.
The abbreviation consists of the two letters following ``/dev/tty'',
or, for the console, ``co''.
This is followed by a ``-'' if the process can no longer reach that
controlling terminal (i.e., it has been revoked).
.TP
wchan
The event on which the process is waiting (an address in the system).
When printed numerically, the initial part of the address is
trimmed off and the result is printed in hex, e.g., 0x80324000 prints
as 324000.
.PP
When printing using the command keyword, a process that has exited and
has a parent that has not yet waited for the process (i.e., a zombie)
is listed as ``<defunct>'', and a process which is blocked while trying
to exit is listed as ``<exiting>''.
.B Ps
makes an educated guess as to the file name and arguments given when the
process was created by examining memory or the swap area.
The method is inherently somewhat unreliable and in any event a process
is entitled to destroy this information, so the names cannot be depended
on too much.
The ucomm (accounting) keyword can, however, be depended on.
.SH "KEYWORDS"
The following is a complete list of the available keywords and their
meanings.
Several of them have aliases, i.e. keywords that are synonyms.
.sp
.PD 0
.IP %cpu 10
percentage cpu usage (alias pcpu)
.IP %mem 10
percentage memory usage (alias pmem)
.IP acflag 10
accounting flag (alias acflg)
.IP command 10
command and arguments
.IP cpu 10
short-term cpu usage factor (for scheduling)
.IP flags 10
the process flags, in hexadecimal (alias f)
.IP inblk 10
total blocks read (alias inblock)
.IP jobc 10
job control count
.IP ktrace 10
tracing flags
.IP ktracep 10
tracing vnode
.IP lim 10
memoryuse limit
.IP logname 10
login name of user who started the process
.IP lstart 10
time started
.IP majflt 10
total page faults
.IP minflt 10
total page reclaims
.IP msgrcv 10
total messages received (reads from pipes/sockets)
.IP msgsnd 10
total messages sent (writes on pipes/sockets)
.IP nice 10
nice value (alias ni)
.IP nivcsw 10
total involuntary context switches
.IP nsigs 10
total signals taken (alias nsignals)
.IP nswap 10
total swaps in/out
.IP nvcsw 10
total voluntary context switches
.IP nwchan 10
wait channel (as an address)
.IP oublk 10
total blocks written (alias oublock)
.IP p_ru 10
resource usage (valid only for zombie)
.IP paddr 10
swap address
.IP pagein 10
pageins (same as majflt)
.IP pgid 10
process group number
.IP pid 10
process ID
.IP poip 10
pageouts in progress
.IP ppid 10
parent process ID
.IP pri 10
scheduling priority
.IP re 10
core residency time (in seconds; 127 = infinity)
.IP rgid 10
real group ID
.IP rlink 10
reverse link on run queue, or 0
.IP rss 10
resident set size
.IP rsz 10
resident set size + (text size / text use count) (alias rssize)
.IP ruid 10
real user ID
.IP ruser 10
user name (from ruid)
.IP sess 10
session pointer
.IP sig 10
pending signals (alias pending)
.IP sigcatch 10
caught signals (alias caught)
.IP sigignore 10
ignored signals (alias ignored)
.IP sigmask 10
blocked signals (alias blocked)
.IP sl 10
sleep time (in seconds; 127 = infinity)
.IP start 10
time started
.IP state 10
symbolic process state (alias stat)
.IP svgid 10
saved gid from a setgid executable
.IP svuid 10
saved uid from a setuid executable
.IP tdev 10
control terminal device number
.IP time 10
accumulated cpu time, user + system (alias cputime)
.IP tpgid 10
control terminal process group ID
.IP trss 10
text resident set size (in Kbytes)
.IP tsess 10
control terminal session pointer
.IP tsiz 10
text size (in Kbytes)
.IP tt 10
control terminal name (two letter abbreviation)
.IP tty 10
full name of control terminal
.IP uprocp 10
process pointer
.IP ucomm 10
name to be used for accounting
.IP uid 10
effective user ID
.IP upr 10
scheduling priority on return from system call (alias usrpri)
.IP user 10
user name (from uid)
.IP vsz 10
virtual size in Kbytes (alias vsize)
.IP wchan 10
wait channel (as a symbolic name)
.IP xstat 10
exit or stop status (valid only for stopped or zombie process)
.PD
.SH FILES
.ta \w'/var/run/kvm_vmunix.db  'u
/dev	special files and device names
.br
/dev/drum	default swap device
.br
/dev/kmem	default kernel memory
.br
/var/run/dev.db	/dev name database
.br
/var/run/kvm_vmunix.db	system namelist database
.br
/vmunix	default system namelist
.SH "SEE ALSO"
kill(1), w(1), kvm(3), strftime(3), pstat(8)
.SH BUGS
Things can change while
.I ps
is running; the picture it gives is only a fairly close
approximation to reality.