Some fixes and formatting changes from jmc@openbsd.

This commit is contained in:
wiz 2004-02-17 20:41:49 +00:00
parent c8e0ab671d
commit 9ea670a934

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pmap.1,v 1.11 2003/04/16 12:12:08 wiz Exp $
.\" $NetBSD: pmap.1,v 1.12 2004/02/17 20:41:49 wiz Exp $
.\"
.\" Copyright (c) 2002, 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -68,9 +68,9 @@ By default,
displays information for its parent process, so that when run from a
shell prompt, the shell's memory information is displayed.
If other
pids are given as arguments on the command line, information for those
PIDs are given as arguments on the command line, information for those
processes will be printed also.
If the special pid of 0 is given,
If the special PID of 0 is given,
then information for the kernel's memory map is printed.
.Pp
The options are as follows:
@ -207,15 +207,17 @@ If you do wish to see information about
.Nm
and another process as the same time, simply omit the
.Fl p
and place the extra pid at the end of the command line.
and place the extra PID at the end of the command line.
.Sh EXIT STATUS
.Nm
exits 0 on success, and \*[Gt]0 if an error occurred.
.Sh EXAMPLES
While the meaning most of the output is self evident, some pieces of
While the meaning most of the output is self-evident, some pieces of
it may appear to be a little inscrutable.
.Pp
Here is a portion of the default output from pmap being run at an
Here is a portion of the default output from
.Nm
being run at an
.Xr sh 1
prompt showing the starting address of the map entry, the size of the
map entry, the current protection level of the map entry, and either
@ -257,16 +259,16 @@ the include file
.El
.Pp
The
.Dq Tn submap ,
.Dq Tn cow ,
.Dq submap ,
.Dq cow ,
and
.Dq Tn nc
.Dq nc
fields are true or false, and indicate whether the map is a submap,
whether it is marked for copy on write, and whether it needs a copy.
The
.Dq Tn prot
.Dq prot
\&(or protection) field, along with
.Dq Tn max
.Dq max
\&(maximum protection allowed) are made up of the following flags from
.Aq Pa uvm/uvm_extern.h :
.\" this column width specifically chosen so that all the header file
@ -278,9 +280,9 @@ The
.El
.Pp
The
.Dq Tn obj
.Dq obj
and
.Dq Tn amap
.Dq amap
fields are pointers to, and offsets into, the underlying uvm_object or
amap.
The value for resident is always unknown because digging such
@ -307,22 +309,22 @@ $ pmap -l
.Ed
.Pp
Here the protection and maximum protection values are indicated with
.Dq Tn r ,
.Dq Tn w ,
.Sq r ,
.Sq w ,
and
.Dq Tn x
.Sq x
characters, indicating read permission, write permission, and execute
permission, respectively.
The
.Dq Tn COW ,
.Dq Tn NC ,
.Dq COW ,
.Dq NC ,
and
.Dq Tn NNC
.Dq NNC
values that follow indicate, again, that the map is marked for copy on
write and either needs or does not need a copy.
It is also possible
to see the value
.Dq Tn NCOW
.Dq NCOW
here, which indicates that an entry will not be copied.
The three
following numbers indicate the inheritance type of the map, the wired
@ -330,10 +332,10 @@ count of the map, and any advice value assigned via
.Xr madvise 2 .
.Pp
In the second form, the permissions indicated are followed by a
.Dq Tn p
.Sq p
or
.Dq Tn s
character indicated whether the map entry is private or shared (copy
.Sq s
character indicating whether the map entry is private or shared (copy
on write or not), and the numbers are the offset into the underlying
object, the device and numbers of the object if it is a file, and the
path to the file (if available).
@ -341,7 +343,7 @@ path to the file (if available).
As noted above (see section
.Sx DESCRIPTION ) ,
the
.Dq Tn all
.Dq all
output format is an amalgam of the previous output formats.
.Bd -literal -offset indent
$ pmap -a
@ -351,17 +353,17 @@ Start End Size Offset rwxpc RWX I/W/A ...
.Ed
.Pp
In this format, the column labeled
.Dq Tn rwxpc
.Dq rwxpc
contains the permissions for the mapping along with the shared/private
flag, and a character indicating whether the mapping needs to be
copied on write
.Pq Dq \&+
.Pq Sq \&+
or has already been copied
.Pq Dq \&-
.Pq Sq \&-
and is followed by a column that indicates the maximum permissions for
the map entry.
The column labeled
.Dq Tn I/W/A
.Dq I/W/A
indicates the inheritance, wired, and advice values for the map entry,
as previously described.
The pointer value at the end of the output line for entries backed by
@ -395,7 +397,7 @@ Since processes can change state while
.Nm
is running, some of the information printed may be inaccurate.
This
is especially important to consider when examining the kernel's map
is especially important to consider when examining the kernel's map,
since merely executing
.Nm
will cause some of the information to change.