summaryrefslogtreecommitdiff
path: root/usr/src/man/man3lib/libproc.3lib
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2022-02-26 16:40:47 -0600
committerRichard Lowe <richlowe@richlowe.net>2022-03-10 01:14:35 -0600
commitbbf215553c7233fbab8a0afdf1fac74c44781867 (patch)
treee698415c5d1265b368c58c56199244dc2be86500 /usr/src/man/man3lib/libproc.3lib
parent236cb9a89d936b4b681853751c9af1adccc35ef9 (diff)
downloadillumos-gate-bbf215553c7233fbab8a0afdf1fac74c44781867.tar.gz
14443 resection manual pages per IPD4
Reviewed by: Toomas Soome <tsoome@me.com> Reviewed by: Robert Mustacchi <rm@fingolfin.org> Reviewed by: Peter Tribble <peter.tribble@gmail.com> Reviewed by: Andy Fiddaman <andy@omnios.org> Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man3lib/libproc.3lib')
-rw-r--r--usr/src/man/man3lib/libproc.3lib50
1 files changed, 25 insertions, 25 deletions
diff --git a/usr/src/man/man3lib/libproc.3lib b/usr/src/man/man3lib/libproc.3lib
index 3ae126d1f7..803534bfda 100644
--- a/usr/src/man/man3lib/libproc.3lib
+++ b/usr/src/man/man3lib/libproc.3lib
@@ -29,7 +29,7 @@ library provides consumers a general series of interfaces to inspect
and control both live processes and core files.
It is intended for introspection tools such as debuggers by providing a
high-level interface to the /proc file system
-.Pf ( Xr proc 4 ) .
+.Pf ( Xr proc 5 ) .
.Pp
The
.Nm
@@ -71,7 +71,7 @@ Users with the privilege
.Brq Sy PRIV_PROC_OWNER
may manipulate processes that they do not own; however, additional
restrictions as described in
-.Xr privileges 5
+.Xr privileges 7
apply.
.Pp
In addition, the
@@ -86,7 +86,7 @@ The
library has the ability to open and interpret core files produced by
processes on the system.
Process core dump generation is controlled by the
-.Xr coreadm 1M
+.Xr coreadm 8
command.
In addition, the library has the ability to understand and interpret core dumps
generated by Linux kernel and can provide a subset of its functionality on such
@@ -116,7 +116,7 @@ sections.
Many of the operations in the library rely on debug information being
present in a process and its associated libraries.
The library leverages symbol table information, CTF data
-.Pq Xr ctf 4
+.Pq Xr ctf 5
sections, and frame unwinding information based on the use of an ABI
defined frame pointer, e\&.g\&.
.Sy %ebp
@@ -386,7 +386,7 @@ of privileges.
To resume control call
.Xr Preopen 3PROC .
For more information on losing control of a process, see
-.Xr proc 4 .
+.Xr proc 5 .
.It Dv PS_UNDEAD
A zombie process.
It has terminated, but it has not been cleaned up yet by its parent.
@@ -424,7 +424,7 @@ may have a read-only snapshot of their tracing settings available.
The
.Nm
library uses many types that come from the /proc file system
-.Pq Xr proc 4
+.Pq Xr proc 5
and the ELF format
.Pq Xr elf 3ELF .
However, it also defines the following types:
@@ -472,13 +472,13 @@ and
to describe and control the types of content that get included.
Various content types may be included together through a bitwise-inclusive-OR.
The default system core contents are controlled with the
-.Xr coreadm 1M
+.Xr coreadm 8
tool.
The following table lists the current set of core contents in the system, though
the set may increase over time.
The string after the macro is the human readable string that corresponds with
the constant and is used by
-.Xr coreadm 1M ,
+.Xr coreadm 8 ,
.Xr proc_content2str 3PROC ,
and
.Xr proc_str2content 3PROC .
@@ -520,7 +520,7 @@ The contents include ISM (intimate shared memory) mappings.
The contents include DISM (dynamic shared memory) mappings.
.It Dv CC_CONTENT_CTF ("ctf")
The contents include
-.Xr ctf 4
+.Xr ctf 5
(Compact C Type Format) information.
Note, not all objects in the process may have CTF information available.
.It Dv CC_CONTENT_SYMTAB ("symtab")
@@ -689,7 +689,7 @@ The
.Fa pr_misc
member contains miscellaneous additional data relating to the file descriptor.
The format of these data is described in
-.Xr proc 4 .
+.Xr proc 5 .
.Pp
.Vt prsyminfo_t
.Pp
@@ -759,7 +759,7 @@ It is defined as
.Fc .
The first argument is a pointer to an argument that the user specifies,
while the second has the thread's status information and is defined in
-.Xr proc 4 .
+.Xr proc 5 .
For additional information on using this type, see
.Xr Plwp_iter 3PROC .
.Pp
@@ -784,7 +784,7 @@ thread-specific
.Xr ps 1
information respectively.
Both structures are defined in
-.Xr proc 4 .
+.Xr proc 5 .
For additional information on using this type, see
.Xr Plwp_iter_all 3PROC .
.Pp
@@ -831,7 +831,7 @@ The first argument contains the file descriptor information.
The
.Sy prfdinfo_t
structure is defined in
-.Xr proc 4 .
+.Xr proc 5 .
The final argument is a pointer to an argument that the user specifies.
For more information on using this, see
.Xr proc_fdwalk 3PROC .
@@ -857,7 +857,7 @@ information and the second argument contains the representative thread's
.Xr ps 1
information.
Both structures are defined in
-.Xr proc 4 .
+.Xr proc 5 .
The final argument is a pointer to an argument that the user specifies.
For more information on using this, see
.Xr proc_walk 3PROC .
@@ -884,7 +884,7 @@ It is defined as
The first argument is a pointer to an argument that the user specifies.
The second argument is describes the mapping information and is defined
in
-.Xr proc 4 .
+.Xr proc 5 .
The final argument contains the name of the mapping or object file in
question.
For additional information on using this type, see
@@ -917,7 +917,7 @@ Values in the environment follow the convention of the form
For more information on environment variables see
.Xr exec 2
and
-.Xr environ 5 .
+.Xr environ 7 .
For additional information on using this type, see
.Xr Penv_iter 3PROC .
.Pp
@@ -1005,7 +1005,7 @@ frame pointer, will be filled in to point to an entry.
The
.Vt prgregset_t
is defined in
-.Xr proc 4 .
+.Xr proc 5 .
.Pp
The third argument contains the number of arguments to the current stack
frame and the fourth argument contains an array of addresses that
@@ -1052,7 +1052,7 @@ when they hold a process handle across an exec.
In addition, users of the library should familiarize themselves with the
.Sy PROGRAMMING NOTES
section of the
-.Xr proc 4
+.Xr proc 5
manual page, which discusses issues of privileges and security.
.Sh DEBUGGING
The library provides a means for obtaining additional debugging
@@ -1086,7 +1086,7 @@ section.
The MT-Level of a routine that matches the above description will refer to this
manual page.
If it does not, then it refers to the standard attributes in
-.Xr attributes 5 .
+.Xr attributes 7 .
.Sh INTERFACE STABILITY
.Sy Uncommitted
.Pp
@@ -1101,18 +1101,18 @@ changes may occur which break both source and binary compatibility.
.Xr mdb 1 ,
.Xr proc 1 ,
.Xr ps 1 ,
-.Xr coreadm 1M ,
.Xr exec 2 ,
.Xr fcntl 2 ,
.Xr stat 2 ,
.Xr Intro 3 ,
.Xr dlopen 3C ,
.Xr elf 3ELF ,
-.Xr ctf 4 ,
-.Xr proc 4 ,
-.Xr attributes 5 ,
-.Xr environ 5 ,
-.Xr privileges 5
+.Xr ctf 5 ,
+.Xr proc 5 ,
+.Xr attributes 7 ,
+.Xr environ 7 ,
+.Xr privileges 7 ,
+.Xr coreadm 8
.Pp
.Rs
.%T Linkers and Libraries Guide