~peter-pearse/ubuntu/natty/gss/prop001

« back to all changes in this revision

Viewing changes to doc/reference/xml/gss.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon Josefsson
  • Date: 2010-05-20 17:48:39 UTC
  • mfrom: (1.1.7 upstream) (2.1.8 sid)
  • Revision ID: james.westby@ubuntu.com-20100520174839-zs6ghryzyu48d4s4
Tags: 1.0.1-1
New upstream version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="gss-gss">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="gss-gss.top_of_page">gss</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  GSS Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>gss</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="gss-gss.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>#define             <link linkend="GSS-VERSION:CAPS">GSS_VERSION</link>
21
 
#define             <link linkend="GSS-VERSION-MAJOR:CAPS">GSS_VERSION_MAJOR</link>
22
 
#define             <link linkend="GSS-VERSION-MINOR:CAPS">GSS_VERSION_MINOR</link>
23
 
#define             <link linkend="GSS-VERSION-PATCH:CAPS">GSS_VERSION_PATCH</link>
24
 
#define             <link linkend="GSS-VERSION-NUMBER:CAPS">GSS_VERSION_NUMBER</link>
25
 
</synopsis>
26
 
</refsynopsisdiv>
27
 
 
28
 
<refsect1 id="gss-gss.description" role="desc">
29
 
<title role="desc.title">Description</title>
30
 
<para>
31
 
</para>
32
 
</refsect1>
33
 
<refsect1 id="gss-gss.details" role="details">
34
 
<title role="details.title">Details</title>
35
 
<refsect2 id="GSS-VERSION:CAPS" role="macro">
36
 
<title>GSS_VERSION</title>
37
 
<indexterm zone="GSS-VERSION:CAPS"><primary>GSS_VERSION</primary></indexterm>
38
 
<programlisting># define GSS_VERSION "1.0.0"
39
 
</programlisting>
40
 
<para>
41
 
Pre-processor symbol with a string that describe the header file
42
 
version number.  Used together with <link linkend="gss-check-version"><function>gss_check_version()</function></link> to verify
43
 
header file and run-time library consistency.</para>
44
 
</refsect2>
45
 
<refsect2 id="GSS-VERSION-MAJOR:CAPS" role="macro">
46
 
<title>GSS_VERSION_MAJOR</title>
47
 
<indexterm zone="GSS-VERSION-MAJOR:CAPS"><primary>GSS_VERSION_MAJOR</primary></indexterm>
48
 
<programlisting># define GSS_VERSION_MAJOR 1
49
 
</programlisting>
50
 
<para>
51
 
Pre-processor symbol with a decimal value that describe the major
52
 
level of the header file version number.  For example, when the
53
 
header version is 1.2.3 this symbol will be 1.</para>
54
 
</refsect2>
55
 
<refsect2 id="GSS-VERSION-MINOR:CAPS" role="macro">
56
 
<title>GSS_VERSION_MINOR</title>
57
 
<indexterm zone="GSS-VERSION-MINOR:CAPS"><primary>GSS_VERSION_MINOR</primary></indexterm>
58
 
<programlisting># define GSS_VERSION_MINOR 0
59
 
</programlisting>
60
 
<para>
61
 
Pre-processor symbol with a decimal value that describe the minor
62
 
level of the header file version number.  For example, when the
63
 
header version is 1.2.3 this symbol will be 2.</para>
64
 
</refsect2>
65
 
<refsect2 id="GSS-VERSION-PATCH:CAPS" role="macro">
66
 
<title>GSS_VERSION_PATCH</title>
67
 
<indexterm zone="GSS-VERSION-PATCH:CAPS"><primary>GSS_VERSION_PATCH</primary></indexterm>
68
 
<programlisting># define GSS_VERSION_PATCH 0
69
 
</programlisting>
70
 
<para>
71
 
Pre-processor symbol with a decimal value that describe the patch
72
 
level of the header file version number.  For example, when the
73
 
header version is 1.2.3 this symbol will be 3.</para>
74
 
</refsect2>
75
 
<refsect2 id="GSS-VERSION-NUMBER:CAPS" role="macro">
76
 
<title>GSS_VERSION_NUMBER</title>
77
 
<indexterm zone="GSS-VERSION-NUMBER:CAPS"><primary>GSS_VERSION_NUMBER</primary></indexterm>
78
 
<programlisting># define GSS_VERSION_NUMBER 0x010000
79
 
</programlisting>
80
 
<para>
81
 
Pre-processor symbol with a hexadecimal value describing the
82
 
header file version number.  For example, when the header version
83
 
is 1.2.3 this symbol will have the value 0x010203.</para>
84
 
</refsect2>
85
 
 
86
 
</refsect1>
87
 
 
88
 
</refentry>