5479 Need missing *at family manual pages
[illumos-gate.git] / usr / src / man / man3lib / librtld_db.3lib
blobf85ad063768da7d83c136e444278bb537a34da16
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIBRTLD_DB 3LIB "Oct 12, 2007"
7 .SH NAME
8 librtld_db \- runtime linker debugging library
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lrtld_db\fR [ \fIlibrary\fR ... ]
13 #include <\fBproc_service.h\fR>
14 #include <\fBrtld_db.h\fR>
15 .fi
17 .SH DESCRIPTION
18 .sp
19 .LP
20 Functions is this library are useful for building debuggers for dynamically
21 linked programs. For a full description of these interfaces refer to the
22 \fILinker and Libraries Guide\fR.
23 .sp
24 .LP
25 To use \fBlibrtld_db\fR, applications need to implement the interfaces
26 documented in \fBps_pread\fR(3PROC) and \fBproc_service\fR(3PROC).
27 .SH INTERFACES
28 .sp
29 .LP
30 The shared object \fBlibrtld_db.so.1\fR provides the public interfaces defined
31 below. See \fBIntro\fR(3) for additional information on shared object
32 interfaces.
33 .sp
35 .sp
36 .TS
37 l l
38 l l .
39 \fBrd_delete\fR \fBrd_errstr\fR
40 \fBrd_event_addr\fR     \fBrd_event_enable\fR
41 \fBrd_event_getmsg\fR   \fBrd_init\fR
42 \fBrd_loadobj_iter\fR   \fBrd_log\fR
43 \fBrd_new\fR    \fBrd_objpad_enable\fR
44 \fBrd_plt_resolution\fR \fBrd_reset\fR
45 .TE
47 .SH FILES
48 .sp
49 .ne 2
50 .na
51 \fB\fB/lib/librtld_db.so.1\fR\fR
52 .ad
53 .RS 27n
54 shared object
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fB\fB/lib/64/librtld_db.so.1\fR\fR
61 .ad
62 .RS 27n
63 64-bit shared object
64 .RE
66 .SH ATTRIBUTES
67 .sp
68 .LP
69 See \fBattributes\fR(5) for description of the following attributes:
70 .sp
72 .sp
73 .TS
74 box;
75 c | c
76 l | l .
77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
79 MT-Level        Safe
80 .TE
82 .SH SEE ALSO
83 .sp
84 .LP
85 \fBld.so.1\fR(1), \fBpvs\fR(1), \fBIntro\fR(3), \fBproc_service\fR(3PROC),
86 \fBps_pread\fR(3PROC), \fBrtld_db\fR(3EXT), \fBattributes\fR(5)
87 .sp
88 .LP
89 \fILinker and Libraries Guide\fR