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 July 9, 2009
  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_STOPPED_SINGLE 0x4000000
 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_NOLOAD" Ta No "0x00008        Ignore during load avg calculations"
 292 .It Dv "P_PPWAIT" Ta No "0x00010        Parent is waiting for child to exec/exit"
 293 .It Dv "P_PROFIL" Ta No "0x00020        Has started profiling"
 294 .It Dv "P_STOPPROF" Ta No "0x00040      Has thread in requesting to stop prof"
 295 .It Dv "P_SUGID" Ta No "0x00100         Had set id privileges since last exec"
 296 .It Dv "P_SYSTEM" Ta No "0x00200        System proc: no sigs, stats or swapping"
 297 .It Dv "P_SINGLE_EXIT" Ta No "0x00400   Threads suspending should exit, not wait"
 298 .It Dv "P_TRACED" Ta No "0x00800        Debugged process being traced"
 299 .It Dv "P_WAITED" Ta No "0x01000        Someone is waiting for us"
 300 .It Dv "P_WEXIT" Ta No "0x02000         Working on exiting"
 301 .It Dv "P_EXEC" Ta No "0x04000          Process called exec"
 302 .It Dv "P_CONTINUED" Ta No "0x10000     Proc has continued from a stopped state"
 303 .It Dv "P_STOPPED_SIG" Ta No "0x20000   Stopped due to SIGSTOP/SIGTSTP"
 304 .It Dv "P_STOPPED_TRACE" Ta No "0x40000 Stopped because of tracing"
 305 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000        Only one thread can continue"
 306 .It Dv "P_PROTECTED" Ta No "0x100000    Do not kill on memory overcommit"
 307 .It Dv "P_SIGEVENT" Ta No "0x200000     Process pending signals changed"
 308 .It Dv "P_JAILED" Ta No "0x1000000      Process is in jail"
 309 .It Dv "P_INEXEC" Ta No "0x4000000      Process is in execve()"
 310 .El
 311 .It Cm label
 312 The MAC label of the process.
 313 .It Cm lim
 314 The soft limit on memory used, specified via a call to
 315 .Xr setrlimit 2 .
 316 .It Cm lstart
 317 The exact time the command started, using the
 318 .Ql %c
 319 format described in
 320 .Xr strftime 3 .
 321 .It Cm lockname
 322 The name of the lock that the process is currently blocked on.
 323 If the name is invalid or unknown, then
 324 .Dq ???\&
 325 is displayed.
 326 .It Cm logname
 327 The login name associated with the session the process is in (see
 328 .Xr getlogin 2 ) .
 329 .It Cm mwchan
 330 The event name if the process is blocked normally, or the lock name if
 331 the process is blocked on a lock.
 332 See the wchan and lockname keywords
 333 for details.
 334 .It Cm nice
 335 The process scheduling increment (see
 336 .Xr setpriority 2 ) .
 337 .It Cm rss
 338 the real memory (resident set) size of the process (in 1024 byte units).
 339 .It Cm start
 340 The time the command started.
 341 If the command started less than 24 hours ago, the start time is
 342 displayed using the
 343 .Dq Li %l:ps.1p
 344 format described in
 345 .Xr strftime 3 .
 346 If the command started less than 7 days ago, the start time is
 347 displayed using the
 348 .Dq Li %a6.15p
 349 format.
 350 Otherwise, the start time is displayed using the
 351 .Dq Li %e%b%y
 352 format.
 353 .It Cm state
 354 The state is given by a sequence of characters, for example,
 355 .Dq Li RWNA .
 356 The first character indicates the run state of the process:
 357 .Pp
 358 .Bl -tag -width indent -compact
 359 .It Li D
 360 Marks a process in disk (or other short term, uninterruptible) wait.
 361 .It Li I
 362 Marks a process that is idle (sleeping for longer than about 20 seconds).
 363 .It Li L
 364 Marks a process that is waiting to acquire a lock.
 365 .It Li R
 366 Marks a runnable process.
 367 .It Li S
 368 Marks a process that is sleeping for less than about 20 seconds.
 369 .It Li T
 370 Marks a stopped process.
 371 .It Li W
 372 Marks an idle interrupt thread.
 373 .It Li Z
 374 Marks a dead process (a
 375 .Dq zombie ) .
 376 .El
 377 .Pp
 378 Additional characters after these, if any, indicate additional state
 379 information:
 380 .Pp
 381 .Bl -tag -width indent -compact
 382 .It Li +
 383 The process is in the foreground process group of its control terminal.
 384 .It Li <
 385 The process has raised CPU scheduling priority.
 386 .It Li E
 387 The process is trying to exit.
 388 .It Li J
 389 Marks a process which is in
 390 .Xr jail 2 .
 391 The hostname of the prison can be found in
 392 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
 393 .It Li L
 394 The process has pages locked in core (for example, for raw
 395 .Tn I/O ) .
 396 .It Li N
 397 The process has reduced CPU scheduling priority (see
 398 .Xr setpriority 2 ) .
 399 .It Li s
 400 The process is a session leader.
 401 .It Li V
 402 The process is suspended during a
 403 .Xr vfork 2 .
 404 .It Li W
 405 The process is swapped out.
 406 .It Li X
 407 The process is being traced or debugged.
 408 .El
 409 .It Cm tt
 410 An abbreviation for the pathname of the controlling terminal, if any.
 411 The abbreviation consists of the three letters following
 412 .Pa /dev/tty ,
 413 or, for the console,
 414 .Dq Li con .
 415 This is followed by a
 416 .Ql -
 417 if the process can no longer reach that
 418 controlling terminal (i.e., it has been revoked).
 419 .It Cm wchan
 420 The event (an address in the system) on which a process waits.
 421 When printed numerically, the initial part of the address is
 422 trimmed off and the result is printed in hex, for example, 0x80324000 prints
 423 as 324000.
 424 .El
 425 .Pp
 426 When printing using the command keyword, a process that has exited and
 427 has a parent that has not yet waited for the process (in other words, a zombie)
 428 is listed as
 429 .Dq Li <defunct> ,
 430 and a process which is blocked while trying
 431 to exit is listed as
 432 .Dq Li <exiting> .
 433 If the arguments cannot be located (usually because it has not been set, as is
 434 the case of system processes and/or kernel threads) the command name is printed
 435 within square brackets.
 436 The
 437 .Nm
 438 utility first tries to obtain the arguments cached by the kernel (if they were
 439 shorter than the value of the
 440 .Va kern.ps_arg_cache_limit
 441 sysctl).
 442 The process can change the arguments shown with
 443 .Xr setproctitle 3 .
 444 Otherwise,
 445 .Nm
 446 makes an educated guess as to the file name and arguments given when the
 447 process was created by examining memory or the swap area.
 448 The method is inherently somewhat unreliable and in any event a process
 449 is entitled to destroy this information.
 450 The ucomm (accounting) keyword can, however, be depended on.
 451 If the arguments are unavailable or do not agree with the ucomm keyword,
 452 the value for the ucomm keyword is appended to the arguments in parentheses.
 453 .Sh KEYWORDS
 454 The following is a complete list of the available keywords and their
 455 meanings.
 456 Several of them have aliases (keywords which are synonyms).
 457 .Pp
 458 .Bl -tag -width ".Cm sigignore" -compact
 459 .It Cm %cpu
 460 percentage CPU usage (alias
 461 .Cm pcpu )
 462 .It Cm %mem
 463 percentage memory usage (alias
 464 .Cm pmem )
 465 .It Cm acflag
 466 accounting flag (alias
 467 .Cm acflg )
 468 .It Cm args
 469 command and arguments
 470 .It Cm comm
 471 command
 472 .It Cm command
 473 command and arguments
 474 .It Cm cpu
 475 short-term CPU usage factor (for scheduling)
 476 .It Cm etime
 477 elapsed running time
 478 .It Cm flags
 479 the process flags, in hexadecimal (alias
 480 .Cm f )
 481 .It Cm inblk
 482 total blocks read (alias
 483 .Cm inblock )
 484 .It Cm jid
 485 jail ID
 486 .It Cm jobc
 487 job control count
 488 .It Cm ktrace
 489 tracing flags
 490 .It Cm label
 491 MAC label
 492 .It Cm lim
 493 memoryuse limit
 494 .It Cm lockname
 495 lock currently blocked on (as a symbolic name)
 496 .It Cm logname
 497 login name of user who started the session
 498 .It Cm lstart
 499 time started
 500 .It Cm majflt
 501 total page faults
 502 .It Cm minflt
 503 total page reclaims
 504 .It Cm msgrcv
 505 total messages received (reads from pipes/sockets)
 506 .It Cm msgsnd
 507 total messages sent (writes on pipes/sockets)
 508 .It Cm mwchan
 509 wait channel or lock currently blocked on
 510 .It Cm nice
 511 nice value (alias
 512 .Cm ni )
 513 .It Cm nivcsw
 514 total involuntary context switches
 515 .It Cm nsigs
 516 total signals taken (alias
 517 .Cm nsignals )
 518 .It Cm nswap
 519 total swaps in/out
 520 .It Cm nvcsw
 521 total voluntary context switches
 522 .It Cm nwchan
 523 wait channel (as an address)
 524 .It Cm oublk
 525 total blocks written (alias
 526 .Cm oublock )
 527 .It Cm paddr
 528 swap address
 529 .It Cm pagein
 530 pageins (same as majflt)
 531 .It Cm pgid
 532 process group number
 533 .It Cm pid
 534 process ID
 535 .It Cm poip
 536 pageouts in progress
 537 .It Cm ppid
 538 parent process ID
 539 .It Cm pri
 540 scheduling priority
 541 .It Cm re
 542 core residency time (in seconds; 127 = infinity)
 543 .It Cm rgid
 544 real group ID
 545 .It Cm rgroup
 546 group name (from rgid)
 547 .It Cm rlink
 548 reverse link on run queue, or 0
 549 .It Cm rss
 550 resident set size
 551 .It Cm rtprio
 552 realtime priority (101 = not a realtime process)
 553 .It Cm ruid
 554 real user ID
 555 .It Cm ruser
 556 user name (from ruid)
 557 .It Cm sid
 558 session ID
 559 .It Cm sig
 560 pending signals (alias
 561 .Cm pending )
 562 .It Cm sigcatch
 563 caught signals (alias
 564 .Cm caught )
 565 .It Cm sigignore
 566 ignored signals (alias
 567 .Cm ignored )
 568 .It Cm sigmask
 569 blocked signals (alias
 570 .Cm blocked )
 571 .It Cm sl
 572 sleep time (in seconds; 127 = infinity)
 573 .It Cm start
 574 time started
 575 .It Cm state
 576 symbolic process state (alias
 577 .Cm stat )
 578 .It Cm svgid
 579 saved gid from a setgid executable
 580 .It Cm svuid
 581 saved UID from a setuid executable
 582 .It Cm tdev
 583 control terminal device number
 584 .It Cm time
 585 accumulated CPU time, user + system (alias
 586 .Cm cputime )
 587 .It Cm tpgid
 588 control terminal process group ID
 589 .\".It Cm trss
 590 .\"text resident set size (in Kbytes)
 591 .It Cm tsid
 592 control terminal session ID
 593 .It Cm tsiz
 594 text size (in Kbytes)
 595 .It Cm tt
 596 control terminal name (two letter abbreviation)
 597 .It Cm tty
 598 full name of control terminal
 599 .It Cm uprocp
 600 process pointer
 601 .It Cm ucomm
 602 name to be used for accounting
 603 .It Cm uid
 604 effective user ID
 605 .It Cm upr
 606 scheduling priority on return from system call (alias
 607 .Cm usrpri )
 608 .It Cm user
 609 user name (from UID)
 610 .It Cm vsz
 611 virtual size in Kbytes (alias
 612 .Cm vsize )
 613 .It Cm wchan
 614 wait channel (as a symbolic name)
 615 .It Cm xstat
 616 exit or stop status (valid only for stopped or zombie process)
 617 .El
 618 .Sh ENVIRONMENT
 619 The following environment variables affect the execution of
 620 .Nm :
 621 .Bl -tag -width ".Ev COLUMNS"
 622 .It Ev COLUMNS
 623 If set, specifies the user's preferred output width in column positions.
 624 By default,
 625 .Nm
 626 attempts to automatically determine the terminal width.
 627 .El
 628 .Sh FILES
 629 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
 630 .It Pa /boot/kernel/kernel
 631 default system namelist
 632 .It Pa /proc
 633 the mount point of
 634 .Xr procfs 5
 635 .El
 636 .Sh SEE ALSO
 637 .Xr kill 1 ,
 638 .Xr pgrep 1 ,
 639 .Xr pkill 1 ,
 640 .Xr procstat 1 ,
 641 .Xr w 1 ,
 642 .Xr kvm 3 ,
 643 .Xr strftime 3 ,
 644 .Xr mac 4 ,
 645 .Xr procfs 5 ,
 646 .Xr pstat 8 ,
 647 .Xr sysctl 8 ,
 648 .Xr mutex 9
 649 .Sh STANDARDS
 650 For historical reasons, the
 651 .Nm
 652 utility under
 653 .Fx
 654 supports a different set of options from what is described by
 655 .St -p1003.2 ,
 656 and what is supported on
 657 .No non- Ns Bx
 658 operating systems.
 659 .Sh HISTORY
 660 The
 661 .Nm
 662 command appeared in
 663 .At v4 .
 664 .Sh BUGS
 665 Since
 666 .Nm
 667 cannot run faster than the system and is run as any other scheduled
 668 process, the information it displays can never be exact.
 669 .Pp
 670 The
 671 .Nm
 672 utility does not correctly display argument lists containing multibyte
 673 characters.