1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY tidy-download-http "&sources-anduin-http;/t/tidy-&tidy-version;.tar.bz2">
|
---|
8 | <!ENTITY tidy-download-ftp " ">
|
---|
9 | <!ENTITY tidy-md5sum "bc640bba1e1e776fc4b4b1d9f5e6e2a5">
|
---|
10 | <!ENTITY tidy-size "830 KB">
|
---|
11 | <!ENTITY tidy-buildsize "12 MB">
|
---|
12 | <!ENTITY tidy-time "0.2 SBU">
|
---|
13 |
|
---|
14 | <!-- <!ENTITY tidy-docs-version "051020">
|
---|
15 | <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs_&tidy-docs-version;.tgz">
|
---|
16 | <!ENTITY tidy-docs-md5sum "86de2f198e57399c063d2567b2a25628">
|
---|
17 | <!ENTITY tidy-docs-size "150 KB"> -->
|
---|
18 | ]>
|
---|
19 |
|
---|
20 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
21 | <?dbhtml filename="tidy.html"?>
|
---|
22 |
|
---|
23 | <sect1info>
|
---|
24 | <othername>$LastChangedBy$</othername>
|
---|
25 | <date>$Date$</date>
|
---|
26 | </sect1info>
|
---|
27 |
|
---|
28 | <title>HTML Tidy-&tidy-version;</title>
|
---|
29 |
|
---|
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>
|
---|
36 |
|
---|
37 | <para>The <application>HTML Tidy</application> package contains a
|
---|
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
|
---|
40 | errors and strives to produce visually equivalent markup that is both
|
---|
41 | W3C compliant and compatible with most browsers.</para>
|
---|
42 |
|
---|
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 |
|
---|
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 |
|
---|
72 | <!-- <note>
|
---|
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
|
---|
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
|
---|
81 | <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para>
|
---|
82 | </note> -->
|
---|
83 |
|
---|
84 | <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead> -->
|
---|
85 |
|
---|
86 | <!-- <bridgehead renderas="sect4">Documentation</bridgehead>
|
---|
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>
|
---|
97 | </itemizedlist> -->
|
---|
98 |
|
---|
99 | <!-- <bridgehead renderas="sect4">Patches</bridgehead>
|
---|
100 | <itemizedlist spacing="compact">
|
---|
101 | <listitem>
|
---|
102 | <para>Required patch: <ulink
|
---|
103 | url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
|
---|
104 | </listitem>
|
---|
105 | </itemizedlist> -->
|
---|
106 |
|
---|
107 | <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
|
---|
108 |
|
---|
109 | <!-- <bridgehead renderas="sect4">Recommended (To Build the Man Page and Quick
|
---|
110 | Reference Docs)</bridgehead>
|
---|
111 | <para role="recommended"><xref linkend="libxslt"/></para> -->
|
---|
112 |
|
---|
113 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
114 | <para role="optional"><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
115 |
|
---|
116 | <para condition="html" role="usernotes">User Notes:
|
---|
117 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
118 |
|
---|
119 | </sect2>
|
---|
120 |
|
---|
121 | <sect2 role="installation">
|
---|
122 | <title>Installation of HTML Tidy</title>
|
---|
123 |
|
---|
124 | <!-- <para>The <application>HTML Tidy</application> documentation
|
---|
125 | is contained in a separate tarball. Unpack both the source and docs
|
---|
126 | tarballs before starting the build.</para> -->
|
---|
127 |
|
---|
128 | <para>Install <application>HTML Tidy</application> by
|
---|
129 | running the following commands:</para>
|
---|
130 |
|
---|
131 | <screen><userinput>./configure --prefix=/usr &&
|
---|
132 | make</userinput></screen>
|
---|
133 |
|
---|
134 | <para>This package does not come with a test suite.</para>
|
---|
135 | <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
|
---|
136 |
|
---|
137 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
138 |
|
---|
139 | <screen role="root"><userinput>make install &&
|
---|
140 |
|
---|
141 | install -v -m644 -D htmldoc/tidy.1 \
|
---|
142 | /usr/share/man/man1/tidy.1 &&
|
---|
143 | install -v -m755 -d /usr/share/doc/tidy-&tidy-version; &&
|
---|
144 | install -v -m644 htmldoc/*.{html,gif,css} \
|
---|
145 | /usr/share/doc/tidy-&tidy-version;</userinput></screen>
|
---|
146 |
|
---|
147 | <para>If you wish to install the API documentation you must have
|
---|
148 | <xref linkend="doxygen"/> installed, then change directories into the
|
---|
149 | <filename class='directory'>htmldoc</filename> of the source tree and
|
---|
150 | issue the command <command>doxygen</command>. Then as the
|
---|
151 | <systemitem class="username">root</systemitem> user copy
|
---|
152 | the <filename class='directory'>api</filename> directory to
|
---|
153 | <filename class='directory'>/usr/share/doc/tidy-&tidy-version;.</filename></para>
|
---|
154 |
|
---|
155 | <!-- <screen role="root"><userinput>make -C htmldoc install_apidocs</userinput></screen> -->
|
---|
156 |
|
---|
157 | <!-- <para>If you have <xref linkend="libxslt"/> installed, issue the following
|
---|
158 | commands as an unprivileged user to build the man page and HTML
|
---|
159 | documentation:</para>
|
---|
160 |
|
---|
161 | <screen><userinput>cd htmldoc &&
|
---|
162 | tidy -xml-help > tidy-help.xml &&
|
---|
163 | tidy -xml-config > tidy-config.xml &&
|
---|
164 | xsltproc -o tidy.1 tidy1.xsl tidy-help.xml &&
|
---|
165 | xsltproc -o quickref.html quickref-html.xsl tidy-config.xml &&
|
---|
166 | cd ..</userinput></screen>
|
---|
167 |
|
---|
168 | <para>If you built the man page and the Quick Reference HTML file, install
|
---|
169 | the man page by issuing the following command as the
|
---|
170 | <systemitem class="username">root</systemitem> user:</para>
|
---|
171 |
|
---|
172 | <screen role="root"><userinput>install -v -m644 htmldoc/tidy.1 /usr/share/man/man1</userinput></screen>
|
---|
173 |
|
---|
174 | <para>Now finish the installation by installing the pre-built
|
---|
175 | documentation as the <systemitem class="username">root</systemitem>
|
---|
176 | user:</para>
|
---|
177 |
|
---|
178 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/tidy-&tidy-docs-version; &&
|
---|
179 | cp -v -R htmldoc/* /usr/share/doc/tidy-&tidy-docs-version;</userinput></screen> -->
|
---|
180 |
|
---|
181 | </sect2>
|
---|
182 |
|
---|
183 | <!-- <sect2 role="commands">
|
---|
184 | <title>Command Explanations</title>
|
---|
185 |
|
---|
186 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares
|
---|
187 | the source tree for building using the GNU <quote>Auto</quote>
|
---|
188 | tools.</para>
|
---|
189 |
|
---|
190 | </sect2> -->
|
---|
191 |
|
---|
192 | <sect2 role="configuration">
|
---|
193 | <title>Configuring HTML Tidy</title>
|
---|
194 |
|
---|
195 | <sect3>
|
---|
196 | <title>Config Files</title>
|
---|
197 |
|
---|
198 | <para>The absolute path of the file specified in
|
---|
199 | <envar>$HTML_TIDY</envar>.</para>
|
---|
200 |
|
---|
201 | </sect3>
|
---|
202 |
|
---|
203 | <sect3>
|
---|
204 | <title>Configuration Information</title>
|
---|
205 |
|
---|
206 | <para>The default configuration options can be set in the file defined in
|
---|
207 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
208 | to <command>tidy</command> via command line parameters or the
|
---|
209 | <option>-config <file></option> parameter.</para>
|
---|
210 |
|
---|
211 | </sect3>
|
---|
212 |
|
---|
213 | </sect2>
|
---|
214 |
|
---|
215 | <sect2 role="content">
|
---|
216 | <title>Contents</title>
|
---|
217 |
|
---|
218 | <segmentedlist>
|
---|
219 | <segtitle>Installed Programs</segtitle>
|
---|
220 | <segtitle>Installed Library</segtitle>
|
---|
221 | <segtitle>Installed Directory</segtitle>
|
---|
222 | <seglistitem>
|
---|
223 | <seg>tab2space and tidy</seg>
|
---|
224 | <seg>libtidy.{so,a}</seg>
|
---|
225 | <seg>/usr/share/doc/tidy-&tidy-version;</seg>
|
---|
226 | </seglistitem>
|
---|
227 | </segmentedlist>
|
---|
228 |
|
---|
229 | <variablelist>
|
---|
230 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
231 | <?dbfo list-presentation="list"?>
|
---|
232 | <?dbhtml list-presentation="table"?>
|
---|
233 |
|
---|
234 | <varlistentry id="tab2space">
|
---|
235 | <term><command>tab2space</command></term>
|
---|
236 | <listitem>
|
---|
237 | <para>is a utility to expand tabs and ensure consistent line
|
---|
238 | endings.</para>
|
---|
239 | <indexterm zone="html-tidy tab2space">
|
---|
240 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
241 | </indexterm>
|
---|
242 | </listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="tidy">
|
---|
246 | <term><command>tidy</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
249 | <indexterm zone="html-tidy tidy">
|
---|
250 | <primary sortas="b-tidy">tidy</primary>
|
---|
251 | </indexterm>
|
---|
252 | </listitem>
|
---|
253 | </varlistentry>
|
---|
254 |
|
---|
255 | <varlistentry id="libtidy">
|
---|
256 | <term><filename class='libraryfile'>libtidy.{so,a}</filename></term>
|
---|
257 | <listitem>
|
---|
258 | <para>libraries provide the <application>HTML Tidy</application> API
|
---|
259 | functions to <command>tidy</command> and can also be called by other
|
---|
260 | programs.</para>
|
---|
261 | <indexterm zone="html-tidy libtidy">
|
---|
262 | <primary sortas="c-libtidy">libtidy.{so,a}</primary>
|
---|
263 | </indexterm>
|
---|
264 | </listitem>
|
---|
265 | </varlistentry>
|
---|
266 |
|
---|
267 | </variablelist>
|
---|
268 |
|
---|
269 | </sect2>
|
---|
270 |
|
---|
271 | </sect1>
|
---|