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