share/man/man3tecla/libtecla_version.3tecla

   1 '\" te
   2 .\" Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd.
   3 .\" All Rights Reserved.
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, and/or sell copies of the Software, and to permit persons
   8 .\" to whom the Software is furnished to do so, provided that the above
   9 .\" copyright notice(s) and this permission notice appear in all copies of
  10 .\" the Software and that both the above copyright notice(s) and this
  11 .\" permission notice appear in supporting documentation.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  14 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  15 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
  16 .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  17 .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
  18 .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
  19 .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  20 .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
  21 .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22 .\"
  23 .\" Except as contained in this notice, the name of a copyright holder
  24 .\" shall not be used in advertising or otherwise to promote the sale, use
  25 .\" or other dealings in this Software without prior written authorization
  26 .\" of the copyright holder.
  27 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
  28 .TH LIBTECLA_VERSION 3TECLA "Jun 1, 2004"
  29 .SH NAME
  30 libtecla_version \- query libtecla version number
  31 .SH SYNOPSIS
  32 .LP
  33 .nf
  34 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ltecla\fR [ \fIlibrary\fR\&.\|.\|. ]
  35 #include <libtecla.h>
  36
  37 \fBvoid\fR \fBlibtecla_version\fR(\fBint *\fR\fImajor\fR, \fBint *\fR\fIminor\fR, \fBint *\fR\fImicro\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBlibtecla_version()\fR function queries for the version number of the
  44 library.
  45 .sp
  46 .LP
  47 On return, this function records the three components of the libtecla version
  48 number in *\fImajor\fR, *\fIminor\fR, *\fImicro\fR. The formal meaning of the
  49 three components is as follows:
  50 .sp
  51 .ne 2
  52 .na
  53 \fBmajor\fR
  54 .ad
  55 .RS 9n
  56 Incrementing this number implies that a change has been made to the library's
  57 public interface that makes it binary incompatible with programs that were
  58 linked with previous shared versions of libtecla.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fBminor\fR
  65 .ad
  66 .RS 9n
  67 This number is incremented by one whenever additional functionality, such as
  68 new functions or modules, are added to the library.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fBmicro\fR
  75 .ad
  76 .RS 9n
  77 This number is incremented whenever modifications to the library are made that
  78 make no changes to the public interface, but which fix bugs and/or improve the
  79 behind-the-scenes implementation.
  80 .RE
  81
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Evolving
  96 _
  97 MT-Level        MT-Safe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibtecla\fR(3LIB), \fBattributes\fR(5)