source: general/genutils/tidy.xml@ e8582db

10.0 10.1 11.0 6.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since e8582db was e8582db, checked in by Randy McMurchy <randy@…>, 17 years ago

Added MD5 sum and restored documentation installation to Tidy instructions

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@2963 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 4.6 KB
Line 
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 " ">
9 <!ENTITY tidy-md5sum "98076a205e30873dad43d384b2366d23">
10 <!ENTITY tidy-size "239 KB">
11 <!ENTITY tidy-buildsize "9.3 MB">
12 <!ENTITY tidy-time "0.26 SBU">
13]>
14
15<sect1 id="tidy" xreflabel="HTML Tidy-&tidy-version;">
16<sect1info>
17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
19</sect1info>
20<?dbhtml filename="tidy.html"?>
21<title>HTML Tidy-&tidy-version;</title>
22
23<sect2>
24<title>Introduction to <application>HTML Tidy</application></title>
25
26<para>The <application><acronym>HTML</acronym> Tidy</application> package
27contains a command line tool and libraries used to read
28<acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym>
29files and write cleaned up markup. It detects and corrects many common coding
30errors and strives to produce visually equivalent markup that is both
31<acronym>W3C</acronym> compliant and compatible with most browsers.</para>
32
33<sect3><title>Package information</title>
34<itemizedlist spacing="compact">
35<listitem><para>Download (HTTP):
36<ulink url="&tidy-download-http;"/></para></listitem>
37<listitem><para>Download (FTP):
38<ulink url="&tidy-download-ftp;"/></para></listitem>
39<listitem><para>MD5 sum: &tidy-md5sum;</para></listitem>
40<listitem><para>Download size: &tidy-size;</para></listitem>
41<listitem><para>Estimated disk space required:
42&tidy-buildsize;</para></listitem>
43<listitem><para>Estimated build time: &tidy-time;</para></listitem>
44</itemizedlist>
45</sect3>
46
47<sect3><title>Additional downloads</title>
48<itemizedlist spacing="compact">
49<listitem><para>Documentation: <ulink
50url="http://tidy.sourceforge.net/docs/tidy_docs.tgz"/></para></listitem>
51</itemizedlist>
52</sect3>
53
54<sect3><title><application><acronym>HTML</acronym> Tidy</application>
55dependencies</title>
56<sect4><title>Optional</title>
57<para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
58</sect4>
59</sect3>
60
61</sect2>
62
63<sect2>
64<title>Installation of <application><acronym>HTML</acronym>
65Tidy</application></title>
66
67<para>The <application><acronym>HTML</acronym> Tidy</application> documentation
68is contained in a separate tarball. Unpack both the source and docs tarballs
69before starting the build.</para>
70
71<para>Install <application><acronym>HTML</acronym> Tidy</application> by
72running the following commands:</para>
73
74<screen><userinput><command>sh build/gnuauto/setup.sh &amp;&amp;
75./configure --prefix=/usr &amp;&amp;
76make &amp;&amp;
77make install &amp;&amp;
78install -m644 htmldoc/man_page.txt \
79 /usr/share/man/man1/tidy.1 &amp;&amp;
80install -d -m755 /usr/share/doc/tidy &amp;&amp;
81cp -R htmldoc /usr/share/doc/tidy &amp;&amp;
82chown -R root:root /usr/share/doc/tidy</command></userinput></screen>
83
84</sect2>
85
86<sect2>
87<title>Command explanations</title>
88
89<para><command>sh build/gnuauto/setup.sh</command>: This command prepares the
90source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote>
91tools.</para>
92
93</sect2>
94
95<sect2>
96<title>Configuring <application><acronym>HTML</acronym>
97Tidy</application></title>
98
99<sect3><title>Config files</title>
100<para>The absolute path of the file specified in
101<envar>$HTML_TIDY</envar>.</para>
102</sect3>
103
104<sect3><title>Configuration Information</title>
105
106<para>The default configuration options can be set in the file defined in
107<envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
108<command>tidy</command> via command line parameters or the
109<parameter>-config &lt;file&gt;</parameter> parameter.</para>
110</sect3>
111
112</sect2>
113
114<sect2>
115<title>Contents</title>
116
117<para>The <application><acronym>HTML</acronym> Tidy</application> package
118contains <command>tidy</command>, <command>tab2space</command> and the
119<filename class='libraryfile'>libtidy</filename> libraries.</para>
120
121</sect2>
122
123<sect2><title>Description</title>
124
125<sect3><title>tidy</title>
126<para><command>tidy</command> validates, corrects, and pretty-prints
127<acronym>HTML</acronym> files.</para>
128</sect3>
129
130<sect3><title>tab2space</title>
131<para><command>tab2space</command> is a utility to expand tabs and ensure
132consistent line endings.</para>
133</sect3>
134
135<sect3><title>libtidy libraries</title>
136<para><filename class='libraryfile'>libtidy</filename> libraries provide the
137<application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym>
138functions to <command>tidy</command> and can also be called by other
139programs.</para>
140</sect3>
141
142</sect2>
143
144</sect1>
Note: See TracBrowser for help on using the repository browser.