source: general/genutils/tidy.xml@ 6e01862c

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 upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 6e01862c was 6e01862c, checked in by Randy McMurchy <randy@…>, 17 years ago

Added optional dependency to HTML Tidy

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