source: general/genutils/tidy-html5.xml@ b4ce81fd

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since b4ce81fd was b4ce81fd, checked in by Xi Ruoyao <xry111@…>, 16 months ago

tidy: remove unneeded static library

"libtidy.a" (without "s") is not a typo: tidy has changed the name of
the static library since some time.

  • Property mode set to 100644
File size: 6.2 KB
Line 
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-html5-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;/tidy-html5-&tidy-html5-version;.tar.gz">
8 <!ENTITY tidy-html5-download-ftp " ">
9 <!ENTITY tidy-html5-md5sum "0f6c55ef651e258adbe5750f555af50f">
10 <!ENTITY tidy-html5-size "992 KB">
11 <!ENTITY tidy-html5-buildsize "11 MB">
12 <!ENTITY tidy-html5-time "0.2 SBU">
13]>
14
15<sect1 id="tidy-html5" xreflabel="tidy-html5-&tidy-html5-version;">
16 <?dbhtml filename="tidy-html5.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>tidy-html5-&tidy-html5-version;</title>
23
24 <indexterm zone="tidy-html5">
25 <primary sortas="a-Tidy-HTML5">Tidy HTML5</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Tidy HTML5</title>
30
31 <para>
32 The <application>Tidy HTML5</application> package contains a
33 command line tool and libraries used to read HTML, XHTML and XML files
34 and write cleaned up markup. It detects and corrects many common coding
35 errors and strives to produce visually equivalent markup that is both
36 W3C compliant and compatible with most browsers.
37 </para>
38
39 &lfs101_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&tidy-html5-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&tidy-html5-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &tidy-html5-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &tidy-html5-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &tidy-html5-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &tidy-html5-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="cmake"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="libxslt"/>
85 </para>
86
87 <para condition="html" role="usernotes">User Notes:
88 <ulink url="&blfs-wiki;/tidy"/></para>
89
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of Tidy HTML5</title>
94
95 <para>
96 Install <application>Tidy HTML5</application> by running the following
97 commands:
98 </para>
99
100<screen><userinput>cd build/cmake &amp;&amp;
101
102cmake -DCMAKE_INSTALL_PREFIX=/usr \
103 -DCMAKE_BUILD_TYPE=Release \
104 -DBUILD_TAB2SPACE=ON \
105 ../.. &amp;&amp;
106
107make</userinput></screen>
108
109 <para>
110 This package does not come with a test suite.
111 </para>
112
113 <para>
114 Now, as the <systemitem class="username">root</systemitem> user:
115 </para>
116
117<screen role="root"><userinput>make install &amp;&amp;
118rm -fv /usr/lib/libtidy.a &amp;&amp;
119install -v -m755 tab2space /usr/bin</userinput></screen>
120
121 </sect2>
122
123 <sect2 role="commands">
124 <title>Command Explanations</title>
125
126 <para>
127 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
128 build the release library without any debug `assert` in the code.
129 </para>
130
131 <para>
132 <parameter>-DBUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
133 building the <command>tab2space</command> utility.
134 </para>
135
136 </sect2>
137
138 <sect2 role="configuration">
139 <title>Configuring Tidy HTML5</title>
140
141 <sect3>
142 <title>Config Files</title>
143
144 <para>
145 The absolute path of the file specified in <envar>HTML_TIDY</envar>.
146 </para>
147
148 </sect3>
149
150 <sect3>
151 <title>Configuration Information</title>
152
153 <para>
154 The default configuration options can be set in the file defined in
155 <envar>HTML_TIDY</envar>. Additional configuration options can be
156 passed to <command>tidy</command> via command line parameters or the
157 <option>-config &lt;file&gt;</option> parameter.
158 </para>
159
160 </sect3>
161
162 </sect2>
163
164 <sect2 role="content">
165 <title>Contents</title>
166
167 <segmentedlist>
168 <segtitle>Installed Programs</segtitle>
169 <segtitle>Installed Library</segtitle>
170 <segtitle>Installed Directory</segtitle>
171 <seglistitem>
172 <seg>tab2space and tidy</seg>
173 <seg>libtidy.so</seg>
174 <seg>/usr/share/doc/tidy-&tidy-html5-version;</seg>
175 </seglistitem>
176 </segmentedlist>
177
178 <variablelist>
179 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
180 <?dbfo list-presentation="list"?>
181 <?dbhtml list-presentation="table"?>
182
183 <varlistentry id="tab2space">
184 <term><command>tab2space</command></term>
185 <listitem>
186 <para>
187 is a utility to expand tabs and ensure consistent line endings
188 </para>
189 <indexterm zone="tidy-html5 tab2space">
190 <primary sortas="b-tab2space">tab2space</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="tidy">
196 <term><command>tidy</command></term>
197 <listitem>
198 <para>
199 validates, corrects, and pretty-prints HTML files
200 </para>
201 <indexterm zone="tidy-html5 tidy">
202 <primary sortas="b-tidy">tidy</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="libtidy">
208 <term>
209 <filename class="libraryfile">libtidy.so</filename>
210 </term>
211 <listitem>
212 <para>
213 library provides the <application>Tidy HTML5</application> API
214 functions to <command>tidy</command> and can also be called by other
215 programs
216 </para>
217 <indexterm zone="tidy-html5 libtidy">
218 <primary sortas="c-libtidy">libtidy.so</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 </variablelist>
224
225 </sect2>
226
227</sect1>
Note: See TracBrowser for help on using the repository browser.