nightly: remove unused BINARCHIVE
[unleashed.git] / share / man / man3lib / libpctx.3lib
blob7a9b35082014d342f1b69b5712fdad35f484b3a8
1 '\" te
2 .\" Copyright (c) 2003, 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 LIBPCTX 3LIB "May 22, 2003"
7 .SH NAME
8 libpctx \- process context library
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lpctx\fR [ \fIlibrary\fR... ]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 Functions in this library provide a simple means to access the underlying
19 facilities of \fBproc\fR(4) to allow a controlling process to manipulate the
20 state of a controlled process.
21 .sp
22 .LP
23 This library is primarily for use in conjunction with the \fBlibcpc\fR(3LIB)
24 library.  Used together, these libraries allow developers to construct tools
25 that can manipulate CPU performance counters in other processes. The
26 \fBcputrack\fR(1) utility is an example of such a tool.
27 .SH INTERFACES
28 .sp
29 .LP
30 The shared object \fBlibpctx.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 \fBpctx_capture\fR      \fBpctx_create\fR
40 \fBpctx_release\fR      \fBpctx_run\fR
41 \fBpctx_set_events\fR   
42 .TE
44 .SH FILES
45 .sp
46 .ne 2
47 .na
48 \fB\fB/usr/lib/libpctx.so.1\fR \fR
49 .ad
50 .RS 29n
51 shared object
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fB/usr/lib/64/libpctx.so.1\fR \fR
58 .ad
59 .RS 29n
60 64-bit shared object
61 .RE
63 .SH ATTRIBUTES
64 .sp
65 .LP
66 See \fBattributes\fR(5) for descriptions of the following attributes:
67 .sp
69 .sp
70 .TS
71 box;
72 l | l
73 l | l .
74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
76 MT-Level        Safe
77 .TE
79 .SH SEE ALSO
80 .sp
81 .LP
82 \fBcputrack\fR(1), \fBIntro\fR(3), \fBcpc\fR(3CPC), \fBlibcpc\fR(3LIB),
83 \fBproc\fR(4), \fBattributes\fR(5)