source: general/genutils/tidy.xml@ 99e8a229

<?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        "8a1d13a83946260c4c46b962b300cd0f">
  <!ENTITY tidy-size          "243 KB">
  <!ENTITY tidy-buildsize     "9.6 MB">
  <!ENTITY tidy-time          "0.26 SBU">
]>

<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>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Documentation: <ulink 
url="http://tidy.sourceforge.net/docs/tidy_docs.tgz"/></para></listitem>
</itemizedlist>
</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>sh build/gnuauto/setup.sh &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
install -m644 htmldoc/man_page.txt \
    /usr/share/man/man1/tidy.1 &amp;&amp;
install -d -m755 /usr/share/doc/tidy &amp;&amp;
cp -R htmldoc /usr/share/doc/tidy &amp;&amp;
chown -R root:root /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>