2 .\" Copyright (c) 2007-2009 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd get detailed process information
40 .Op Fl b | c | e | f | i | j | k | l | s | t | v | x
45 utility displays detailed information about the processes identified by the
49 flag is used, all processes.
51 By default, basic process statistics are printed; one of the following
52 options may be specified in order to select more detailed process information
54 .Bl -tag -width indent
56 Display binary information for the process.
58 Display command line arguments for the process.
60 Display environment variables for the process.
62 Display file descriptor information for the process.
64 Display signal pending and disposition information for the process.
66 Display signal pending and blocked information for the process threads.
68 Display the stacks of kernel threads in the process, excluding stacks of
69 threads currently running on a CPU and threads with stacks swapped to disk.
70 If the flag is repeated, function offsets as well as function names are
73 Display resource limits for the process.
75 Display security credential information for the process.
77 Display thread information for the process.
79 Display virtual memory mappings for the process.
81 Display ELF auxiliary vector for the process.
84 All options generate output in the format of a table, the first field of
85 which is the process ID to which the row of information corresponds.
88 flag may be used to suppress table headers.
92 flag may be used to specify a wait interval at which to repeat the printing
93 of the requested process information.
96 flag is not specified, the output will not repeat.
100 flag requests the printing of additional capability information in the file
103 Some information, such as VM and file descriptor information, is available
104 only to the owner of a process or the superuser.
105 .Ss Binary Information
106 Display the process ID, command, and path to the process binary:
108 .Bl -tag -width indent -compact
114 path to process binary (if available)
116 .Ss Command Line Arguments
117 Display the process ID, command, and command line arguments:
119 .Bl -tag -width indent -compact
125 command line arguments (if available)
128 Display detailed information about each file descriptor referenced by a
129 process, including the process ID, command, file descriptor number, and
130 per-file descriptor object information, such as object type and file system
132 By default, the following information will be printed:
134 .Bl -tag -width indent -compact
140 file descriptor number or cwd/root/jail
146 file descriptor flags
148 file descriptor reference count
150 file descriptor offset
154 file path or socket addresses (if available)
157 The following file descriptor types may be displayed:
159 .Bl -tag -width X -compact
177 pseudo-terminal master
182 The following vnode types may be displayed:
184 .Bl -tag -width X -compact
205 The following file descriptor flags may be displayed:
207 .Bl -tag -width X -compact
225 descriptor is a capability
230 flag is specified, the vnode type, reference count, and offset fields will be
231 omitted, and a new capabilities field will be included listing capabilities,
234 present for each capability descriptor.
235 .Ss Signal Disposition Information
236 Display signal pending and disposition for a process:
238 .Bl -tag -width ident -compact
246 process signal disposition details, three symbols
247 .Bl -tag -width X -compact
249 if signal is pending in the global process queue, - otherwise
251 if signal delivery disposition is SIGIGN, - otherwise
253 if signal delivery is to catch it, - otherwise
259 switch is given, the signal numbers are shown instead of signal names.
260 .Ss Thread Signal Information
261 Display signal pending and blocked for a process threads:
263 .Bl -tag -width ident -compact
273 thread signal delivery status, two symbols
274 .Bl -tag -width X -compact
276 if signal is pending for the thread, - otherwise
278 if signal is blocked in the thread signal mask, - if not blocked
284 switch has the same effect as for the
286 switch, the signals numbers are shown instead of signal names.
287 .Ss Kernel Thread Stacks
288 Display kernel thread stacks for a process, allowing further interpretation
289 of thread wait channels.
292 flag is repeated, function offsets, not just function names, are printed.
294 This feature requires
298 to be compiled into the kernel.
300 .Bl -tag -width indent -compact
310 kernel thread call stack
312 .Ss Security Credentials
313 Display process credential information:
315 .Bl -tag -width indent -compact
338 The following credential flags may be displayed:
340 .Bl -tag -width X -compact
344 .Ss Thread Information
345 Display per-thread information, including process ID, per-thread ID, name,
346 CPU, and execution state:
348 .Bl -tag -width indent -compact
358 current or most recent CPU run on
366 .Ss Virtual Memory Mappings
367 Display process virtual memory mappings, including addresses, mapping
368 meta-data, and mapped object information:
370 .Bl -tag -width indent -compact
374 starting address of mapping
376 ending address of mapping
382 private resident pages
393 The following protection flags may be displayed:
395 .Bl -tag -width X -compact
404 The following VM object types may be displayed:
406 .Bl -tag -width XX -compact
423 The following mapping flags may be displayed:
425 .Bl -tag -width X -compact
431 one or more superpage mappings are used
444 .An Robert N M Watson
446 Some field values may include spaces, which limits the extent to which the
449 may be mechanically parsed.
451 The display of open file or memory mapping pathnames is implemented using the
453 If a file system does not use the name cache, or the path to a file is not in
454 the cache, a path will not be displayed.
457 currently supports extracting data only from a live kernel, and not from