Author: manuel Date: 2005-05-02 12:56:54 -0600 (Mon, 02 May 2005) New Revision: 3941
Modified: trunk/BOOK/general/genutils/tidy.xml Log: Tagged tidy.xml Modified: trunk/BOOK/general/genutils/tidy.xml =================================================================== --- trunk/BOOK/general/genutils/tidy.xml 2005-05-02 18:38:23 UTC (rev 3940) +++ trunk/BOOK/general/genutils/tidy.xml 2005-05-02 18:56:54 UTC (rev 3941) @@ -17,180 +17,205 @@ ]> <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;"> -<sect1info> -<othername>$LastChangedBy$</othername> -<date>$Date$</date> -</sect1info> -<?dbhtml filename="tidy.html"?> -<title>HTML Tidy-&tidy-version;</title> -<indexterm zone="html-tidy"> -<primary sortas="a-HTML-Tidy">HTML Tidy</primary></indexterm> + <?dbhtml filename="tidy.html"?> + + <sect1info> + <othername>$LastChangedBy$</othername> + <date>$Date$</date> + </sect1info> + + <title>HTML Tidy-&tidy-version;</title> + + <indexterm zone="html-tidy"> + <primary sortas="a-HTML-Tidy">HTML Tidy</primary> + </indexterm> -<sect2> -<title>Introduction to <application>HTML Tidy</application></title> + <sect2 role="package"> + <title>Introduction to HTML Tidy</title> + + <para>The <application>HTML Tidy</application> package contains a + command line tool and libraries used to read HTML, XHTML and XML + files and write cleaned up markup. It detects and corrects many common coding + errors and strives to produce visually equivalent markup that is both + W3C compliant and compatible with most browsers.</para> + + <bridgehead renderas="sect3">Package Information</bridgehead> + <itemizedlist spacing="compact"> + <listitem> + <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para> + </listitem> + <listitem> + <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para> + </listitem> + <listitem> + <para>Download MD5 sum: &tidy-md5sum;</para> + </listitem> + <listitem> + <para>Download size: &tidy-size;</para> + </listitem> + <listitem> + <para>Estimated disk space required: &tidy-buildsize;</para> + </listitem> + <listitem> + <para>Estimated build time: &tidy-time;</para> + </listitem> + </itemizedlist> -<para>The <application><acronym>HTML</acronym> Tidy</application> package -contains a command line tool and libraries used to read -<acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym> -files and write cleaned up markup. It detects and corrects many common coding -errors and strives to produce visually equivalent markup that is both -<acronym>W3C</acronym> compliant and compatible with most browsers.</para> + <note> + <para><application>HTML Tidy</application> is + updated very frequently by its maintainers, and the source package listed + above may not be available at the listed URL due to the + release of a newer version. The most current source package can be always be + downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this + version is newer than the version listed above, the following instructions + should work, but have not yet been tested by BLFS. If you'd rather download + the version listed above, you can find it at + <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para> + </note> + + <bridgehead renderas="sect3">Additional Downloads</bridgehead> + + <bridgehead renderas="sect4">Documentation</bridgehead> + <itemizedlist spacing="compact"> + <listitem> + <para>Documentation: <ulink url="&tidy-docs-download;"/></para> + </listitem> + <listitem> + <para>Download MD5 sum: &tidy-docs-md5sum;</para> + </listitem> + <listitem> + <para>Download size: &tidy-docs-size;</para> + </listitem> + </itemizedlist> + + <bridgehead renderas="sect4">Patches</bridgehead> + <itemizedlist spacing="compact"> + <listitem> + <para>Required patch: <ulink + url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para> + </listitem> + </itemizedlist> + + <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead> + + <bridgehead renderas="sect4">Optional</bridgehead> + <para><ulink url="http://dmalloc.com/";>Dmalloc</ulink></para> + + </sect2> + + <sect2 role="installation"> + <title>Installation of HTML Tidy</title> -<sect3><title>Package information</title> -<itemizedlist spacing="compact"> -<listitem><para>Download (HTTP): -<ulink url="&tidy-download-http;"/></para></listitem> -<listitem><para>Download (FTP): -<ulink url="&tidy-download-ftp;"/></para></listitem> -<listitem><para>Download MD5 sum: &tidy-md5sum;</para></listitem> -<listitem><para>Download size: &tidy-size;</para></listitem> -<listitem><para>Estimated disk space required: -&tidy-buildsize;</para></listitem> -<listitem><para>Estimated build time: &tidy-time;</para></listitem> -</itemizedlist> + <para>The <application>HTML Tidy</application> documentation + is contained in a separate tarball. Unpack both the source and docs tarballs + before starting the build.</para> + + <para>Install <application>HTML Tidy</application> by + running the following commands:</para> -<note><para><application><acronym>HTML</acronym> Tidy</application> is -updated very frequently by its maintainers, and the source package listed -above may not be available at the listed <acronym>URL</acronym> due to the -release of a newer version. The most current source package can be always be -downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this -version is newer than the version listed above, the following instructions -should work, but have not yet been tested by BLFS. If you'd rather download -the version listed above, you can find it at -<ulink url="http://tidy.sourceforge.net/src/old/"/>.</para></note> -</sect3> - -<sect3><title>Additional downloads</title> -<sect4><title>Documentation</title> -<itemizedlist spacing="compact"> -<listitem><para>Documentation: <ulink url="&tidy-docs-download;"/></para> -</listitem> -<listitem><para>Download MD5 sum: &tidy-docs-md5sum;</para></listitem> -<listitem><para>Download size: &tidy-docs-size;</para></listitem> -</itemizedlist> -</sect4> - -<sect4><title>Patches</title> -<itemizedlist spacing="compact"> -<listitem><para>Required patch: <ulink -url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para> -</listitem> -</itemizedlist> -</sect4> -</sect3> - -<sect3><title><application><acronym>HTML</acronym> Tidy</application> -dependencies</title> -<sect4><title>Optional</title> -<para><ulink url="http://dmalloc.com/";>Dmalloc</ulink></para> -</sect4> -</sect3> - -</sect2> - -<sect2> -<title>Installation of <application><acronym>HTML</acronym> -Tidy</application></title> - -<para>The <application><acronym>HTML</acronym> Tidy</application> documentation -is contained in a separate tarball. Unpack both the source and docs tarballs -before starting the build.</para> - -<para>Install <application><acronym>HTML</acronym> Tidy</application> by -running the following commands:</para> - -<screen><userinput><command>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch && +<screen><userinput>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch && sh build/gnuauto/setup.sh && ./configure --prefix=/usr && -make</command></userinput></screen> +make</userinput></screen> <para>Now, as the root user:</para> - -<screen><userinput role='root'><command>make install && + + <para>Now, as the <systemitem class="username">root</systemitem> user:</para> + +<screen role="root"><userinput>make install && install -v -m644 htmldoc/man_page.txt \ /usr/share/man/man1/tidy.1 && install -v -d -m755 /usr/share/doc/tidy && -cp -v -R htmldoc /usr/share/doc/tidy</command></userinput></screen> +cp -v -R htmldoc /usr/share/doc/tidy</userinput></screen> + + </sect2> + + <sect2 role="commands"> + <title>Command Explanations</title> -</sect2> + <para><command>sh build/gnuauto/setup.sh</command>: This command prepares + the source tree for building using the GNU <quote>Auto</quote> tools.</para> + + </sect2> + + <sect2 role="configuration"> + <title>Configuring HTML Tidy</title> -<sect2> -<title>Command explanations</title> + <sect3> + <title>Config Files</title> + + <para>The absolute path of the file specified in + <envar>$HTML_TIDY</envar>.</para> + + </sect3> -<para><command>sh build/gnuauto/setup.sh</command>: This command prepares the -source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote> -tools.</para> + <sect3> + <title>Configuration Information</title> + + <para>The default configuration options can be set in the file defined in + <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to + <command>tidy</command> via command line parameters or the + <option>-config <file></option> parameter.</para> + + </sect3> + + </sect2> + + <sect2 role="content"> + <title>Contents</title> -</sect2> + <segmentedlist> + <segtitle>Installed Programs</segtitle> + <segtitle>Installed Library</segtitle> + <segtitle>Installed Directory</segtitle> + <seglistitem> + <seg>tab2space and tidy</seg> + <seg>libtidy.[so,a]</seg> + <seg>/usr/share/doc/tidy</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="tab2space"> + <term><command>tab2space</command></term> + <listitem> + <para>is a utility to expand tabs and ensure consistent line + endings.</para> + <indexterm zone="html-tidy tab2space"> + <primary sortas="b-tab2space">tab2space</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="tidy"> + <term><command>tidy</command></term> + <listitem> + <para>validates, corrects, and pretty-prints HTML files.</para> + <indexterm zone="html-tidy tidy"> + <primary sortas="b-tidy">tidy</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libtidy"> + <term><filename class='libraryfile'>libtidy.[so,a]</filename></term> + <listitem> + <para>libraries provide the <application>HTML Tidy</application> API + functions to <command>tidy</command> and can also be called by other + programs.</para> + <indexterm zone="html-tidy libtidy"> + <primary sortas="c-libtidy">libtidy.[so,a]</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> -<sect2> -<title>Configuring <application><acronym>HTML</acronym> -Tidy</application></title> + </sect2> -<sect3><title>Config files</title> -<para>The absolute path of the file specified in -<envar>$HTML_TIDY</envar>.</para> -</sect3> - -<sect3><title>Configuration Information</title> - -<para>The default configuration options can be set in the file defined in -<envar>$HTML_TIDY</envar>. Additional configuration options can be passed to -<command>tidy</command> via command line parameters or the -<parameter>-config <file></parameter> parameter.</para> -</sect3> - -</sect2> - -<sect2> -<title>Contents</title> - -<segmentedlist> -<segtitle>Installed Programs</segtitle> -<segtitle>Installed Library</segtitle> -<segtitle>Installed Directory</segtitle> -<seglistitem> -<seg>tab2space and tidy</seg> -<seg>libtidy.[so,a]</seg> -<seg>/usr/share/doc/tidy</seg> -</seglistitem> -</segmentedlist> - -<variablelist> -<bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> - -<varlistentry id="tab2space"> -<term><command>tab2space</command></term> -<listitem><para>is a utility to expand tabs and ensure consistent line -endings.</para> -<indexterm zone="html-tidy tab2space"> -<primary sortas="b-tab2space">tab2space</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="tidy"> -<term><command>tidy</command></term> -<listitem><para>validates, corrects, and pretty-prints <acronym>HTML</acronym> -files.</para> -<indexterm zone="html-tidy tidy"> -<primary sortas="b-tidy">tidy</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libtidy"> -<term><filename class='libraryfile'>libtidy.[so,a]</filename></term> -<listitem><para>libraries provide the -<application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym> -functions to <command>tidy</command> and can also be called by other -programs.</para> -<indexterm zone="html-tidy libtidy"> -<primary sortas="c-libtidy">libtidy.[so,a]</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> - </sect1> -- http://linuxfromscratch.org/mailman/listinfo/blfs-book FAQ: http://www.linuxfromscratch.org/blfs/faq.html Unsubscribe: See the above information page
