xref: /dragonfly/bin/ps/ps.1 (revision 9b5a9965)
1.\" Copyright (c) 1980, 1990, 1991, 1993, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)ps.1	8.3 (Berkeley) 4/18/94
33.\" $FreeBSD: src/bin/ps/ps.1,v 1.24.2.7 2002/06/20 22:43:33 charnier Exp $
34.\" $DragonFly: src/bin/ps/ps.1,v 1.17 2007/05/25 00:59:06 dillon Exp $
35.\"
36.Dd April 6, 2006
37.Dt PS 1
38.Os
39.Sh NAME
40.Nm ps
41.Nd process status
42.Sh SYNOPSIS
43.Nm
44.Op Fl aCcefhjlmrSTuvwx
45.Op Fl M Ar core
46.Op Fl N Ar system
47.Op Fl O Ar fmt
48.Op Fl o Ar fmt
49.Op Fl p Ar pid
50.Op Fl t Ar tty
51.Op Fl U Ar username
52.Nm
53.Op Fl L
54.Sh DESCRIPTION
55The
56.Nm
57utility
58displays a header line followed by lines containing information about your
59processes that have controlling terminals.
60This information is sorted by controlling terminal, then by process ID.
61.Pp
62The information displayed is selected based on a set of keywords (see the
63.Fl L
64.Fl O
65and
66.Fl o
67options).
68The default output format includes, for each process, the process' ID,
69controlling terminal, CPU time (including both user and system time),
70state, and associated command.
71.Pp
72The process file system (see
73.Xr procfs 5 )
74should be mounted when
75.Nm
76is executed, otherwise not all information will be available.
77.Pp
78The options are as follows:
79.Bl -tag -width indent
80.It Fl a
81Display information about other users' processes as well as your own.
82This can be disabled by setting the
83.Va kern.ps_showallprocs
84sysctl to zero.
85.It Fl c
86Change the ``command'' column output to just contain the executable name,
87rather than the full command line.
88.It Fl C
89Change the way the CPU percentage is calculated by using a ``raw''
90CPU calculation that ignores ``resident'' time (this normally has
91no effect).
92.It Fl e
93Display the environment as well.
94.It Fl f
95Show commandline and environment information about swapped out processes.
96This option is honored only if the uid of the user is 0.
97.It Fl h
98Repeat the information header as often as necessary to guarantee one
99header per page of information.
100.It Fl j
101Print information associated with the following keywords:
102.Cm user , pid , ppid , pgid , sess , jobc , state , tt , time ,
103and
104.Cm command .
105.It Fl L
106List the set of available keywords.
107.It Fl l
108Display information associated with the following keywords:
109.Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , wchan , state ,
110.Cm tt , time ,
111and
112.Cm command .
113.It Fl M
114Extract values associated with the name list from the specified core
115instead of the default
116.Pa /dev/kmem .
117.It Fl m
118Sort by memory usage, instead of by process ID.
119.It Fl N
120Extract the name list from the specified system instead of the default
121.Pa /kernel .
122.It Fl O
123Add the information associated with the space or comma separated list
124of keywords specified, after the process ID,
125in the default information
126display.
127Keywords may be appended with an equals (``='') sign and a string.
128This causes the printed header to use the specified string instead of
129the standard header.
130.It Fl o
131Display information associated with the space or comma separated list
132of keywords specified.
133Keywords may be appended with an equals (``='') sign and a string.
134This causes the printed header to use the specified string instead of
135the standard header.
136.It Fl p
137Display information associated with the specified process ID.
138.It Fl r
139Sort by current CPU usage, instead of by process ID.
140.It Fl S
141Change the way the process time is calculated by summing all exited
142children to their parent process.
143.It Fl T
144Display information about processes attached to the device associated
145with the standard input.
146.It Fl t
147Display information about processes attached to the specified terminal
148device.
149.It Fl U
150Display the processes belonging to the specified
151.Ar username .
152.It Fl u
153Display information associated with the following keywords:
154.Cm user , pid, %cpu , %mem , vsz , rss , tt , state , start , time ,
155and
156.Cm command .
157The
158.Fl u
159option implies the
160.Fl r
161option.
162.It Fl v
163Display information associated with the following keywords:
164.Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
165.Cm %cpu , %mem
166and
167.Cm command .
168The
169.Fl v
170option implies the
171.Fl m
172option.
173.It Fl w
174Use 132 columns to display information, instead of the default which
175is your window size.
176If the
177.Fl w
178option is specified more than once,
179.Nm
180will use as many columns as necessary without regard for your window size.
181.It Fl x
182Display information about processes without controlling terminals.
183.El
184.Pp
185A complete list of the available keywords are listed below.
186Some of these keywords are further specified as follows:
187.Bl -tag -width ".Cm lstart"
188.It Cm %cpu
189The CPU utilization of the process; this is a decaying average over up to
190a minute of previous (real) time.
191Since the time base over which this is computed varies (since processes may
192be very young) it is possible for the sum of all
193.Cm %cpu
194fields to exceed 100%.
195.It Cm %mem
196The percentage of real memory used by this process.
197.It Cm flags
198The flags associated with the process as in
199the include file
200.In sys/proc.h .
201.It Cm lim
202The soft limit on memory used, specified via a call to
203.Xr setrlimit 2 .
204.It Cm lstart
205The exact time the command started, using the ``%c'' format described in
206.Xr strftime 3 .
207.It Cm nice
208The process scheduling increment (see
209.Xr setpriority 2 ) .
210.It Cm rss
211the real memory (resident set) size of the process (in 1024 byte units).
212.It Cm start
213The time the command started.
214If the command started less than 24 hours ago, the start time is
215displayed using the ``%l:ps.1p'' format described in
216.Xr strftime 3 .
217If the command started less than 7 days ago, the start time is
218displayed using the ``%a6.15p'' format.
219Otherwise, the start time is displayed using the ``%e%b%y'' format.
220.It Cm state
221The state is given by a sequence of letters, for example,
222.Dq Li RWNA .
223The first letter indicates the run state of the process:
224.Pp
225.Bl -tag -width indent -compact
226.It Li B
227Marks a blocked kernel thread.
228.It Li D
229Marks a process in disk (or other short term, uninterruptible) wait.
230.It Li I
231Marks a process that is idle (sleeping for longer than about 20 seconds).
232.It Li J
233Marks a process which is in
234.Xr jail 2 .
235The hostname of the prison can be found in
236.Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
237.It Li R
238Marks a runnable process and is followed by the CPU number.
239.It Li S
240Marks a process that is sleeping for less than about 20 seconds.
241.It Li T
242Marks a stopped process.
243.It Li Z
244Marks a dead process (a
245.Dq zombie ) .
246.El
247.Pp
248Additional characters after these, if any, indicate additional state
249information:
250.Pp
251.Bl -tag -width indent -compact
252.It Li +
253The process is in the foreground process group of its control terminal.
254.It Li <
255The process has raised CPU scheduling priority.
256.It Li >
257The process has specified a soft limit on memory requirements and is
258currently exceeding that limit; such a process is (necessarily) not
259swapped.
260.It Li A
261the process has asked for random page replacement
262.Pf ( Dv MADV_RANDOM ,
263from
264.Xr madvise 2 ,
265for example,
266.Xr lisp 1
267in a garbage collect).
268.It Li E
269The process is trying to exit.
270.It Li L
271The process has pages locked in core (for example, for raw
272.Tn I/O ) .
273.It Li M
274On SMP systems indicates a process or thread which is
275.Em not
276holding the MP lock (the Big Giant Lock).
277.It Li N
278The process has reduced CPU scheduling priority (see
279.Xr setpriority 2 ) .
280.It Li S
281The process has asked for FIFO page replacement
282.Pf ( Dv MADV_SEQUENTIAL ,
283from
284.Xr madvise 2 ,
285for example, a large image processing program using virtual memory to
286sequentially address voluminous data).
287.It Li s
288The process is a session leader.
289.It Li V
290The process is suspended during a
291.Xr vfork 2 .
292.It Li W
293The process is swapped out.
294.It Li X
295The process is being traced or debugged.
296.El
297.It Cm tt
298An abbreviation for the pathname of the controlling terminal, if any.
299The abbreviation consists of the three letters following
300.Pa /dev/tty ,
301or, for the console, ``con''.
302This is followed by a ``-'' if the process can no longer reach that
303controlling terminal (i.e., it has been revoked).
304.It Cm wchan
305The event (an address in the system) on which a process waits.
306When printed numerically, the initial part of the address is
307trimmed off and the result is printed in hex, for example, 0x80324000 prints
308as 324000.  Note that blocked threads often only have ascii wchan's.
309.El
310.Pp
311When printing using the
312.Cm command
313keyword, a process that has exited and
314has a parent that has not yet waited for the process (in other words, a zombie)
315is listed as ``<defunct>'', and a process which is blocked while trying
316to exit is listed as ``<exiting>''.
317The
318.Nm
319utility
320makes an educated guess as to the file name and arguments given when the
321process was created by examining memory or the swap area.
322The method is inherently somewhat unreliable and in any event a process
323is entitled to destroy this information, so the names cannot be depended
324on too much.
325The
326.Cm ucomm
327(accounting) keyword can, however, be depended on.
328.Sh KEYWORDS
329The following is a complete list of the available keywords and their
330meanings.
331Several of them have aliases (keywords which are synonyms).
332.Pp
333.Bl -tag -width ".Cm sigignore" -compact
334.It Cm %cpu
335percentage CPU usage (alias
336.Cm pcpu )
337.It Cm %mem
338percentage memory usage (alias
339.Cm pmem )
340.It Cm acflag
341accounting flag (alias
342.Cm acflg )
343.It Cm batch
344batchness of the process (higher numbers mean less interactivity)
345.It Cm command
346command and arguments
347.It Cm cpu
348short-term CPU usage factor (for scheduling)
349.It Cm f
350the process flags, in hexadecimal (alias
351.Cm flags )
352.It Cm inblk
353total blocks read (alias
354.Cm inblock )
355.It Cm jail
356jail ID
357.It Cm jobc
358job control count
359.It Cm ktrace
360tracing flags
361.\" .It Cm ktracep
362.\" tracing vnode
363.It Cm lastcpu
364CPU ID the process was last scheduled on
365.It Cm lim
366memoryuse limit
367.It Cm login
368login name of user who started the process (alias
369.Cm logname )
370.It Cm lstart
371time started
372.It Cm majflt
373total page faults
374.It Cm minflt
375total page reclaims
376.It Cm msgrcv
377total messages received (reads from pipes/sockets)
378.It Cm msgsnd
379total messages sent (writes on pipes/sockets)
380.It Cm nice
381nice value (alias
382.Cm ni )
383.It Cm nivcsw
384total involuntary context switches
385.It Cm nsigs
386total signals taken (alias
387.Cm nsignals )
388.It Cm nswap
389total swaps in/out
390.It Cm nvcsw
391total voluntary context switches
392.It Cm nwchan
393wait channel (as an address)
394.It Cm oublk
395total blocks written (alias
396.Cm oublock )
397.It Cm p_ru
398resource usage (valid only for zombie)
399.It Cm paddr
400swap address
401.It Cm pagein
402pageins (same as
403.Cm majflt )
404.It Cm pgid
405process group number
406.It Cm pid
407process ID
408.It Cm ppid
409parent process ID
410.It Cm pri
411scheduling priority (lower == better)
412.It Cm re
413core residency time (in seconds; 127 = infinity)
414.It Cm rgid
415real group ID
416.\" .It Cm rlink
417.\" reverse link on run queue, or 0
418.It Cm rss
419resident set size
420.It Cm rsz
421resident set size + (text size / text use count) (alias
422.Cm rssize )
423.It Cm rtprio
424realtime priority (101 = not a realtime process)
425.It Cm ruid
426real user ID
427.It Cm ruser
428user name (from ruid)
429.It Cm sess
430session pointer
431.It Cm sig
432pending signals (alias
433.Cm pending )
434.It Cm sigcatch
435caught signals (alias
436.Cm caught )
437.It Cm sigignore
438ignored signals (alias
439.Cm ignored )
440.It Cm sigmask
441blocked signals (alias
442.Cm blocked )
443.It Cm sl
444sleep time (in seconds; 127 = infinity)
445.It Cm start
446time started
447.It Cm state
448symbolic process state (alias
449.Cm stat )
450.It Cm svgid
451saved gid from a setgid executable
452.It Cm svuid
453saved uid from a setuid executable
454.It Cm tdev
455control terminal device number
456.It Cm tdpri
457LWKT thread priority (0-31, 31 highest), and critical section count
458.It Cm time
459accumulated CPU time, user + system (alias
460.Cm cputime )
461.It Cm tpgid
462control terminal process group ID
463.\".It Cm trss
464.\"text resident set size (in Kbytes)
465.It Cm tsess
466control terminal session pointer
467.It Cm tsig
468pending thread signals
469.It Cm tsiz
470text size (in Kbytes)
471.It Cm tt
472control terminal name (two letter abbreviation)
473.It Cm tty
474full name of control terminal
475.It Cm ucomm
476name to be used for accounting
477.It Cm uid
478effective user ID
479.It Cm user
480user name (from uid)
481.It Cm vsz
482virtual size in Kbytes (alias
483.Cm vsize )
484.It Cm wchan
485wait channel (as a symbolic name)
486.It Cm xstat
487exit or stop status (valid only for stopped or zombie process)
488.El
489.Sh FILES
490.Bl -tag -width /var/db/kvm_kernel.db -compact
491.It Pa /dev/kmem
492default kernel memory
493.It Pa /var/run/dev.db
494/dev name database
495.It Pa /var/db/kvm_kernel.db
496system namelist database
497.It Pa /kernel
498default system namelist
499.It Pa /proc
500the mount point of
501.Xr procfs 5
502.El
503.Sh SEE ALSO
504.Xr kill 1 ,
505.Xr w 1 ,
506.Xr kvm 3 ,
507.Xr strftime 3 ,
508.Xr procfs 5 ,
509.Xr pstat 8 ,
510.Xr sysctl 8
511.Sh HISTORY
512The
513.Nm
514command appeared in
515.At v4 .
516.Sh BUGS
517Since
518.Nm
519cannot run faster than the system and is run as any other scheduled
520process, the information it displays can never be exact.
521