[39f916fc] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY libidn-download-http "http://josefsson.org/libidn/releases/libidn-&libidn-version;.tar.gz">
|
---|
| 8 | <!ENTITY libidn-download-ftp "ftp://alpha.gnu.org/pub/gnu/libidn/libidn-&libidn-version;.tar.gz">
|
---|
[650e5ac] | 9 | <!ENTITY libidn-md5sum "d240631c93c7d3a0e93cdf66f536073f">
|
---|
| 10 | <!ENTITY libidn-size "2.1 MB">
|
---|
| 11 | <!ENTITY libidn-buildsize "18.4 MB">
|
---|
[39f916fc] | 12 | <!ENTITY libidn-time "0.2 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libidn" xreflabel="libidn-&libidn-version;">
|
---|
| 16 | <?dbhtml filename="libidn.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Libidn-&libidn-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="libidn">
|
---|
| 26 | <primary sortas="a-Libidn">Libidn</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Libidn</title>
|
---|
| 31 |
|
---|
| 32 | <para><application>Libidn</application> is a package designed for
|
---|
| 33 | internationalized string handling based on the <ulink
|
---|
| 34 | url="http://josefsson.org/cgi-bin/rfcmarkup?url=http://www.ietf.org/rfc/rfc3454.txt">
|
---|
| 35 | Stringprep</ulink>, <ulink
|
---|
| 36 | url="http://josefsson.org/cgi-bin/rfcmarkup?url=http://www.ietf.org/rfc/rfc3492.txt">
|
---|
| 37 | Punycode</ulink>, <ulink
|
---|
| 38 | url="http://josefsson.org/cgi-bin/rfcmarkup?url=http://www.ietf.org/rfc/rfc3490.txt">
|
---|
| 39 | IDNA</ulink> and <ulink
|
---|
| 40 | url="http://josefsson.org/cgi-bin/rfcmarkup?url=http://josefsson.org/cgi-bin/viewcvs.cgi/*checkout*/libidn/doc/specifications/draft-hoffman-idn-reg-02.txt">
|
---|
| 41 | TLD</ulink> specifications defined by the Internet Engineering Task Force
|
---|
| 42 | (IETF) Internationalized Domain Names (IDN) working group, used for
|
---|
| 43 | internationalized domain names. This is useful for converting data from the
|
---|
| 44 | system's native representation into UTF-8, transforming Unicode strings
|
---|
| 45 | into ASCII strings, allowing applications to use certain ASCII name labels
|
---|
| 46 | (beginning with a special prefix) to represent non-ASCII name labels, and
|
---|
| 47 | converting entire domain names to and from the ASCII Compatible Encoding
|
---|
| 48 | (ACE) form.</para>
|
---|
| 49 |
|
---|
| 50 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 51 | <itemizedlist spacing="compact">
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download (HTTP): <ulink url="&libidn-download-http;"/></para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download (FTP): <ulink url="&libidn-download-ftp;"/></para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Download MD5 sum: &libidn-md5sum;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Download size: &libidn-size;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>Estimated disk space required: &libidn-buildsize;</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>Estimated build time: &libidn-time;</para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">Libidn Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 75 | <para role="optional"><xref linkend="emacs"/>,
|
---|
| 76 | <xref linkend="pkgconfig"/>,
|
---|
| 77 | <xref linkend="gtk-doc"/>,
|
---|
| 78 | a Java compiler—one of (looked for in this order)
|
---|
[d08a78f] | 79 | <xref linkend="gcc"/> (for <command>gcj</command> and you must also have
|
---|
| 80 | the <ulink url="ftp://ftp.gnu.org/gnu/classpath/">gjdoc</ulink> package
|
---|
| 81 | installed),
|
---|
[39f916fc] | 82 | <ulink url="http://jikes.sourceforge.net/">Jikes</ulink> or
|
---|
| 83 | <xref linkend="jdk"/>,
|
---|
| 84 | and a C# compiler—<ulink
|
---|
| 85 | url="http://www.mono-project.com/Main_Page">Mono</ulink> or
|
---|
| 86 | <ulink url="http://www.southern-storm.com.au/portable_net.html">
|
---|
| 87 | DotGNU Portable.NET</ulink></para>
|
---|
| 88 |
|
---|
[1039de3] | 89 | <para condition="html" role="usernotes">User Notes:
|
---|
| 90 | <ulink url="&blfs-wiki;/libidn"/></para>
|
---|
| 91 |
|
---|
[39f916fc] | 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="installation">
|
---|
| 95 | <title>Installation of Libidn</title>
|
---|
| 96 |
|
---|
| 97 | <para>Install <application>Libidn</application> by running the following
|
---|
| 98 | commands:</para>
|
---|
| 99 |
|
---|
| 100 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 101 | make</userinput></screen>
|
---|
| 102 |
|
---|
[520f6b4f] | 103 | <para>If you have <xref linkend="tetex"/> installed and wish to create a
|
---|
[39f916fc] | 104 | text version of the documentation, issue the following commands:</para>
|
---|
| 105 |
|
---|
| 106 | <screen><userinput>cd doc &&
|
---|
| 107 | makeinfo --plaintext -o libidn.txt libidn.texi &&
|
---|
| 108 | cd ..</userinput></screen>
|
---|
| 109 |
|
---|
| 110 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 111 |
|
---|
| 112 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 113 |
|
---|
| 114 | <screen role="root"><userinput>make install &&
|
---|
| 115 | find doc -name "Makefile*" -exec rm {} \; &&
|
---|
| 116 |
|
---|
| 117 | install -v -m755 -d \
|
---|
| 118 | /usr/share/doc/libidn-&libidn-version;/{api,java,specifications,tld} &&
|
---|
| 119 | install -v -m644 doc/components* \
|
---|
| 120 | doc/libidn.{pdf,ps,html} \
|
---|
| 121 | /usr/share/doc/libidn-&libidn-version; &&
|
---|
| 122 | install -v -m644 doc/reference/html/* \
|
---|
| 123 | /usr/share/doc/libidn-&libidn-version;/api &&
|
---|
| 124 | install -v -m644 doc/specifications/* \
|
---|
| 125 | /usr/share/doc/libidn-&libidn-version;/specifications &&
|
---|
| 126 | install -v -m644 doc/tld/* /usr/share/doc/libidn-&libidn-version;/tld &&
|
---|
| 127 | cp -v -R doc/java/* /usr/share/doc/libidn-&libidn-version;/java</userinput></screen>
|
---|
| 128 |
|
---|
| 129 | <para>If you created the text documentation, install it using the following
|
---|
| 130 | command as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 131 |
|
---|
| 132 | <screen role="root"><userinput>install -v -m644 doc/libidn.txt /usr/share/doc/libidn-&libidn-version;</userinput></screen>
|
---|
| 133 |
|
---|
| 134 | </sect2>
|
---|
| 135 |
|
---|
[56ce09e] | 136 | <sect2 role="commands">
|
---|
| 137 | <title>Command Explanations</title>
|
---|
| 138 |
|
---|
| 139 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
| 140 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 141 |
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
[39f916fc] | 144 | <sect2 role="content">
|
---|
| 145 | <title>Contents</title>
|
---|
| 146 |
|
---|
| 147 | <segmentedlist>
|
---|
| 148 | <segtitle>Installed Program</segtitle>
|
---|
| 149 | <segtitle>Installed Libraries</segtitle>
|
---|
| 150 | <segtitle>Installed Directory</segtitle>
|
---|
| 151 |
|
---|
| 152 | <seglistitem>
|
---|
| 153 | <seg>idn</seg>
|
---|
[1039de3] | 154 | <seg>libidn.{so,a} and optionally, Java and C# modules</seg>
|
---|
[39f916fc] | 155 | <seg>/usr/share/doc/libidn-&libidn-version;</seg>
|
---|
| 156 | </seglistitem>
|
---|
| 157 | </segmentedlist>
|
---|
| 158 |
|
---|
| 159 | <variablelist>
|
---|
| 160 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 161 | <?dbfo list-presentation="list"?>
|
---|
| 162 | <?dbhtml list-presentation="table"?>
|
---|
| 163 |
|
---|
| 164 | <varlistentry id="idn">
|
---|
| 165 | <term><command>idn</command></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>is a command line interface to the internationalized domain
|
---|
| 168 | name library.</para>
|
---|
| 169 | <indexterm zone="libidn idn">
|
---|
| 170 | <primary sortas="b-idn">idn</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="libidn-lib">
|
---|
[1039de3] | 176 | <term><filename class='libraryfile'>libidn.{so,a}</filename></term>
|
---|
[39f916fc] | 177 | <listitem>
|
---|
| 178 | <para> contains a generic Stringprep implementation that does Unicode
|
---|
| 179 | 3.2 NFKC normalization, mapping and prohibitation of characters, and
|
---|
| 180 | bidirectional character handling. Profiles for Nameprep, iSCSI, SASL
|
---|
| 181 | and XMPP are included as well as support for Punycode and ASCII
|
---|
| 182 | Compatible Encoding (ACE) via IDNA. A mechanism to define Top-Level
|
---|
| 183 | Domain (TLD) specific validation tables, and to compare strings
|
---|
| 184 | against those tables, as well as default tables for some TLDs are
|
---|
| 185 | included.</para>
|
---|
| 186 | <indexterm zone="libidn libidn-lib">
|
---|
[1039de3] | 187 | <primary sortas="c-libidn">libidn.{so,a}</primary>
|
---|
[39f916fc] | 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | </variablelist>
|
---|
| 193 |
|
---|
| 194 | </sect2>
|
---|
| 195 |
|
---|
| 196 | </sect1>
|
---|