source: general/genutils/tidy.xml@ 2eebc7b9

10.0 10.1 11.0 11.1 11.2 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 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 2eebc7b9 was 2eebc7b9, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Shortened the Tidy documentation generation commands.

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

  • Property mode set to 100644
File size: 8.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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 "8baf0d61bcaf7f488c7fde0b26268509">
10 <!ENTITY tidy-size "254 KB">
11 <!ENTITY tidy-buildsize "10.1 MB">
12 <!ENTITY tidy-time "0.2 SBU">
13
14 <!ENTITY tidy-docs-version "050502">
15 <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs_&tidy-docs-version;.tgz">
16 <!ENTITY tidy-docs-md5sum "54488c25347b9fee5c544a13ab5324ee">
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
39 files 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 <note>
66 <para><application>HTML Tidy</application> is
67 updated very frequently by its maintainers, and the source package listed
68 above may not be available at the listed URL due to the
69 release of a newer version. The most current source package can be always be
70 downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this
71 version is newer than the version listed above, the following instructions
72 should work, but have not yet been tested by BLFS. If you'd rather download
73 the version listed above, you can find it at
74 <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para>
75 </note>
76
77 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
78
79 <bridgehead renderas="sect4">Documentation</bridgehead>
80 <itemizedlist spacing="compact">
81 <listitem>
82 <para>Documentation: <ulink url="&tidy-docs-download;"/></para>
83 </listitem>
84 <listitem>
85 <para>Download MD5 sum: &tidy-docs-md5sum;</para>
86 </listitem>
87 <listitem>
88 <para>Download size: &tidy-docs-size;</para>
89 </listitem>
90 </itemizedlist>
91
92 <bridgehead renderas="sect4">Patches</bridgehead>
93 <itemizedlist spacing="compact">
94 <listitem>
95 <para>Required patch: <ulink
96 url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
97 </listitem>
98 </itemizedlist>
99
100 <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
101
102 <bridgehead renderas="sect4">Recommended (To Build the Man Page and Quick
103 Reference Docs)</bridgehead>
104 <para><xref linkend="libxslt"/></para>
105
106 <bridgehead renderas="sect4">Optional</bridgehead>
107 <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
108
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of HTML Tidy</title>
113
114 <para>The <application>HTML Tidy</application> documentation
115 is contained in a separate tarball. Unpack both the source and docs tarballs
116 before starting the build.</para>
117
118 <para>Install <application>HTML Tidy</application> by
119 running the following commands:</para>
120
121<screen><userinput>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch &amp;&amp;
122sh build/gnuauto/setup.sh &amp;&amp;
123./configure --prefix=/usr &amp;&amp;
124make</userinput></screen>
125
126 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
127
128<screen role="root"><userinput>make install</userinput></screen>
129
130 <para>If you have the dependencies shown above to build the man page and
131 HTML documentation, issue the following commands as an unprivileged
132 user:</para>
133
134<screen><userinput>cd htmldoc &amp;&amp;
135tidy -xml-help &gt; tidy-help.xml &amp;&amp;
136tidy -xml-config &gt; tidy-config.xml &amp;&amp;
137xsltproc -o tidy.1 tidy1.xsl tidy-help.xml &amp;&amp;
138xsltproc -o quickref.html quickref-html.xsl tidy-config.xml &amp;&amp;
139cd ..</userinput></screen>
140
141 <para>If you built the man page and the Quick Reference HTML file, install
142 the man page by issuing the following command as the
143 <systemitem class="username">root</systemitem> user:</para>
144
145<screen role="root"><userinput>install -v -m644 htmldoc/tidy.1 /usr/share/man/man1</userinput></screen>
146
147 <para>Now finish the installation by installing the pre-built
148 documentation as the <systemitem class="username">root</systemitem>
149 user:</para>
150
151<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/tidy &amp;&amp;
152cp -v -R htmldoc/* /usr/share/doc/tidy</userinput></screen>
153
154 </sect2>
155
156 <sect2 role="commands">
157 <title>Command Explanations</title>
158
159 <para><command>sh build/gnuauto/setup.sh</command>: This command prepares
160 the source tree for building using the GNU <quote>Auto</quote> tools.</para>
161
162 </sect2>
163
164 <sect2 role="configuration">
165 <title>Configuring HTML Tidy</title>
166
167 <sect3>
168 <title>Config Files</title>
169
170 <para>The absolute path of the file specified in
171 <envar>$HTML_TIDY</envar>.</para>
172
173 </sect3>
174
175 <sect3>
176 <title>Configuration Information</title>
177
178 <para>The default configuration options can be set in the file defined in
179 <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
180 <command>tidy</command> via command line parameters or the
181 <option>-config &lt;file&gt;</option> parameter.</para>
182
183 </sect3>
184
185 </sect2>
186
187 <sect2 role="content">
188 <title>Contents</title>
189
190 <segmentedlist>
191 <segtitle>Installed Programs</segtitle>
192 <segtitle>Installed Library</segtitle>
193 <segtitle>Installed Directory</segtitle>
194 <seglistitem>
195 <seg>tab2space and tidy</seg>
196 <seg>libtidy.[so,a]</seg>
197 <seg>/usr/share/doc/tidy</seg>
198 </seglistitem>
199 </segmentedlist>
200
201 <variablelist>
202 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
203 <?dbfo list-presentation="list"?>
204 <?dbhtml list-presentation="table"?>
205
206 <varlistentry id="tab2space">
207 <term><command>tab2space</command></term>
208 <listitem>
209 <para>is a utility to expand tabs and ensure consistent line
210 endings.</para>
211 <indexterm zone="html-tidy tab2space">
212 <primary sortas="b-tab2space">tab2space</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="tidy">
218 <term><command>tidy</command></term>
219 <listitem>
220 <para>validates, corrects, and pretty-prints HTML files.</para>
221 <indexterm zone="html-tidy tidy">
222 <primary sortas="b-tidy">tidy</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="libtidy">
228 <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
229 <listitem>
230 <para>libraries provide the <application>HTML Tidy</application> API
231 functions to <command>tidy</command> and can also be called by other
232 programs.</para>
233 <indexterm zone="html-tidy libtidy">
234 <primary sortas="c-libtidy">libtidy.[so,a]</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 </variablelist>
240
241 </sect2>
242
243</sect1>
Note: See TracBrowser for help on using the repository browser.