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