[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[39f916fc] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY libidn-download-http "&gnu-http;/libidn/libidn-&libidn-version;.tar.gz">
|
---|
[e1e58be] | 8 | <!ENTITY libidn-download-ftp " ">
|
---|
[6028d74] | 9 | <!ENTITY libidn-md5sum "fe061a95ae23979150a692d102dce4ad">
|
---|
[156e188] | 10 | <!ENTITY libidn-size "2.5 MB">
|
---|
[6028d74] | 11 | <!ENTITY libidn-buildsize "19 MB (with tests)">
|
---|
[d233271a] | 12 | <!ENTITY libidn-time "0.2 SBU (with tests)">
|
---|
[39f916fc] | 13 | ]>
|
---|
| 14 |
|
---|
[4049d110] | 15 | <sect1 id="libidn" xreflabel="libidn-&libidn-version;">
|
---|
[39f916fc] | 16 | <?dbhtml filename="libidn.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[4049d110] | 19 | <title>libidn-&libidn-version;</title>
|
---|
[39f916fc] | 20 |
|
---|
| 21 | <indexterm zone="libidn">
|
---|
[e355d777] | 22 | <primary sortas="a-libidn">libidn</primary>
|
---|
[39f916fc] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[4049d110] | 26 | <title>Introduction to libidn</title>
|
---|
[e355d777] | 27 |
|
---|
| 28 | <para>
|
---|
[4049d110] | 29 | <application>libidn</application> is a package designed for
|
---|
[0d7900a] | 30 | internationalized string handling based on the
|
---|
[36aab55] | 31 | <ulink url="https://www.ietf.org/rfc/rfc3454.txt">Stringprep</ulink>,
|
---|
| 32 | <ulink url="https://www.ietf.org/rfc/rfc3492.txt">Punycode</ulink> and
|
---|
| 33 | <ulink url="https://www.ietf.org/rfc/rfc3490.txt">IDNA</ulink>
|
---|
[e355d777] | 34 | specifications defined by the Internet Engineering Task Force
|
---|
| 35 | (IETF) Internationalized Domain Names (IDN) working group, used for
|
---|
| 36 | internationalized domain names. This is useful for converting data from the
|
---|
| 37 | system's native representation into UTF-8, transforming Unicode strings
|
---|
| 38 | into ASCII strings, allowing applications to use certain ASCII name labels
|
---|
| 39 | (beginning with a special prefix) to represent non-ASCII name labels, and
|
---|
| 40 | converting entire domain names to and from the ASCII Compatible Encoding
|
---|
| 41 | (ACE) form.
|
---|
| 42 | </para>
|
---|
[39f916fc] | 43 |
|
---|
[09ddf35a] | 44 | &lfs122_checked;
|
---|
[bfa45ca] | 45 |
|
---|
[39f916fc] | 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
| 48 | <listitem>
|
---|
[4049d110] | 49 | <para>
|
---|
| 50 | Download (HTTP): <ulink url="&libidn-download-http;"/>
|
---|
| 51 | </para>
|
---|
[39f916fc] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[4049d110] | 54 | <para>
|
---|
| 55 | Download (FTP): <ulink url="&libidn-download-ftp;"/>
|
---|
| 56 | </para>
|
---|
[39f916fc] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[4049d110] | 59 | <para>
|
---|
| 60 | Download MD5 sum: &libidn-md5sum;
|
---|
| 61 | </para>
|
---|
[39f916fc] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[4049d110] | 64 | <para>
|
---|
| 65 | Download size: &libidn-size;
|
---|
| 66 | </para>
|
---|
[39f916fc] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[4049d110] | 69 | <para>
|
---|
| 70 | Estimated disk space required: &libidn-buildsize;
|
---|
| 71 | </para>
|
---|
[39f916fc] | 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
[4049d110] | 74 | <para>
|
---|
| 75 | Estimated build time: &libidn-time;
|
---|
| 76 | </para>
|
---|
[39f916fc] | 77 | </listitem>
|
---|
| 78 | </itemizedlist>
|
---|
| 79 |
|
---|
[4049d110] | 80 | <bridgehead renderas="sect3">libidn Dependencies</bridgehead>
|
---|
[39f916fc] | 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e355d777] | 83 | <para role="optional">
|
---|
| 84 | <xref linkend="emacs"/>,
|
---|
| 85 | <xref linkend="gtk-doc"/>,
|
---|
[49b50d4] | 86 | <xref linkend="openjdk"/>,
|
---|
[a65d410] | 87 | <xref linkend="valgrind"/>, and
|
---|
[36aab55] | 88 | <ulink url="https://www.mono-project.com/">Mono</ulink>
|
---|
[e355d777] | 89 | </para>
|
---|
[39f916fc] | 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
[4049d110] | 94 | <title>Installation of libidn</title>
|
---|
[39f916fc] | 95 |
|
---|
[e355d777] | 96 | <para>
|
---|
[4049d110] | 97 | Install <application>libidn</application> by running the following
|
---|
[e355d777] | 98 | commands:
|
---|
| 99 | </para>
|
---|
[39f916fc] | 100 |
|
---|
[e355d777] | 101 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[39f916fc] | 102 | make</userinput></screen>
|
---|
| 103 |
|
---|
[e355d777] | 104 | <para>
|
---|
[dac6007] | 105 | To test the results, run:
|
---|
[e355d777] | 106 | </para>
|
---|
[39f916fc] | 107 |
|
---|
[dac6007] | 108 | <screen remap="test"><userinput>pushd tests &&
|
---|
| 109 | make check &&
|
---|
| 110 | popd </userinput></screen>
|
---|
| 111 |
|
---|
[e355d777] | 112 | <para>
|
---|
| 113 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 114 | </para>
|
---|
[39f916fc] | 115 |
|
---|
| 116 | <screen role="root"><userinput>make install &&
|
---|
| 117 |
|
---|
[3e65ee44] | 118 | find doc -name "Makefile*" -delete &&
|
---|
[e355d777] | 119 | rm -rf -v doc/{gdoc,idn.1,stamp-vti,man,texi} &&
|
---|
[3e65ee44] | 120 | mkdir -v /usr/share/doc/libidn-&libidn-version; &&
|
---|
[e355d777] | 121 | cp -r -v doc/* /usr/share/doc/libidn-&libidn-version;</userinput></screen>
|
---|
[39f916fc] | 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
[56ce09e] | 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
[06be400] | 127 |
|
---|
[e05cd03f] | 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[e355d777] | 129 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 130 |
|
---|
| 131 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 132 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[56ce09e] | 133 |
|
---|
[404b72a] | 134 | <para>
|
---|
| 135 | <option>--enable-java</option>: Use this switch to enable building
|
---|
| 136 | the Java implementation of <application>libidn</application>. Note that
|
---|
| 137 | <xref linkend="openjdk"/> must be installed to use this option.
|
---|
| 138 | </para>
|
---|
| 139 |
|
---|
[56ce09e] | 140 | </sect2>
|
---|
| 141 |
|
---|
[39f916fc] | 142 | <sect2 role="content">
|
---|
| 143 | <title>Contents</title>
|
---|
| 144 |
|
---|
| 145 | <segmentedlist>
|
---|
| 146 | <segtitle>Installed Program</segtitle>
|
---|
[e355d777] | 147 | <segtitle>Installed Library</segtitle>
|
---|
| 148 | <segtitle>Installed Directories</segtitle>
|
---|
[39f916fc] | 149 |
|
---|
| 150 | <seglistitem>
|
---|
[e355d777] | 151 | <seg>
|
---|
| 152 | idn
|
---|
| 153 | </seg>
|
---|
| 154 | <seg>
|
---|
| 155 | libidn.so
|
---|
| 156 | </seg>
|
---|
| 157 | <seg>
|
---|
| 158 | /usr/share/doc/libidn-&libidn-version; and
|
---|
| 159 | /usr/share/gtk-doc/html/libidn
|
---|
| 160 | </seg>
|
---|
[39f916fc] | 161 | </seglistitem>
|
---|
| 162 | </segmentedlist>
|
---|
| 163 |
|
---|
| 164 | <variablelist>
|
---|
| 165 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 166 | <?dbfo list-presentation="list"?>
|
---|
| 167 | <?dbhtml list-presentation="table"?>
|
---|
| 168 |
|
---|
| 169 | <varlistentry id="idn">
|
---|
| 170 | <term><command>idn</command></term>
|
---|
| 171 | <listitem>
|
---|
[e355d777] | 172 | <para>
|
---|
| 173 | is a command line interface to the internationalized domain
|
---|
[4c24eb0a] | 174 | name library
|
---|
[e355d777] | 175 | </para>
|
---|
[39f916fc] | 176 | <indexterm zone="libidn idn">
|
---|
| 177 | <primary sortas="b-idn">idn</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 | </listitem>
|
---|
| 180 | </varlistentry>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="libidn-lib">
|
---|
[4c24eb0a] | 183 | <term><filename class="libraryfile">libidn.so</filename></term>
|
---|
[39f916fc] | 184 | <listitem>
|
---|
[e355d777] | 185 | <para>
|
---|
| 186 | contains a generic Stringprep implementation that does Unicode
|
---|
| 187 | 3.2 NFKC normalization, mapping and prohibition of characters, and
|
---|
| 188 | bidirectional character handling. Profiles for Nameprep, iSCSI, SASL
|
---|
| 189 | and XMPP are included as well as support for Punycode and ASCII
|
---|
| 190 | Compatible Encoding (ACE) via IDNA. A mechanism to define Top-Level
|
---|
| 191 | Domain (TLD) specific validation tables, and to compare strings
|
---|
| 192 | against those tables, as well as default tables for some TLDs are
|
---|
[4c24eb0a] | 193 | included
|
---|
[e355d777] | 194 | </para>
|
---|
[39f916fc] | 195 | <indexterm zone="libidn libidn-lib">
|
---|
[e355d777] | 196 | <primary sortas="c-libidn">libidn.so</primary>
|
---|
[39f916fc] | 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | </variablelist>
|
---|
| 202 |
|
---|
| 203 | </sect2>
|
---|
| 204 |
|
---|
| 205 | </sect1>
|
---|