[9766fba] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[9766fba] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[fcc9145] | 7 | <!ENTITY tidy-download-http "&sources-anduin-http;/t/tidy-&tidy-version;.tar.bz2">
|
---|
[b852852] | 8 | <!ENTITY tidy-download-ftp " ">
|
---|
[4d14847d] | 9 | <!ENTITY tidy-md5sum "dd1fe109b4259ad3f364b175787ad5e9">
|
---|
| 10 | <!ENTITY tidy-size "807 KB">
|
---|
[f3eefa7] | 11 | <!ENTITY tidy-buildsize "12 MB">
|
---|
[0124b3a] | 12 | <!ENTITY tidy-time "0.2 SBU">
|
---|
[9766fba] | 13 | ]>
|
---|
| 14 |
|
---|
[0fb1ed2] | 15 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
[c18d3b25] | 16 | <?dbhtml filename="tidy.html"?>
|
---|
[85965ed] | 17 |
|
---|
[c18d3b25] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[85965ed] | 22 |
|
---|
[c18d3b25] | 23 | <title>HTML Tidy-&tidy-version;</title>
|
---|
[85965ed] | 24 |
|
---|
[c18d3b25] | 25 | <indexterm zone="html-tidy">
|
---|
| 26 | <primary sortas="a-HTML-Tidy">HTML Tidy</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to HTML Tidy</title>
|
---|
[85965ed] | 31 |
|
---|
[8d77de6] | 32 | <para>The <application>HTML Tidy</application> package contains a
|
---|
[f6ec478] | 33 | command line tool and libraries used to read HTML, XHTML and XML files
|
---|
| 34 | and write cleaned up markup. It detects and corrects many common coding
|
---|
[8d77de6] | 35 | errors and strives to produce visually equivalent markup that is both
|
---|
[c18d3b25] | 36 | W3C compliant and compatible with most browsers.</para>
|
---|
[85965ed] | 37 |
|
---|
[7d68b92] | 38 | &lfs77_checked;
|
---|
[50929e8] | 39 |
|
---|
[c18d3b25] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download MD5 sum: &tidy-md5sum;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download size: &tidy-size;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated disk space required: &tidy-buildsize;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated build time: &tidy-time;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
| 61 |
|
---|
[b852852] | 62 | <para><application>HTML Tidy</application> tarballs are no longer generated
|
---|
| 63 | by the maintainers. To build from source, the
|
---|
| 64 | <application>HTML Tidy</application> developers recommend using current
|
---|
| 65 | CVS. The source tarball shown above was created by the BLFS team by pulling
|
---|
[4d14847d] | 66 | a CVS version, then generating the autotool components and documentation.
|
---|
| 67 | BLFS made no changes to the existing source files.</para>
|
---|
[b852852] | 68 |
|
---|
[c18d3b25] | 69 | <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
|
---|
[85965ed] | 70 |
|
---|
[c18d3b25] | 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[52d50d5] | 72 | <para role="optional"><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
[85965ed] | 73 |
|
---|
[1039de3] | 74 | <para condition="html" role="usernotes">User Notes:
|
---|
| 75 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
| 76 |
|
---|
[c18d3b25] | 77 | </sect2>
|
---|
[85965ed] | 78 |
|
---|
[c18d3b25] | 79 | <sect2 role="installation">
|
---|
| 80 | <title>Installation of HTML Tidy</title>
|
---|
| 81 |
|
---|
[8d77de6] | 82 | <para>Install <application>HTML Tidy</application> by
|
---|
[c18d3b25] | 83 | running the following commands:</para>
|
---|
| 84 |
|
---|
[22d9f68] | 85 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[c18d3b25] | 86 | make</userinput></screen>
|
---|
[afd6889] | 87 |
|
---|
[f3eefa7] | 88 | <para>This package does not come with a test suite.</para>
|
---|
| 89 | <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
|
---|
[7c43113] | 90 |
|
---|
[c18d3b25] | 91 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[85965ed] | 92 |
|
---|
[f3eefa7] | 93 | <screen role="root"><userinput>make install &&
|
---|
[0124b3a] | 94 |
|
---|
[f3eefa7] | 95 | install -v -m644 -D htmldoc/tidy.1 \
|
---|
[a41f643] | 96 | /usr/share/man/man1/tidy.1 &&
|
---|
[f3eefa7] | 97 | install -v -m755 -d /usr/share/doc/tidy-&tidy-version; &&
|
---|
| 98 | install -v -m644 htmldoc/*.{html,gif,css} \
|
---|
| 99 | /usr/share/doc/tidy-&tidy-version;</userinput></screen>
|
---|
[b852852] | 100 |
|
---|
[f3eefa7] | 101 | <para>If you wish to install the API documentation you must have
|
---|
| 102 | <xref linkend="doxygen"/> installed, then change directories into the
|
---|
| 103 | <filename class='directory'>htmldoc</filename> of the source tree and
|
---|
| 104 | issue the command <command>doxygen</command>. Then as the
|
---|
| 105 | <systemitem class="username">root</systemitem> user copy
|
---|
| 106 | the <filename class='directory'>api</filename> directory to
|
---|
| 107 | <filename class='directory'>/usr/share/doc/tidy-&tidy-version;.</filename></para>
|
---|
| 108 |
|
---|
[c18d3b25] | 109 | </sect2>
|
---|
[85965ed] | 110 |
|
---|
[22d9f68] | 111 | <sect2 role="commands">
|
---|
| 112 | <title>Command Explanations</title>
|
---|
| 113 |
|
---|
| 114 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 115 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 116 |
|
---|
| 117 | </sect2>
|
---|
| 118 |
|
---|
[c18d3b25] | 119 | <sect2 role="configuration">
|
---|
| 120 | <title>Configuring HTML Tidy</title>
|
---|
| 121 |
|
---|
| 122 | <sect3>
|
---|
| 123 | <title>Config Files</title>
|
---|
[85965ed] | 124 |
|
---|
[8d77de6] | 125 | <para>The absolute path of the file specified in
|
---|
[c18d3b25] | 126 | <envar>$HTML_TIDY</envar>.</para>
|
---|
[85965ed] | 127 |
|
---|
[c18d3b25] | 128 | </sect3>
|
---|
| 129 |
|
---|
| 130 | <sect3>
|
---|
| 131 | <title>Configuration Information</title>
|
---|
[85965ed] | 132 |
|
---|
[8d77de6] | 133 | <para>The default configuration options can be set in the file defined in
|
---|
[f6ec478] | 134 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
| 135 | to <command>tidy</command> via command line parameters or the
|
---|
[c18d3b25] | 136 | <option>-config <file></option> parameter.</para>
|
---|
[85965ed] | 137 |
|
---|
[c18d3b25] | 138 | </sect3>
|
---|
[85965ed] | 139 |
|
---|
[c18d3b25] | 140 | </sect2>
|
---|
[85965ed] | 141 |
|
---|
[c18d3b25] | 142 | <sect2 role="content">
|
---|
| 143 | <title>Contents</title>
|
---|
| 144 |
|
---|
| 145 | <segmentedlist>
|
---|
| 146 | <segtitle>Installed Programs</segtitle>
|
---|
| 147 | <segtitle>Installed Library</segtitle>
|
---|
| 148 | <segtitle>Installed Directory</segtitle>
|
---|
| 149 | <seglistitem>
|
---|
| 150 | <seg>tab2space and tidy</seg>
|
---|
[22d9f68] | 151 | <seg>libtidy.so</seg>
|
---|
[f3eefa7] | 152 | <seg>/usr/share/doc/tidy-&tidy-version;</seg>
|
---|
[c18d3b25] | 153 | </seglistitem>
|
---|
| 154 | </segmentedlist>
|
---|
[85965ed] | 155 |
|
---|
[c18d3b25] | 156 | <variablelist>
|
---|
| 157 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 158 | <?dbfo list-presentation="list"?>
|
---|
| 159 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 160 |
|
---|
[c18d3b25] | 161 | <varlistentry id="tab2space">
|
---|
| 162 | <term><command>tab2space</command></term>
|
---|
| 163 | <listitem>
|
---|
[8d77de6] | 164 | <para>is a utility to expand tabs and ensure consistent line
|
---|
[c18d3b25] | 165 | endings.</para>
|
---|
| 166 | <indexterm zone="html-tidy tab2space">
|
---|
| 167 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 168 | </indexterm>
|
---|
| 169 | </listitem>
|
---|
| 170 | </varlistentry>
|
---|
[85965ed] | 171 |
|
---|
[c18d3b25] | 172 | <varlistentry id="tidy">
|
---|
| 173 | <term><command>tidy</command></term>
|
---|
| 174 | <listitem>
|
---|
| 175 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
| 176 | <indexterm zone="html-tidy tidy">
|
---|
| 177 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 | </listitem>
|
---|
| 180 | </varlistentry>
|
---|
[85965ed] | 181 |
|
---|
[c18d3b25] | 182 | <varlistentry id="libtidy">
|
---|
[22d9f68] | 183 | <term><filename class='libraryfile'>libtidy.so</filename></term>
|
---|
[c18d3b25] | 184 | <listitem>
|
---|
[22d9f68] | 185 | <para>library provides the <application>HTML Tidy</application> API
|
---|
[8d77de6] | 186 | functions to <command>tidy</command> and can also be called by other
|
---|
[c18d3b25] | 187 | programs.</para>
|
---|
| 188 | <indexterm zone="html-tidy libtidy">
|
---|
[22d9f68] | 189 | <primary sortas="c-libtidy">libtidy.so</primary>
|
---|
[c18d3b25] | 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
[85965ed] | 193 |
|
---|
[c18d3b25] | 194 | </variablelist>
|
---|
| 195 |
|
---|
| 196 | </sect2>
|
---|
[9766fba] | 197 |
|
---|
| 198 | </sect1>
|
---|