source: general/genutils/tidy.xml@ 9a66d5f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY tidy-download-http "http://tidy.sourceforge.net/src/tidy_src_&tidy-version;.tgz">
  <!ENTITY tidy-download-ftp  " ">
  <!ENTITY tidy-md5sum        "11f27e0b6767660911a7a2cc5c491784">
  <!ENTITY tidy-size          "245 KB">
  <!ENTITY tidy-buildsize     "9.7 MB">
  <!ENTITY tidy-time          "0.25 SBU">

  <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs.tgz">
  <!ENTITY tidy-docs-md5sum   "0fc0d02335cdeb945b02c6907850ba5d">
  <!ENTITY tidy-docs-size     "153 KB">
]>

<sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="tidy.html"?>
<title>HTML Tidy-&tidy-version;</title>
<indexterm zone="html-tidy">
<primary sortas="a-HTML-Tidy">HTML Tidy</primary></indexterm>

<sect2>
<title>Introduction to <application>HTML Tidy</application></title>

<para>The <application><acronym>HTML</acronym> Tidy</application> package 
contains a command line tool and libraries used to read 
<acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym> 
files and write cleaned up markup. It detects and corrects many common coding 
errors and strives to produce visually equivalent markup that is both 
<acronym>W3C</acronym> compliant and compatible with most browsers.</para>

<sect3><title>Package information</title>
<itemizedlist spacing="compact">
<listitem><para>Download (HTTP): 
<ulink url="&tidy-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&tidy-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &tidy-md5sum;</para></listitem>
<listitem><para>Download size: &tidy-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&tidy-buildsize;</para></listitem>
<listitem><para>Estimated build time: &tidy-time;</para></listitem>
</itemizedlist>

<note><para><application><acronym>HTML</acronym> Tidy</application> is 
updated very frequently by its maintainers, and the source package listed 
above may not be available at the listed <acronym>URL</acronym> due to the 
release of a newer version. The most current source package can be always be 
downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this 
version is newer than the version listed above, the following instructions 
should work, but have not yet been tested by BLFS. If you'd rather download 
the version listed above, you can find it at 
<ulink url="http://tidy.sourceforge.net/src/old/"/>.</para></note>
</sect3>

<sect3><title>Additional downloads</title>
<sect4><title>Documentation</title>
<itemizedlist spacing="compact">
<listitem><para>Documentation: <ulink url="&tidy-docs-download;"/></para>
</listitem>
<listitem><para>Download MD5 sum: &tidy-docs-md5sum;</para></listitem>
<listitem><para>Download size: &tidy-docs-size;</para></listitem>
</itemizedlist>
</sect4>

<sect4><title>Patches</title>
<itemizedlist spacing="compact">
<listitem><para>Required patch: <ulink 
url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
</listitem>
</itemizedlist>
</sect4>
</sect3>

<sect3><title><application><acronym>HTML</acronym> Tidy</application> 
dependencies</title>
<sect4><title>Optional</title>
<para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>HTML</acronym> 
Tidy</application></title>

<para>The <application><acronym>HTML</acronym> Tidy</application> documentation 
is contained in a separate tarball. Unpack both the source and docs tarballs
before starting the build.</para>

<para>Install <application><acronym>HTML</acronym> Tidy</application> by 
running the following commands:</para>

<screen><userinput><command>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch &amp;&amp;
sh build/gnuauto/setup.sh &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install &amp;&amp;
install -v -m644 htmldoc/man_page.txt \
    /usr/share/man/man1/tidy.1 &amp;&amp;
install -v -d -m755 /usr/share/doc/tidy &amp;&amp;
cp -v -R htmldoc /usr/share/doc/tidy</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>sh build/gnuauto/setup.sh</command>: This command prepares the 
source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote> 
tools.</para>

</sect2>

<sect2>
<title>Configuring <application><acronym>HTML</acronym> 
Tidy</application></title>

<sect3><title>Config files</title>
<para>The absolute path of the file specified in 
<envar>$HTML_TIDY</envar>.</para>
</sect3>

<sect3><title>Configuration Information</title>

<para>The default configuration options can be set in the file defined in 
<envar>$HTML_TIDY</envar>. Additional configuration options can be passed to 
<command>tidy</command> via command line parameters or the 
<parameter>-config &lt;file&gt;</parameter> parameter.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>tab2space and tidy</seg>
<seg>libtidy.[so,a]</seg>
<seg>/usr/share/doc/tidy</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="tab2space">
<term><command>tab2space</command></term>
<listitem><para>is a utility to expand tabs and ensure consistent line 
endings.</para>
<indexterm zone="html-tidy tab2space">
<primary sortas="b-tab2space">tab2space</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tidy">
<term><command>tidy</command></term>
<listitem><para>validates, corrects, and pretty-prints <acronym>HTML</acronym> 
files.</para>
<indexterm zone="html-tidy tidy">
<primary sortas="b-tidy">tidy</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libtidy">
<term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
<listitem><para>libraries provide the 
<application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym> 
functions to <command>tidy</command> and can also be called by other 
programs.</para>
<indexterm zone="html-tidy libtidy">
<primary sortas="c-libtidy">libtidy.[so,a]</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>