[9766fba] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 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 " ">
|
---|
[1787ccd] | 9 | <!ENTITY tidy-md5sum "70e72775f4a16293f740ed27da05c05b">
|
---|
| 10 | <!ENTITY tidy-size "244 KB">
|
---|
[7305ab5] | 11 | <!ENTITY tidy-buildsize "9.6 MB">
|
---|
[0fb1ed2] | 12 | <!ENTITY tidy-time "0.26 SBU">
|
---|
[1787ccd] | 13 |
|
---|
| 14 | <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs.tgz">
|
---|
| 15 | <!ENTITY tidy-docs-md5sum "4ac92cbb22d86ae1a42c3d56b6c3f424">
|
---|
| 16 | <!ENTITY tidy-docs-size "152 KB">
|
---|
[9766fba] | 17 | ]>
|
---|
| 18 |
|
---|
[0fb1ed2] | 19 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
[9766fba] | 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 | <?dbhtml filename="tidy.html"?>
|
---|
| 25 | <title>HTML Tidy-&tidy-version;</title>
|
---|
[0fb1ed2] | 26 | <indexterm zone="html-tidy">
|
---|
[6a2bce2] | 27 | <primary sortas="a-HTML-Tidy">HTML Tidy</primary></indexterm>
|
---|
[9766fba] | 28 |
|
---|
| 29 | <sect2>
|
---|
| 30 | <title>Introduction to <application>HTML Tidy</application></title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application><acronym>HTML</acronym> Tidy</application> package
|
---|
| 33 | contains a command line tool and libraries used to read
|
---|
| 34 | <acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym>
|
---|
| 35 | files and write cleaned up markup. It detects and corrects many common coding
|
---|
| 36 | errors and strives to produce visually equivalent markup that is both
|
---|
| 37 | <acronym>W3C</acronym> compliant and compatible with most browsers.</para>
|
---|
| 38 |
|
---|
| 39 | <sect3><title>Package information</title>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem><para>Download (HTTP):
|
---|
| 42 | <ulink url="&tidy-download-http;"/></para></listitem>
|
---|
| 43 | <listitem><para>Download (FTP):
|
---|
| 44 | <ulink url="&tidy-download-ftp;"/></para></listitem>
|
---|
[dc2f5ad] | 45 | <listitem><para>Download MD5 sum: &tidy-md5sum;</para></listitem>
|
---|
[9766fba] | 46 | <listitem><para>Download size: &tidy-size;</para></listitem>
|
---|
[e8582db] | 47 | <listitem><para>Estimated disk space required:
|
---|
[9766fba] | 48 | &tidy-buildsize;</para></listitem>
|
---|
| 49 | <listitem><para>Estimated build time: &tidy-time;</para></listitem>
|
---|
| 50 | </itemizedlist>
|
---|
| 51 | </sect3>
|
---|
| 52 |
|
---|
| 53 | <sect3><title>Additional downloads</title>
|
---|
| 54 | <itemizedlist spacing="compact">
|
---|
[1787ccd] | 55 | <listitem><para>Documentation: <ulink url="&tidy-docs-download;"/></para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem><para>Download MD5 sum: &tidy-docs-md5sum;</para></listitem>
|
---|
| 58 | <listitem><para>Download size: &tidy-docs-size;</para></listitem>
|
---|
[9766fba] | 59 | </itemizedlist>
|
---|
| 60 | </sect3>
|
---|
| 61 |
|
---|
[6e01862c] | 62 | <sect3><title><application><acronym>HTML</acronym> Tidy</application>
|
---|
| 63 | dependencies</title>
|
---|
| 64 | <sect4><title>Optional</title>
|
---|
| 65 | <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 66 | </sect4>
|
---|
| 67 | </sect3>
|
---|
| 68 |
|
---|
[9766fba] | 69 | </sect2>
|
---|
| 70 |
|
---|
| 71 | <sect2>
|
---|
| 72 | <title>Installation of <application><acronym>HTML</acronym>
|
---|
| 73 | Tidy</application></title>
|
---|
| 74 |
|
---|
| 75 | <para>The <application><acronym>HTML</acronym> Tidy</application> documentation
|
---|
| 76 | is contained in a separate tarball. Unpack both the source and docs tarballs
|
---|
| 77 | before starting the build.</para>
|
---|
| 78 |
|
---|
| 79 | <para>Install <application><acronym>HTML</acronym> Tidy</application> by
|
---|
| 80 | running the following commands:</para>
|
---|
| 81 |
|
---|
| 82 | <screen><userinput><command>sh build/gnuauto/setup.sh &&
|
---|
| 83 | ./configure --prefix=/usr &&
|
---|
[afd6889] | 84 | make</command></userinput></screen>
|
---|
| 85 |
|
---|
| 86 | <para>Now, as the root user:</para>
|
---|
| 87 |
|
---|
| 88 | <screen><userinput role='root'><command>make install &&
|
---|
| 89 | install -v -m644 htmldoc/man_page.txt \
|
---|
[9766fba] | 90 | /usr/share/man/man1/tidy.1 &&
|
---|
[afd6889] | 91 | install -v -d -m755 /usr/share/doc/tidy &&
|
---|
| 92 | cp -v -R htmldoc /usr/share/doc/tidy</command></userinput></screen>
|
---|
[9766fba] | 93 |
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2>
|
---|
| 97 | <title>Command explanations</title>
|
---|
| 98 |
|
---|
| 99 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares the
|
---|
| 100 | source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote>
|
---|
| 101 | tools.</para>
|
---|
| 102 |
|
---|
| 103 | </sect2>
|
---|
| 104 |
|
---|
| 105 | <sect2>
|
---|
| 106 | <title>Configuring <application><acronym>HTML</acronym>
|
---|
| 107 | Tidy</application></title>
|
---|
| 108 |
|
---|
| 109 | <sect3><title>Config files</title>
|
---|
| 110 | <para>The absolute path of the file specified in
|
---|
| 111 | <envar>$HTML_TIDY</envar>.</para>
|
---|
| 112 | </sect3>
|
---|
| 113 |
|
---|
| 114 | <sect3><title>Configuration Information</title>
|
---|
| 115 |
|
---|
| 116 | <para>The default configuration options can be set in the file defined in
|
---|
| 117 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
|
---|
| 118 | <command>tidy</command> via command line parameters or the
|
---|
| 119 | <parameter>-config <file></parameter> parameter.</para>
|
---|
| 120 | </sect3>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | <sect2>
|
---|
| 125 | <title>Contents</title>
|
---|
| 126 |
|
---|
[0fb1ed2] | 127 | <segmentedlist>
|
---|
| 128 | <segtitle>Installed Programs</segtitle>
|
---|
| 129 | <segtitle>Installed Library</segtitle>
|
---|
| 130 | <segtitle>Installed Directory</segtitle>
|
---|
| 131 | <seglistitem>
|
---|
| 132 | <seg>tab2space and tidy</seg>
|
---|
| 133 | <seg>libtidy.[so,a]</seg>
|
---|
| 134 | <seg>/usr/share/doc/tidy</seg>
|
---|
| 135 | </seglistitem>
|
---|
| 136 | </segmentedlist>
|
---|
| 137 |
|
---|
| 138 | <variablelist>
|
---|
| 139 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 140 | <?dbfo list-presentation="list"?>
|
---|
| 141 |
|
---|
| 142 | <varlistentry id="tab2space">
|
---|
| 143 | <term><command>tab2space</command></term>
|
---|
| 144 | <listitem><para>is a utility to expand tabs and ensure consistent line
|
---|
| 145 | endings.</para>
|
---|
| 146 | <indexterm zone="html-tidy tab2space">
|
---|
| 147 | <primary sortas="b-tab2space">tab2space</primary></indexterm>
|
---|
| 148 | </listitem>
|
---|
| 149 | </varlistentry>
|
---|
| 150 |
|
---|
| 151 | <varlistentry id="tidy">
|
---|
| 152 | <term><command>tidy</command></term>
|
---|
| 153 | <listitem><para>validates, corrects, and pretty-prints <acronym>HTML</acronym>
|
---|
| 154 | files.</para>
|
---|
| 155 | <indexterm zone="html-tidy tidy">
|
---|
| 156 | <primary sortas="b-tidy">tidy</primary></indexterm>
|
---|
| 157 | </listitem>
|
---|
| 158 | </varlistentry>
|
---|
| 159 |
|
---|
| 160 | <varlistentry id="libtidy">
|
---|
| 161 | <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
|
---|
| 162 | <listitem><para>libraries provide the
|
---|
[9766fba] | 163 | <application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym>
|
---|
| 164 | functions to <command>tidy</command> and can also be called by other
|
---|
| 165 | programs.</para>
|
---|
[0fb1ed2] | 166 | <indexterm zone="html-tidy libtidy">
|
---|
| 167 | <primary sortas="c-libtidy">libtidy.[so,a]</primary></indexterm>
|
---|
| 168 | </listitem>
|
---|
| 169 | </varlistentry>
|
---|
| 170 | </variablelist>
|
---|
[9766fba] | 171 |
|
---|
| 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | </sect1>
|
---|