1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="geier-Version-Information">
<refmeta>
<refentrytitle role="top_of_page" id="geier-Version-Information.top_of_page">Version Information</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GEIER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Version Information</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="geier-Version-Information.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="LIBGEIER-DOTTED-VERSION--CAPS">LIBGEIER_DOTTED_VERSION</link>
#define <link linkend="LIBGEIER-TEST-VERSION--CAPS">LIBGEIER_TEST_VERSION</link>
<link linkend="void">void</link> <link linkend="geier-check-version">geier_check_version</link> (const <link linkend="char">char</link> *version);
</synopsis>
</refsynopsisdiv>
<refsect1 id="geier-Version-Information.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="geier-Version-Information.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="LIBGEIER-DOTTED-VERSION--CAPS" role="macro">
<title>LIBGEIER_DOTTED_VERSION</title>
<indexterm zone="LIBGEIER-DOTTED-VERSION--CAPS"><primary sortas="LIBGEIER_DOTTED_VERSION">LIBGEIER_DOTTED_VERSION</primary></indexterm><programlisting>#define LIBGEIER_DOTTED_VERSION "0.11"
</programlisting>
<para>
The version string of the GEIER library shipping this header file,
not including the crypto module specification.</para>
<para>
</para></refsect2>
<refsect2 id="LIBGEIER-TEST-VERSION--CAPS" role="macro">
<title>LIBGEIER_TEST_VERSION</title>
<indexterm zone="LIBGEIER-TEST-VERSION--CAPS"><primary sortas="LIBGEIER_TEST_VERSION">LIBGEIER_TEST_VERSION</primary></indexterm><programlisting>#define LIBGEIER_TEST_VERSION geier_check_version(LIBGEIER_DOTTED_VERSION)
</programlisting>
<para>
Check whether the version of the installed header file (used and
installed at compile time) matches the installed library version.
</para>
<para>
If the versions don't match, a warning message is written to
stderr.</para>
<para>
</para></refsect2>
<refsect2 id="geier-check-version" role="function">
<title>geier_check_version ()</title>
<indexterm zone="geier-check-version"><primary sortas="geier_check_version">geier_check_version</primary></indexterm><programlisting><link linkend="void">void</link> geier_check_version (const <link linkend="char">char</link> *version);</programlisting>
<para>
Check whether the version number of the library matches the
provided version information. If not, a warning message is emitted
to stderr.
</para>
<para>
The name of the crypto module is not compared.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>version</parameter> :</term>
<listitem><simpara> the version number to check the library against.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
