8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3lib / libtnfctl.3lib
blob3dcfb00f099d8167f4e956558495e72e0ee9a8bc
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 LIBTNFCTL 3LIB "May 22, 2003"
7 .SH NAME
8 libtnfctl \- TNF probe control library
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR... ] \fIfile\fR.. \fB-ltnfctl\fR [ \fIlibrary\fR... ]
13 #include <\fBtnf/tnfctl.h\fR>
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 Functions in this library provide TNF probe control routines for use by
20 processes and the kernel.
21 .SH INTERFACES
22 .sp
23 .LP
24 The shared object \fBlibtnfctl.so.1\fR provides the public interfaces defined
25 below. See \fBIntro\fR(3) for additional information on shared object
26 interfaces.
27 .sp
29 .sp
30 .TS
31 l l
32 l l .
33 \fBtnfctl_buffer_alloc\fR       \fBtnfctl_buffer_dealloc\fR
34 \fBtnfctl_check_libs\fR \fBtnfctl_close\fR
35 \fBtnfctl_continue\fR   \fBtnfctl_exec_open\fR
36 \fBtnfctl_filter_list_add\fR    \fBtnfctl_filter_list_delete\fR
37 \fBtnfctl_filter_list_get\fR    \fBtnfctl_filter_state_set\fR
38 \fBtnfctl_indirect_open\fR      \fBtnfctl_internal_open\fR
39 \fBtnfctl_kernel_open\fR        \fBtnfctl_pid_open\fR
40 \fBtnfctl_probe_apply\fR        \fBtnfctl_probe_apply_ids\fR
41 \fBtnfctl_probe_connect\fR      \fBtnfctl_probe_disable\fR
42 \fBtnfctl_probe_disconnect_all\fR       \fBtnfctl_probe_enable\fR
43 \fBtnfctl_probe_state_get\fR    \fBtnfctl_probe_trace\fR
44 \fBtnfctl_probe_untrace\fR      \fBtnfctl_register_funcs\fR
45 \fBtnfctl_strerror\fR   \fBtnfctl_trace_attrs_get\fR
46 \fBtnfctl_trace_state_set\fR    
47 .TE
49 .SH FILES
50 .sp
51 .ne 2
52 .na
53 \fB\fB/usr/lib/libtnfctl.so.1\fR\fR
54 .ad
55 .RS 30n
56 shared object
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB/usr/lib/64/libtnfctl.so.1\fR\fR
63 .ad
64 .RS 30n
65 64-bit shared object
66 .RE
68 .SH ATTRIBUTES
69 .sp
70 .LP
71 See \fBattributes\fR(5) for descriptions of the following attributes:
72 .sp
74 .sp
75 .TS
76 box;
77 c | c
78 l | l .
79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
81 MT-Level        MT-Safe with exceptions
82 .TE
84 .SH SEE ALSO
85 .sp
86 .LP
87 \fBpvs\fR(1), \fBIntro\fR(3), \fBlibtnfctl\fR(3TNF), \fBtracing\fR(3TNF),
88 \fBattributes\fR(5)
89 .SH NOTES
90 .sp
91 .LP
92 This \fBAPI\fR is MT-Safe.  Multiple threads can concurrently operate on
93 independent \fBtnfctl\fR handles, which is the typical behavior expected.
94 \fBlibtnfctl\fR does not support multiple threads operating on the same
95 \fBtnfctl\fR handle.  If this is desired, it is the client's responsibility to
96 implement locking to ensure that two threads that use the same \fBtnfctl\fR
97 handle are not simultaneously present in a \fBlibtnfctl\fR interface.