[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 |
|
---|
[b852852] | 7 | <!ENTITY tidy-download-http "&files-anduin;/sources/tidy-&tidy-version;.tar.bz2">
|
---|
| 8 | <!ENTITY tidy-download-ftp " ">
|
---|
| 9 | <!ENTITY tidy-md5sum "468bfaa5cf917a8ecbe7834c13a61376">
|
---|
| 10 | <!ENTITY tidy-size "872 KB">
|
---|
| 11 | <!ENTITY tidy-buildsize "15 MB">
|
---|
[0124b3a] | 12 | <!ENTITY tidy-time "0.2 SBU">
|
---|
| 13 |
|
---|
[f6ec478] | 14 | <!ENTITY tidy-docs-version "051020">
|
---|
[0124b3a] | 15 | <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs_&tidy-docs-version;.tgz">
|
---|
[f6ec478] | 16 | <!ENTITY tidy-docs-md5sum "86de2f198e57399c063d2567b2a25628">
|
---|
[0124b3a] | 17 | <!ENTITY tidy-docs-size "150 KB">
|
---|
[9766fba] | 18 | ]>
|
---|
| 19 |
|
---|
[0fb1ed2] | 20 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
[c18d3b25] | 21 | <?dbhtml filename="tidy.html"?>
|
---|
[85965ed] | 22 |
|
---|
[c18d3b25] | 23 | <sect1info>
|
---|
| 24 | <othername>$LastChangedBy$</othername>
|
---|
| 25 | <date>$Date$</date>
|
---|
| 26 | </sect1info>
|
---|
[85965ed] | 27 |
|
---|
[c18d3b25] | 28 | <title>HTML Tidy-&tidy-version;</title>
|
---|
[85965ed] | 29 |
|
---|
[c18d3b25] | 30 | <indexterm zone="html-tidy">
|
---|
| 31 | <primary sortas="a-HTML-Tidy">HTML Tidy</primary>
|
---|
| 32 | </indexterm>
|
---|
| 33 |
|
---|
| 34 | <sect2 role="package">
|
---|
| 35 | <title>Introduction to HTML Tidy</title>
|
---|
[85965ed] | 36 |
|
---|
[8d77de6] | 37 | <para>The <application>HTML Tidy</application> package contains a
|
---|
[f6ec478] | 38 | command line tool and libraries used to read HTML, XHTML and XML files
|
---|
| 39 | and write cleaned up markup. It detects and corrects many common coding
|
---|
[8d77de6] | 40 | errors and strives to produce visually equivalent markup that is both
|
---|
[c18d3b25] | 41 | W3C compliant and compatible with most browsers.</para>
|
---|
[85965ed] | 42 |
|
---|
[c18d3b25] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: &tidy-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: &tidy-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: &tidy-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: &tidy-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
[b852852] | 65 | <para><application>HTML Tidy</application> tarballs are no longer generated
|
---|
| 66 | by the maintainers. To build from source, the
|
---|
| 67 | <application>HTML Tidy</application> developers recommend using current
|
---|
| 68 | CVS. The source tarball shown above was created by the BLFS team by pulling
|
---|
| 69 | a CVS version and generating the autotool components. BLFS made no changes
|
---|
| 70 | to the existing source files.</para>
|
---|
| 71 |
|
---|
[eab7aae5] | 72 | <!-- <note>
|
---|
[8d77de6] | 73 | <para><application>HTML Tidy</application> is
|
---|
| 74 | updated very frequently by its maintainers, and the source package listed
|
---|
| 75 | above may not be available at the listed URL due to the
|
---|
[f6ec478] | 76 | release of a newer version. The most current source package can be always
|
---|
| 77 | be downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If
|
---|
| 78 | this version is newer than the version listed above, the following
|
---|
| 79 | instructions should work, but have not yet been tested by the BLFS team.
|
---|
| 80 | If you'd rather download the version listed above, you can find it at
|
---|
[c18d3b25] | 81 | <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para>
|
---|
[eab7aae5] | 82 | </note> -->
|
---|
[85965ed] | 83 |
|
---|
[b852852] | 84 | <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead> -->
|
---|
[85965ed] | 85 |
|
---|
[b852852] | 86 | <!-- <bridgehead renderas="sect4">Documentation</bridgehead>
|
---|
[c18d3b25] | 87 | <itemizedlist spacing="compact">
|
---|
| 88 | <listitem>
|
---|
| 89 | <para>Documentation: <ulink url="&tidy-docs-download;"/></para>
|
---|
| 90 | </listitem>
|
---|
| 91 | <listitem>
|
---|
| 92 | <para>Download MD5 sum: &tidy-docs-md5sum;</para>
|
---|
| 93 | </listitem>
|
---|
| 94 | <listitem>
|
---|
| 95 | <para>Download size: &tidy-docs-size;</para>
|
---|
| 96 | </listitem>
|
---|
[b852852] | 97 | </itemizedlist> -->
|
---|
[85965ed] | 98 |
|
---|
[b852852] | 99 | <!-- <bridgehead renderas="sect4">Patches</bridgehead>
|
---|
[c18d3b25] | 100 | <itemizedlist spacing="compact">
|
---|
| 101 | <listitem>
|
---|
[8d77de6] | 102 | <para>Required patch: <ulink
|
---|
[c18d3b25] | 103 | url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
|
---|
| 104 | </listitem>
|
---|
[b852852] | 105 | </itemizedlist> -->
|
---|
[85965ed] | 106 |
|
---|
[c18d3b25] | 107 | <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
|
---|
[85965ed] | 108 |
|
---|
[b852852] | 109 | <!-- <bridgehead renderas="sect4">Recommended (To Build the Man Page and Quick
|
---|
[0124b3a] | 110 | Reference Docs)</bridgehead>
|
---|
[b852852] | 111 | <para role="recommended"><xref linkend="libxslt"/></para> -->
|
---|
[0124b3a] | 112 |
|
---|
[c18d3b25] | 113 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[52d50d5] | 114 | <para role="optional"><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
[85965ed] | 115 |
|
---|
[1039de3] | 116 | <para condition="html" role="usernotes">User Notes:
|
---|
| 117 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
| 118 |
|
---|
[c18d3b25] | 119 | </sect2>
|
---|
[85965ed] | 120 |
|
---|
[c18d3b25] | 121 | <sect2 role="installation">
|
---|
| 122 | <title>Installation of HTML Tidy</title>
|
---|
| 123 |
|
---|
[b852852] | 124 | <!-- <para>The <application>HTML Tidy</application> documentation
|
---|
[f6ec478] | 125 | is contained in a separate tarball. Unpack both the source and docs
|
---|
[b852852] | 126 | tarballs before starting the build.</para> -->
|
---|
[85965ed] | 127 |
|
---|
[8d77de6] | 128 | <para>Install <application>HTML Tidy</application> by
|
---|
[c18d3b25] | 129 | running the following commands:</para>
|
---|
| 130 |
|
---|
[b852852] | 131 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[c18d3b25] | 132 | make</userinput></screen>
|
---|
[afd6889] | 133 |
|
---|
[b852852] | 134 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
[7c43113] | 135 |
|
---|
[c18d3b25] | 136 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[85965ed] | 137 |
|
---|
[0124b3a] | 138 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 139 |
|
---|
[b852852] | 140 | <para>If you wish to install the API documentation, issue the following
|
---|
| 141 | command as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 142 |
|
---|
| 143 | <screen role="root"><userinput>make -C htmldoc install_apidocs</userinput></screen>
|
---|
| 144 |
|
---|
| 145 | <!-- <para>If you have <xref linkend="libxslt"/> installed, issue the following
|
---|
[d9962703] | 146 | commands as an unprivileged user to build the man page and HTML
|
---|
| 147 | documentation:</para>
|
---|
[0124b3a] | 148 |
|
---|
| 149 | <screen><userinput>cd htmldoc &&
|
---|
[2eebc7b9] | 150 | tidy -xml-help > tidy-help.xml &&
|
---|
| 151 | tidy -xml-config > tidy-config.xml &&
|
---|
| 152 | xsltproc -o tidy.1 tidy1.xsl tidy-help.xml &&
|
---|
| 153 | xsltproc -o quickref.html quickref-html.xsl tidy-config.xml &&
|
---|
[0124b3a] | 154 | cd ..</userinput></screen>
|
---|
| 155 |
|
---|
[8d77de6] | 156 | <para>If you built the man page and the Quick Reference HTML file, install
|
---|
| 157 | the man page by issuing the following command as the
|
---|
[0124b3a] | 158 | <systemitem class="username">root</systemitem> user:</para>
|
---|
| 159 |
|
---|
| 160 | <screen role="root"><userinput>install -v -m644 htmldoc/tidy.1 /usr/share/man/man1</userinput></screen>
|
---|
| 161 |
|
---|
[8d77de6] | 162 | <para>Now finish the installation by installing the pre-built
|
---|
[fc7afd0c] | 163 | documentation as the <systemitem class="username">root</systemitem>
|
---|
[0124b3a] | 164 | user:</para>
|
---|
| 165 |
|
---|
[f6ec478] | 166 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/tidy-&tidy-docs-version; &&
|
---|
[b852852] | 167 | cp -v -R htmldoc/* /usr/share/doc/tidy-&tidy-docs-version;</userinput></screen> -->
|
---|
[85965ed] | 168 |
|
---|
[c18d3b25] | 169 | </sect2>
|
---|
[85965ed] | 170 |
|
---|
[b852852] | 171 | <!-- <sect2 role="commands">
|
---|
[c18d3b25] | 172 | <title>Command Explanations</title>
|
---|
| 173 |
|
---|
[8d77de6] | 174 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares
|
---|
[f6ec478] | 175 | the source tree for building using the GNU <quote>Auto</quote>
|
---|
| 176 | tools.</para>
|
---|
[85965ed] | 177 |
|
---|
[b852852] | 178 | </sect2> -->
|
---|
[85965ed] | 179 |
|
---|
[c18d3b25] | 180 | <sect2 role="configuration">
|
---|
| 181 | <title>Configuring HTML Tidy</title>
|
---|
| 182 |
|
---|
| 183 | <sect3>
|
---|
| 184 | <title>Config Files</title>
|
---|
[85965ed] | 185 |
|
---|
[8d77de6] | 186 | <para>The absolute path of the file specified in
|
---|
[c18d3b25] | 187 | <envar>$HTML_TIDY</envar>.</para>
|
---|
[85965ed] | 188 |
|
---|
[c18d3b25] | 189 | </sect3>
|
---|
| 190 |
|
---|
| 191 | <sect3>
|
---|
| 192 | <title>Configuration Information</title>
|
---|
[85965ed] | 193 |
|
---|
[8d77de6] | 194 | <para>The default configuration options can be set in the file defined in
|
---|
[f6ec478] | 195 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
| 196 | to <command>tidy</command> via command line parameters or the
|
---|
[c18d3b25] | 197 | <option>-config <file></option> parameter.</para>
|
---|
[85965ed] | 198 |
|
---|
[c18d3b25] | 199 | </sect3>
|
---|
[85965ed] | 200 |
|
---|
[c18d3b25] | 201 | </sect2>
|
---|
[85965ed] | 202 |
|
---|
[c18d3b25] | 203 | <sect2 role="content">
|
---|
| 204 | <title>Contents</title>
|
---|
| 205 |
|
---|
| 206 | <segmentedlist>
|
---|
| 207 | <segtitle>Installed Programs</segtitle>
|
---|
| 208 | <segtitle>Installed Library</segtitle>
|
---|
| 209 | <segtitle>Installed Directory</segtitle>
|
---|
| 210 | <seglistitem>
|
---|
| 211 | <seg>tab2space and tidy</seg>
|
---|
[1039de3] | 212 | <seg>libtidy.{so,a}</seg>
|
---|
[f6ec478] | 213 | <seg>/usr/share/doc/tidy-&tidy-docs-version;</seg>
|
---|
[c18d3b25] | 214 | </seglistitem>
|
---|
| 215 | </segmentedlist>
|
---|
[85965ed] | 216 |
|
---|
[c18d3b25] | 217 | <variablelist>
|
---|
| 218 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 219 | <?dbfo list-presentation="list"?>
|
---|
| 220 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 221 |
|
---|
[c18d3b25] | 222 | <varlistentry id="tab2space">
|
---|
| 223 | <term><command>tab2space</command></term>
|
---|
| 224 | <listitem>
|
---|
[8d77de6] | 225 | <para>is a utility to expand tabs and ensure consistent line
|
---|
[c18d3b25] | 226 | endings.</para>
|
---|
| 227 | <indexterm zone="html-tidy tab2space">
|
---|
| 228 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
[85965ed] | 232 |
|
---|
[c18d3b25] | 233 | <varlistentry id="tidy">
|
---|
| 234 | <term><command>tidy</command></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
| 237 | <indexterm zone="html-tidy tidy">
|
---|
| 238 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
[85965ed] | 242 |
|
---|
[c18d3b25] | 243 | <varlistentry id="libtidy">
|
---|
[1039de3] | 244 | <term><filename class='libraryfile'>libtidy.{so,a}</filename></term>
|
---|
[c18d3b25] | 245 | <listitem>
|
---|
[8d77de6] | 246 | <para>libraries provide the <application>HTML Tidy</application> API
|
---|
| 247 | functions to <command>tidy</command> and can also be called by other
|
---|
[c18d3b25] | 248 | programs.</para>
|
---|
| 249 | <indexterm zone="html-tidy libtidy">
|
---|
[1039de3] | 250 | <primary sortas="c-libtidy">libtidy.{so,a}</primary>
|
---|
[c18d3b25] | 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
[85965ed] | 254 |
|
---|
[c18d3b25] | 255 | </variablelist>
|
---|
| 256 |
|
---|
| 257 | </sect2>
|
---|
[9766fba] | 258 |
|
---|
| 259 | </sect1>
|
---|