summaryrefslogtreecommitdiff
path: root/doc/libunistring_16.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libunistring_16.html')
-rw-r--r--doc/libunistring_16.html74
1 files changed, 44 insertions, 30 deletions
diff --git a/doc/libunistring_16.html b/doc/libunistring_16.html
index 9e94295b..39f70977 100644
--- a/doc/libunistring_16.html
+++ b/doc/libunistring_16.html
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
-<!-- Created on October, 16 2022 by texi2html 1.78a -->
+<!-- Created on February, 24 2024 by texi2html 1.78a -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
@@ -42,8 +42,8 @@ ul.toc {list-style: none}
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="libunistring_15.html#SEC73" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
-<td valign="middle" align="left">[<a href="libunistring_17.html#SEC80" title="Next chapter"> &gt;&gt; </a>]</td>
+<tr><td valign="middle" align="left">[<a href="libunistring_15.html#SEC75" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
+<td valign="middle" align="left">[<a href="libunistring_17.html#SEC82" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
@@ -51,14 +51,14 @@ ul.toc {list-style: none}
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="libunistring_21.html#SEC92" title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="libunistring_21.html#SEC94" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<hr size="2">
<a name="Using-the-library"></a>
-<a name="SEC74"></a>
-<h1 class="chapter"> <a href="libunistring_toc.html#TOC74">16. Using the library</a> </h1>
+<a name="SEC76"></a>
+<h1 class="chapter"> <a href="libunistring_toc.html#TOC76">16. Using the library</a> </h1>
<p>This chapter explains some practical considerations, regarding the
installation and compiler options that are needed in order to use this
@@ -67,22 +67,22 @@ library.
<hr size="6">
<a name="Installation"></a>
-<a name="SEC75"></a>
-<h2 class="section"> <a href="libunistring_toc.html#TOC75">16.1 Installation</a> </h2>
+<a name="SEC77"></a>
+<h2 class="section"> <a href="libunistring_toc.html#TOC77">16.1 Installation</a> </h2>
<p>Before you can use the library, it must be installed. First, you have to
make sure all dependencies are installed. They are listed in the file
&lsquo;<tt>DEPENDENCIES</tt>&rsquo;.
</p>
-<a name="IDX965"></a>
+<a name="IDX983"></a>
<p>Then you can proceed to build and install the library, as described in the
file &lsquo;<tt>INSTALL</tt>&rsquo;. For installation on Windows systems, please refer to
the file &lsquo;<tt>INSTALL.windows</tt>&rsquo;.
</p>
<hr size="6">
<a name="Compiler-options"></a>
-<a name="SEC76"></a>
-<h2 class="section"> <a href="libunistring_toc.html#TOC76">16.2 Compiler options</a> </h2>
+<a name="SEC78"></a>
+<h2 class="section"> <a href="libunistring_toc.html#TOC78">16.2 Compiler options</a> </h2>
<p>Let's denote as <code>LIBUNISTRING_PREFIX</code> the value of the &lsquo;<samp>--prefix</samp>&rsquo;
option that you passed to <code>configure</code> while installing this package.
@@ -103,7 +103,7 @@ in 64-bit mode on a 64-bit GNU/Linux system that supports executables
in either 64-bit mode or 32-bit mode, you should have used the option
<code>--libdir=${LIBUNISTRING_PREFIX}/lib64</code>.
</p>
-<a name="IDX966"></a>
+<a name="IDX984"></a>
<p>So that the compiler finds the include files, you have to pass it the
option <code>-I${LIBUNISTRING_INCLUDEDIR}</code>.
</p>
@@ -111,13 +111,13 @@ option <code>-I${LIBUNISTRING_INCLUDEDIR}</code>.
to pass it the options <code>-L${LIBUNISTRING_LIBDIR} -lunistring</code>.
On some systems, in some configurations, you also have to pass options
needed for linking with <code>libiconv</code>. The autoconf macro
-<code>gl_LIBUNISTRING</code> (see <a href="#SEC78">Autoconf macro</a>) deals with this
+<code>gl_LIBUNISTRING</code> (see <a href="#SEC80">Autoconf macro</a>) deals with this
particularity.
</p>
<hr size="6">
<a name="Include-files"></a>
-<a name="SEC77"></a>
-<h2 class="section"> <a href="libunistring_toc.html#TOC77">16.3 Include files</a> </h2>
+<a name="SEC79"></a>
+<h2 class="section"> <a href="libunistring_toc.html#TOC79">16.3 Include files</a> </h2>
<p>Most of the include files have been presented in the introduction, see
<a href="libunistring_1.html#SEC1">Introduction</a>, and subsequent detailed chapters.
@@ -127,20 +127,22 @@ version number of the libunistring library.
</p>
<dl>
<dt><u>Macro:</u> int <b>_LIBUNISTRING_VERSION</b>
-<a name="IDX967"></a>
+<a name="IDX985"></a>
</dt>
<dd><p>This constant contains the version of libunistring that is being used
-at compile time. It encodes the major and minor parts of the version
-number only. These parts are encoded in the form <code>(major&lt;&lt;8) + minor</code>.
+at compile time.
+It encodes the major, minor, and subminor parts of the version number.
+These parts are encoded in the form <code>(major&lt;&lt;16) + (minor&lt;&lt;8) + subminor</code>.
</p></dd></dl>
<dl>
<dt><u>Constant:</u> int <b>_libunistring_version</b>
-<a name="IDX968"></a>
+<a name="IDX986"></a>
</dt>
<dd><p>This constant contains the version of libunistring that is being used
-at run time. It encodes the major and minor parts of the version
-number only. These parts are encoded in the form <code>(major&lt;&lt;8) + minor</code>.
+at run time.
+It encodes the major, minor, and subminor parts of the version number.
+These parts are encoded in the form <code>(major&lt;&lt;16) + (minor&lt;&lt;8) + subminor</code>.
</p></dd></dl>
<p>It is possible that <code>_libunistring_version</code> is greater than
@@ -149,17 +151,29 @@ number only. These parts are encoded in the form <code>(major&lt;&lt;8) + minor
backward-compatible version has been installed after your program
that uses <code>libunistring</code> was installed.
</p>
+<p><code>&lt;unistring/version.h&gt;</code> also contains:
+</p>
+<dl>
+<dt><u>Constant:</u> int <b>_libunistring_unicode_version</b>
+<a name="IDX987"></a>
+</dt>
+<dd><p>This constant contains the version of the Unicode standard that is
+implemented by libunistring.
+It encodes the major and minor parts of the version number only.
+These parts are encoded in the form <code>(major&lt;&lt;8) + minor</code>.
+</p></dd></dl>
+
<hr size="6">
<a name="Autoconf-macro"></a>
-<a name="SEC78"></a>
-<h2 class="section"> <a href="libunistring_toc.html#TOC78">16.4 Autoconf macro</a> </h2>
+<a name="SEC80"></a>
+<h2 class="section"> <a href="libunistring_toc.html#TOC80">16.4 Autoconf macro</a> </h2>
<p>GNU Gnulib provides an autoconf macro that tests for the availability
of <code>libunistring</code>. It is contained in the Gnulib module
&lsquo;<samp>libunistring</samp>&rsquo;, see
<a href="https://www.gnu.org/software/gnulib/MODULES.html#module=libunistring">https://www.gnu.org/software/gnulib/MODULES.html#module=libunistring</a>.
</p>
-<a name="IDX969"></a>
+<a name="IDX988"></a>
<p>The macro is called <code>gl_LIBUNISTRING</code>. It searches for an installed
libunistring. If found, it sets and AC_SUBSTs <code>HAVE_LIBUNISTRING=yes</code>
and the <code>LIBUNISTRING</code> and <code>LTLIBUNISTRING</code> variables and augments
@@ -191,8 +205,8 @@ on most systems.
<hr size="6">
<a name="Reporting-problems"></a>
-<a name="SEC79"></a>
-<h2 class="section"> <a href="libunistring_toc.html#TOC79">16.5 Reporting problems</a> </h2>
+<a name="SEC81"></a>
+<h2 class="section"> <a href="libunistring_toc.html#TOC81">16.5 Reporting problems</a> </h2>
<p>If you encounter any problem, please don't hesitate to submit a detailed
bug report either in the bug tracker at the project page
@@ -209,8 +223,8 @@ a description of the options that you passed to the &lsquo;<samp>configure</samp
</p>
<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#SEC74" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
-<td valign="middle" align="left">[<a href="libunistring_17.html#SEC80" title="Next chapter"> &gt;&gt; </a>]</td>
+<tr><td valign="middle" align="left">[<a href="#SEC76" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
+<td valign="middle" align="left">[<a href="libunistring_17.html#SEC82" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
@@ -218,12 +232,12 @@ a description of the options that you passed to the &lsquo;<samp>configure</samp
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="libunistring_21.html#SEC92" title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="libunistring_21.html#SEC94" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
<font size="-1">
- This document was generated by <em>Bruno Haible</em> on <em>October, 16 2022</em> using <a href="https://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>.
+ This document was generated by <em>Bruno Haible</em> on <em>February, 24 2024</em> using <a href="https://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>.
</font>
<br>