]> CyberLeo.Net >> Repos - FreeBSD/stable/8.git/blob - bin/ps/ps.1
MFC r200943: sh: Remove setting variables from dotcmd/exportcmd.
[FreeBSD/stable/8.git] / bin / ps / ps.1
1 .\"-
2 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 4. Neither the name of the University nor the names of its contributors
14 .\"    may be used to endorse or promote products derived from this software
15 .\"    without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .\"     @(#)ps.1        8.3 (Berkeley) 4/18/94
30 .\" $FreeBSD$
31 .\"
32 .Dd March 5, 2010
33 .Dt PS 1
34 .Os
35 .Sh NAME
36 .Nm ps
37 .Nd process status
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl aCcdefHhjlmrSTuvwXxZ
41 .Op Fl O Ar fmt | Fl o Ar fmt
42 .Op Fl G Ar gid Ns Op , Ns Ar gid Ns Ar ...
43 .Op Fl M Ar core
44 .Op Fl N Ar system
45 .Op Fl p Ar pid Ns Op , Ns Ar pid Ns Ar ...
46 .Op Fl t Ar tty Ns Op , Ns Ar tty Ns Ar ...
47 .Op Fl U Ar user Ns Op , Ns Ar user Ns Ar ...
48 .Nm
49 .Op Fl L
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility
54 displays a header line, followed by lines containing information about
55 all of your
56 processes that have controlling terminals.
57 .Pp
58 A different set of processes can be selected for display by using any
59 combination of the
60 .Fl a , G , p , T , t ,
61 and
62 .Fl U
63 options.
64 If more than one of these options are given, then
65 .Nm
66 will select all processes which are matched by at least one of the
67 given options.
68 .Pp
69 For the processes which have been selected for display,
70 .Nm
71 will usually display one line per process.
72 The
73 .Fl H
74 option may result in multiple output lines (one line per thread) for
75 some processes.
76 By default all of these output lines are sorted first by controlling
77 terminal, then by process ID.
78 The
79 .Fl m , r , u ,
80 and
81 .Fl v
82 options will change the sort order.
83 If more than one sorting option was given, then the selected processes
84 will be sorted by the last sorting option which was specified.
85 .Pp
86 For the processes which have been selected for display, the information
87 to display is selected based on a set of keywords (see the
88 .Fl L , O ,
89 and
90 .Fl o
91 options).
92 The default output format includes, for each process, the process' ID,
93 controlling terminal, CPU time (including both user and system time),
94 state, and associated command.
95 .Pp
96 The process file system (see
97 .Xr procfs 5 )
98 should be mounted when
99 .Nm
100 is executed, otherwise not all information will be available.
101 .Pp
102 The options are as follows:
103 .Bl -tag -width indent
104 .It Fl a
105 Display information about other users' processes as well as your own.
106 This will skip any processes which do not have a controlling terminal,
107 unless the
108 .Fl x
109 option is also specified.
110 This can be disabled by setting the
111 .Va security.bsd.see_other_uids
112 sysctl to zero.
113 .It Fl c
114 Change the
115 .Dq command
116 column output to just contain the executable name,
117 rather than the full command line.
118 .It Fl C
119 Change the way the CPU percentage is calculated by using a
120 .Dq raw
121 CPU calculation that ignores
122 .Dq resident
123 time (this normally has
124 no effect).
125 .It Fl d
126 Arrange processes into descendancy order and prefix each command with
127 indentation text showing sibling and parent/child relationships.
128 If either of the
129 .Fl m
130 and
131 .Fl r
132 options are also used, they control how sibling processes are sorted
133 relative to eachother.
134 .It Fl e
135 Display the environment as well.
136 .It Fl f
137 Show commandline and environment information about swapped out processes.
138 This option is honored only if the UID of the user is 0.
139 .It Fl G
140 Display information about processes which are running with the specified
141 real group IDs.
142 .It Fl H
143 Show all of the
144 .Em kernel visible
145 threads associated with each process.
146 Depending on the threading package that
147 is in use, this may show only the process, only the kernel scheduled entities,
148 or all of the process threads.
149 .It Fl h
150 Repeat the information header as often as necessary to guarantee one
151 header per page of information.
152 .It Fl j
153 Print information associated with the following keywords:
154 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
155 and
156 .Cm command .
157 .It Fl L
158 List the set of keywords available for the
159 .Fl O
160 and
161 .Fl o
162 options.
163 .It Fl l
164 Display information associated with the following keywords:
165 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
166 .Cm tt , time ,
167 and
168 .Cm command .
169 .It Fl M
170 Extract values associated with the name list from the specified core
171 instead of the currently running system.
172 .It Fl m
173 Sort by memory usage, instead of the combination of controlling
174 terminal and process ID.
175 .It Fl N
176 Extract the name list from the specified system instead of the default,
177 which is the kernel image the system has booted from.
178 .It Fl O
179 Add the information associated with the space or comma separated list
180 of keywords specified, after the process ID,
181 in the default information
182 display.
183 Keywords may be appended with an equals
184 .Pq Ql =
185 sign and a string.
186 This causes the printed header to use the specified string instead of
187 the standard header.
188 .It Fl o
189 Display information associated with the space or comma separated
190 list of keywords specified.
191 The last keyword in the list may be appended with an equals
192 .Pq Ql =
193 sign and a string that spans the rest of the argument, and can contain
194 space and comma characters.
195 This causes the printed header to use the specified string instead of
196 the standard header.
197 Multiple keywords may also be given in the form of more than one
198 .Fl o
199 option.
200 So the header texts for multiple keywords can be changed.
201 If all keywords have empty header texts, no header line is written.
202 .It Fl p
203 Display information about processes which match the specified process IDs.
204 .It Fl r
205 Sort by current CPU usage, instead of the combination of controlling
206 terminal and process ID.
207 .It Fl S
208 Change the way the process time is calculated by summing all exited
209 children to their parent process.
210 .It Fl T
211 Display information about processes attached to the device associated
212 with the standard input.
213 .It Fl t
214 Display information about processes attached to the specified terminal
215 devices.
216 .It Fl U
217 Display the processes belonging to the specified usernames.
218 .It Fl u
219 Display information associated with the following keywords:
220 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
221 and
222 .Cm command .
223 The
224 .Fl u
225 option implies the
226 .Fl r
227 option.
228 .It Fl v
229 Display information associated with the following keywords:
230 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
231 .Cm %cpu , %mem ,
232 and
233 .Cm command .
234 The
235 .Fl v
236 option implies the
237 .Fl m
238 option.
239 .It Fl w
240 Use 132 columns to display information, instead of the default which
241 is your window size.
242 If the
243 .Fl w
244 option is specified more than once,
245 .Nm
246 will use as many columns as necessary without regard for your window size.
247 .It Fl X
248 When displaying processes matched by other options, skip any processes
249 which do not have a controlling terminal.
250 .It Fl x
251 When displaying processes matched by other options, include processes
252 which do not have a controlling terminal.
253 This is the opposite of the
254 .Fl X
255 option.
256 If both
257 .Fl X
258 and
259 .Fl x
260 are specified in the same command, then
261 .Nm
262 will use the one which was specified last.
263 .It Fl Z
264 Add
265 .Xr mac 4
266 label to the list of keywords for which
267 .Nm
268 will display information.
269 .El
270 .Pp
271 A complete list of the available keywords are listed below.
272 Some of these keywords are further specified as follows:
273 .Bl -tag -width lockname
274 .It Cm %cpu
275 The CPU utilization of the process; this is a decaying average over up to
276 a minute of previous (real) time.
277 Since the time base over which this is computed varies (since processes may
278 be very young) it is possible for the sum of all
279 .Cm %cpu
280 fields to exceed 100%.
281 .It Cm %mem
282 The percentage of real memory used by this process.
283 .It Cm flags
284 The flags associated with the process as in
285 the include file
286 .In sys/proc.h :
287 .Bl -column P_SINGLE_BOUNDARY 0x40000000
288 .It Dv "P_ADVLOCK" Ta No "0x00001       Process may hold a POSIX advisory lock"
289 .It Dv "P_CONTROLT" Ta No "0x00002      Has a controlling terminal"
290 .It Dv "P_KTHREAD" Ta No "0x00004       Kernel thread"
291 .It Dv "P_PPWAIT" Ta No "0x00010        Parent is waiting for child to exec/exit"
292 .It Dv "P_PROFIL" Ta No "0x00020        Has started profiling"
293 .It Dv "P_STOPPROF" Ta No "0x00040      Has thread in requesting to stop prof"
294 .It Dv "P_SUGID" Ta No "0x00100         Had set id privileges since last exec"
295 .It Dv "P_SYSTEM" Ta No "0x00200        System proc: no sigs, stats or swapping"
296 .It Dv "P_SINGLE_EXIT" Ta No "0x00400   Threads suspending should exit, not wait"
297 .It Dv "P_TRACED" Ta No "0x00800        Debugged process being traced"
298 .It Dv "P_WAITED" Ta No "0x01000        Someone is waiting for us"
299 .It Dv "P_WEXIT" Ta No "0x02000         Working on exiting"
300 .It Dv "P_EXEC" Ta No "0x04000          Process called exec"
301 .It Dv "P_CONTINUED" Ta No "0x10000     Proc has continued from a stopped state"
302 .It Dv "P_STOPPED_SIG" Ta No "0x20000   Stopped due to SIGSTOP/SIGTSTP"
303 .It Dv "P_STOPPED_TRACE" Ta No "0x40000 Stopped because of tracing"
304 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000        Only one thread can continue"
305 .It Dv "P_PROTECTED" Ta No "0x100000    Do not kill on memory overcommit"
306 .It Dv "P_SIGEVENT" Ta No "0x200000     Process pending signals changed"
307 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000      Threads should suspend at user boundary"
308 .It Dv "P_HWPMC" Ta No "0x800000        Process is using HWPMCs"
309 .It Dv "P_JAILED" Ta No "0x1000000      Process is in jail"
310 .It Dv "P_INEXEC" Ta No "0x4000000      Process is in execve()"
311 .It Dv "P_STATCHILD" Ta No "0x8000000   Child process stopped or exited"
312 .It Dv "P_INMEM" Ta No "0x10000000      Loaded into memory"
313 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000        Process is being swapped out"
314 .It Dv "P_SWAPPINGIN" Ta No "0x40000000 Process is being swapped in"
315 .El
316 .It Cm label
317 The MAC label of the process.
318 .It Cm lim
319 The soft limit on memory used, specified via a call to
320 .Xr setrlimit 2 .
321 .It Cm lstart
322 The exact time the command started, using the
323 .Ql %c
324 format described in
325 .Xr strftime 3 .
326 .It Cm lockname
327 The name of the lock that the process is currently blocked on.
328 If the name is invalid or unknown, then
329 .Dq ???\&
330 is displayed.
331 .It Cm logname
332 The login name associated with the session the process is in (see
333 .Xr getlogin 2 ) .
334 .It Cm mwchan
335 The event name if the process is blocked normally, or the lock name if
336 the process is blocked on a lock.
337 See the wchan and lockname keywords
338 for details.
339 .It Cm nice
340 The process scheduling increment (see
341 .Xr setpriority 2 ) .
342 .It Cm rss
343 the real memory (resident set) size of the process (in 1024 byte units).
344 .It Cm start
345 The time the command started.
346 If the command started less than 24 hours ago, the start time is
347 displayed using the
348 .Dq Li %l:ps.1p
349 format described in
350 .Xr strftime 3 .
351 If the command started less than 7 days ago, the start time is
352 displayed using the
353 .Dq Li %a6.15p
354 format.
355 Otherwise, the start time is displayed using the
356 .Dq Li %e%b%y
357 format.
358 .It Cm state
359 The state is given by a sequence of characters, for example,
360 .Dq Li RWNA .
361 The first character indicates the run state of the process:
362 .Pp
363 .Bl -tag -width indent -compact
364 .It Li D
365 Marks a process in disk (or other short term, uninterruptible) wait.
366 .It Li I
367 Marks a process that is idle (sleeping for longer than about 20 seconds).
368 .It Li L
369 Marks a process that is waiting to acquire a lock.
370 .It Li R
371 Marks a runnable process.
372 .It Li S
373 Marks a process that is sleeping for less than about 20 seconds.
374 .It Li T
375 Marks a stopped process.
376 .It Li W
377 Marks an idle interrupt thread.
378 .It Li Z
379 Marks a dead process (a
380 .Dq zombie ) .
381 .El
382 .Pp
383 Additional characters after these, if any, indicate additional state
384 information:
385 .Pp
386 .Bl -tag -width indent -compact
387 .It Li +
388 The process is in the foreground process group of its control terminal.
389 .It Li <
390 The process has raised CPU scheduling priority.
391 .It Li E
392 The process is trying to exit.
393 .It Li J
394 Marks a process which is in
395 .Xr jail 2 .
396 The hostname of the prison can be found in
397 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
398 .It Li L
399 The process has pages locked in core (for example, for raw
400 .Tn I/O ) .
401 .It Li N
402 The process has reduced CPU scheduling priority (see
403 .Xr setpriority 2 ) .
404 .It Li s
405 The process is a session leader.
406 .It Li V
407 The process is suspended during a
408 .Xr vfork 2 .
409 .It Li W
410 The process is swapped out.
411 .It Li X
412 The process is being traced or debugged.
413 .El
414 .It Cm tt
415 An abbreviation for the pathname of the controlling terminal, if any.
416 The abbreviation consists of the three letters following
417 .Pa /dev/tty ,
418 or, for the console,
419 .Dq Li con .
420 This is followed by a
421 .Ql -
422 if the process can no longer reach that
423 controlling terminal (i.e., it has been revoked).
424 .It Cm wchan
425 The event (an address in the system) on which a process waits.
426 When printed numerically, the initial part of the address is
427 trimmed off and the result is printed in hex, for example, 0x80324000 prints
428 as 324000.
429 .El
430 .Pp
431 When printing using the command keyword, a process that has exited and
432 has a parent that has not yet waited for the process (in other words, a zombie)
433 is listed as
434 .Dq Li <defunct> ,
435 and a process which is blocked while trying
436 to exit is listed as
437 .Dq Li <exiting> .
438 If the arguments cannot be located (usually because it has not been set, as is
439 the case of system processes and/or kernel threads) the command name is printed
440 within square brackets.
441 The
442 .Nm
443 utility first tries to obtain the arguments cached by the kernel (if they were
444 shorter than the value of the
445 .Va kern.ps_arg_cache_limit
446 sysctl).
447 The process can change the arguments shown with
448 .Xr setproctitle 3 .
449 Otherwise,
450 .Nm
451 makes an educated guess as to the file name and arguments given when the
452 process was created by examining memory or the swap area.
453 The method is inherently somewhat unreliable and in any event a process
454 is entitled to destroy this information.
455 The ucomm (accounting) keyword can, however, be depended on.
456 If the arguments are unavailable or do not agree with the ucomm keyword,
457 the value for the ucomm keyword is appended to the arguments in parentheses.
458 .Sh KEYWORDS
459 The following is a complete list of the available keywords and their
460 meanings.
461 Several of them have aliases (keywords which are synonyms).
462 .Pp
463 .Bl -tag -width ".Cm sigignore" -compact
464 .It Cm %cpu
465 percentage CPU usage (alias
466 .Cm pcpu )
467 .It Cm %mem
468 percentage memory usage (alias
469 .Cm pmem )
470 .It Cm acflag
471 accounting flag (alias
472 .Cm acflg )
473 .It Cm args
474 command and arguments
475 .It Cm comm
476 command
477 .It Cm command
478 command and arguments
479 .It Cm cpu
480 short-term CPU usage factor (for scheduling)
481 .It Cm etime
482 elapsed running time
483 .It Cm flags
484 the process flags, in hexadecimal (alias
485 .Cm f )
486 .It Cm inblk
487 total blocks read (alias
488 .Cm inblock )
489 .It Cm jid
490 jail ID
491 .It Cm jobc
492 job control count
493 .It Cm ktrace
494 tracing flags
495 .It Cm label
496 MAC label
497 .It Cm lim
498 memoryuse limit
499 .It Cm lockname
500 lock currently blocked on (as a symbolic name)
501 .It Cm logname
502 login name of user who started the session
503 .It Cm lstart
504 time started
505 .It Cm majflt
506 total page faults
507 .It Cm minflt
508 total page reclaims
509 .It Cm msgrcv
510 total messages received (reads from pipes/sockets)
511 .It Cm msgsnd
512 total messages sent (writes on pipes/sockets)
513 .It Cm mwchan
514 wait channel or lock currently blocked on
515 .It Cm nice
516 nice value (alias
517 .Cm ni )
518 .It Cm nivcsw
519 total involuntary context switches
520 .It Cm nsigs
521 total signals taken (alias
522 .Cm nsignals )
523 .It Cm nswap
524 total swaps in/out
525 .It Cm nvcsw
526 total voluntary context switches
527 .It Cm nwchan
528 wait channel (as an address)
529 .It Cm oublk
530 total blocks written (alias
531 .Cm oublock )
532 .It Cm paddr
533 swap address
534 .It Cm pagein
535 pageins (same as majflt)
536 .It Cm pgid
537 process group number
538 .It Cm pid
539 process ID
540 .It Cm poip
541 pageouts in progress
542 .It Cm ppid
543 parent process ID
544 .It Cm pri
545 scheduling priority
546 .It Cm re
547 core residency time (in seconds; 127 = infinity)
548 .It Cm rgid
549 real group ID
550 .It Cm rgroup
551 group name (from rgid)
552 .It Cm rlink
553 reverse link on run queue, or 0
554 .It Cm rss
555 resident set size
556 .It Cm rtprio
557 realtime priority (101 = not a realtime process)
558 .It Cm ruid
559 real user ID
560 .It Cm ruser
561 user name (from ruid)
562 .It Cm sid
563 session ID
564 .It Cm sig
565 pending signals (alias
566 .Cm pending )
567 .It Cm sigcatch
568 caught signals (alias
569 .Cm caught )
570 .It Cm sigignore
571 ignored signals (alias
572 .Cm ignored )
573 .It Cm sigmask
574 blocked signals (alias
575 .Cm blocked )
576 .It Cm sl
577 sleep time (in seconds; 127 = infinity)
578 .It Cm start
579 time started
580 .It Cm state
581 symbolic process state (alias
582 .Cm stat )
583 .It Cm svgid
584 saved gid from a setgid executable
585 .It Cm svuid
586 saved UID from a setuid executable
587 .It Cm tdev
588 control terminal device number
589 .It Cm time
590 accumulated CPU time, user + system (alias
591 .Cm cputime )
592 .It Cm tpgid
593 control terminal process group ID
594 .\".It Cm trss
595 .\"text resident set size (in Kbytes)
596 .It Cm tsid
597 control terminal session ID
598 .It Cm tsiz
599 text size (in Kbytes)
600 .It Cm tt
601 control terminal name (two letter abbreviation)
602 .It Cm tty
603 full name of control terminal
604 .It Cm uprocp
605 process pointer
606 .It Cm ucomm
607 name to be used for accounting
608 .It Cm uid
609 effective user ID
610 .It Cm upr
611 scheduling priority on return from system call (alias
612 .Cm usrpri )
613 .It Cm user
614 user name (from UID)
615 .It Cm vsz
616 virtual size in Kbytes (alias
617 .Cm vsize )
618 .It Cm wchan
619 wait channel (as a symbolic name)
620 .It Cm xstat
621 exit or stop status (valid only for stopped or zombie process)
622 .El
623 .Pp
624 Note that the
625 .Cm pending
626 column displays bitmask of signals pending in the process queue when
627 .Fl H
628 option is not specified, otherwise the per-thread queue of pending signals
629 is shown.
630 .Sh ENVIRONMENT
631 The following environment variables affect the execution of
632 .Nm :
633 .Bl -tag -width ".Ev COLUMNS"
634 .It Ev COLUMNS
635 If set, specifies the user's preferred output width in column positions.
636 By default,
637 .Nm
638 attempts to automatically determine the terminal width.
639 .El
640 .Sh FILES
641 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
642 .It Pa /boot/kernel/kernel
643 default system namelist
644 .It Pa /proc
645 the mount point of
646 .Xr procfs 5
647 .El
648 .Sh SEE ALSO
649 .Xr kill 1 ,
650 .Xr pgrep 1 ,
651 .Xr pkill 1 ,
652 .Xr procstat 1 ,
653 .Xr w 1 ,
654 .Xr kvm 3 ,
655 .Xr strftime 3 ,
656 .Xr mac 4 ,
657 .Xr procfs 5 ,
658 .Xr pstat 8 ,
659 .Xr sysctl 8 ,
660 .Xr mutex 9
661 .Sh STANDARDS
662 For historical reasons, the
663 .Nm
664 utility under
665 .Fx
666 supports a different set of options from what is described by
667 .St -p1003.2 ,
668 and what is supported on
669 .No non- Ns Bx
670 operating systems.
671 .Sh HISTORY
672 The
673 .Nm
674 command appeared in
675 .At v4 .
676 .Sh BUGS
677 Since
678 .Nm
679 cannot run faster than the system and is run as any other scheduled
680 process, the information it displays can never be exact.
681 .Pp
682 The
683 .Nm
684 utility does not correctly display argument lists containing multibyte
685 characters.