bin/ps/ps.1

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