share/man/man3lib/libcontract.3lib

   1 '\" te
   2 .\" Copyright (c) 2008, 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 LIBCONTRACT 3LIB "Feb 25, 2008"
   7 .SH NAME
   8 libcontract \- contract management library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lcontract\fR [ \fIlibrary\fR... ]
  13 #include <\fBlibcontract.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide various interfaces to interact with the
  20 \fBcontract\fR(4) file system. The header provides structure and function
  21 declarations for all library interfaces.
  22 .SH INTERFACES
  23 .sp
  24 .LP
  25 The shared object \fBlibcontract.so.1\fR provides the public interfaces defined
  26 below. See \fBIntro\fR(3) for additional information on shared object
  27 interfaces.
  28 .sp
  29
  30 .sp
  31 .TS
  32 l l
  33 l l .
  34 \fBct_ctl_abandon\fR    \fBct_ctl_ack\fR
  35 \fBct_ctl_adopt\fR      \fBct_ctl_nack\fR
  36 \fBct_ctl_newct\fR      \fBct_ctl_qack\fR
  37 \fBct_dev_status_get_aset\fR    \fBct_dev_status_get_dev_state\fR
  38 \fBct_dev_status_get_minor\fR   \fBct_dev_status_get_noneg\fR
  39 \fBct_dev_tmpl_clear_noneg\fR   \fBct_dev_tmpl_get_aset\fR
  40 \fBct_dev_tmpl_get_minor\fR     \fBct_dev_tmpl_get_noneg\fR
  41 \fBct_dev_tmpl_set_aset\fR      \fBct_dev_tmpl_set_minor\fR
  42 \fBct_dev_tmpl_set_noneg\fR     \fBct_event_free\fR
  43 \fBct_event_get_ctid\fR \fBct_event_get_evid\fR
  44 \fBct_event_get_flags\fR        \fBct_event_get_nevid\fR
  45 \fBct_event_get_newct\fR        \fBct_event_get_type\fR
  46 \fBct_event_read\fR     \fBct_event_read_critical\fR
  47 \fBct_event_reliable\fR \fBct_event_reset\fR
  48 \fBct_pr_event_get_exitstatus\fR        \fBct_pr_event_get_gcorefile\fR
  49 \fBct_pr_event_get_pcorefile\fR \fBct_pr_event_get_pid\fR
  50 \fBct_pr_event_get_ppid\fR      \fBct_pr_event_get_sender\fR
  51 \fBct_pr_event_get_senderct\fR  \fBct_pr_event_get_signal\fR
  52 \fBct_pr_event_get_zcorefile\fR \fBct_pr_status_get_contracts\fR
  53 \fBct_pr_status_get_fatal\fR    \fBct_pr_status_get_members\fR
  54 \fBct_pr_status_get_param\fR    \fBct_pr_status_get_aux\fR
  55 \fBct_pr_status_get_creator\fR  \fBct_pr_status_get_ctid\fR
  56 \fBct_pr_status_get_fmri\fR     \fBct_pr_tmpl_get_fatal\fR
  57 \fBct_pr_tmpl_get_param\fR      \fBct_pr_tmpl_get_transfer\fR
  58 \fBct_pr_tmpl_set_fatal\fR      \fBct_pr_tmpl_set_param\fR
  59 \fBct_pr_tmpl_set_transfer\fR   \fBct_status_free\fR
  60 \fBct_status_get_cookie\fR      \fBct_status_get_critical\fR
  61 \fBct_status_get_holder\fR      \fBct_status_get_id\fR
  62 \fBct_status_get_informative\fR \fBct_status_get_nevents\fR
  63 \fBct_status_get_nevid\fR       \fBct_status_get_ntime\fR
  64 \fBct_status_get_qtime\fR       \fBct_status_get_state\fR
  65 \fBct_status_get_type\fR        \fBct_status_get_zoneid\fR
  66 \fBct_status_read\fR    \fBct_tmpl_activate\fR
  67 \fBct_tmpl_clear\fR     \fBct_tmpl_create\fR
  68 \fBct_tmpl_get_cookie\fR        \fBct_tmpl_get_critical\fR
  69 \fBct_tmpl_get_informative\fR   \fBct_tmpl_get_svc_aux\fR
  70 \fBct_tmpl_get_svc_fmri\fR      \fBct_tmpl_set_cookie\fR
  71 \fBct_tmpl_set_critical\fR      \fBct_tmpl_set_informative\fR
  72 \fBct_tmpl_set_svc_aux\fR       \fBct_tmpl_set_svc_fmri\fR
  73 .TE
  74
  75 .SH FILES
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB/usr/lib/libcontract.so.1\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 shared object
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB/usr/lib/64/libcontract.so.1\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 64-bit shared object
  94 .RE
  95
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Committed
 110 _
 111 MT-Level        Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBpvs\fR(1), \fBIntro\fR(3), \fBcontract\fR(4), \fBattributes\fR(5)