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