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