Changeset c18d3b25


Ignore:
Timestamp:
05/02/2005 06:56:54 PM (19 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 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, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
6247293
Parents:
5b6516d
Message:

Tagged tidy.xml

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • general/genutils/tidy.xml

    r5b6516d rc18d3b25  
    1818
    1919<sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
    20 <sect1info>
    21 <othername>$LastChangedBy$</othername>
    22 <date>$Date$</date>
    23 </sect1info>
    24 <?dbhtml filename="tidy.html"?>
    25 <title>HTML Tidy-&tidy-version;</title>
    26 <indexterm zone="html-tidy">
    27 <primary sortas="a-HTML-Tidy">HTML Tidy</primary></indexterm>
    28 
    29 <sect2>
    30 <title>Introduction to <application>HTML Tidy</application></title>
    31 
    32 <para>The <application><acronym>HTML</acronym> Tidy</application> package
    33 contains a command line tool and libraries used to read
    34 <acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym>
    35 files and write cleaned up markup. It detects and corrects many common coding
    36 errors and strives to produce visually equivalent markup that is both
    37 <acronym>W3C</acronym> compliant and compatible with most browsers.</para>
    38 
    39 <sect3><title>Package information</title>
    40 <itemizedlist spacing="compact">
    41 <listitem><para>Download (HTTP):
    42 <ulink url="&tidy-download-http;"/></para></listitem>
    43 <listitem><para>Download (FTP):
    44 <ulink url="&tidy-download-ftp;"/></para></listitem>
    45 <listitem><para>Download MD5 sum: &tidy-md5sum;</para></listitem>
    46 <listitem><para>Download size: &tidy-size;</para></listitem>
    47 <listitem><para>Estimated disk space required:
    48 &tidy-buildsize;</para></listitem>
    49 <listitem><para>Estimated build time: &tidy-time;</para></listitem>
    50 </itemizedlist>
    51 
    52 <note><para><application><acronym>HTML</acronym> Tidy</application> is
    53 updated very frequently by its maintainers, and the source package listed
    54 above may not be available at the listed <acronym>URL</acronym> due to the
    55 release of a newer version. The most current source package can be always be
    56 downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this
    57 version is newer than the version listed above, the following instructions
    58 should work, but have not yet been tested by BLFS. If you'd rather download
    59 the version listed above, you can find it at
    60 <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para></note>
    61 </sect3>
    62 
    63 <sect3><title>Additional downloads</title>
    64 <sect4><title>Documentation</title>
    65 <itemizedlist spacing="compact">
    66 <listitem><para>Documentation: <ulink url="&tidy-docs-download;"/></para>
    67 </listitem>
    68 <listitem><para>Download MD5 sum: &tidy-docs-md5sum;</para></listitem>
    69 <listitem><para>Download size: &tidy-docs-size;</para></listitem>
    70 </itemizedlist>
    71 </sect4>
    72 
    73 <sect4><title>Patches</title>
    74 <itemizedlist spacing="compact">
    75 <listitem><para>Required patch: <ulink
    76 url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
    77 </listitem>
    78 </itemizedlist>
    79 </sect4>
    80 </sect3>
    81 
    82 <sect3><title><application><acronym>HTML</acronym> Tidy</application>
    83 dependencies</title>
    84 <sect4><title>Optional</title>
    85 <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
    86 </sect4>
    87 </sect3>
    88 
    89 </sect2>
    90 
    91 <sect2>
    92 <title>Installation of <application><acronym>HTML</acronym>
    93 Tidy</application></title>
    94 
    95 <para>The <application><acronym>HTML</acronym> Tidy</application> documentation
    96 is contained in a separate tarball. Unpack both the source and docs tarballs
    97 before starting the build.</para>
    98 
    99 <para>Install <application><acronym>HTML</acronym> Tidy</application> by
    100 running the following commands:</para>
    101 
    102 <screen><userinput><command>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch &amp;&amp;
     20  <?dbhtml filename="tidy.html"?>
     21 
     22  <sect1info>
     23    <othername>$LastChangedBy$</othername>
     24    <date>$Date$</date>
     25  </sect1info>
     26 
     27  <title>HTML Tidy-&tidy-version;</title>
     28 
     29  <indexterm zone="html-tidy">
     30    <primary sortas="a-HTML-Tidy">HTML Tidy</primary>
     31  </indexterm>
     32
     33  <sect2 role="package">
     34    <title>Introduction to HTML Tidy</title>
     35   
     36    <para>The <application>HTML Tidy</application> package contains a
     37    command line tool and libraries used to read HTML, XHTML and XML
     38    files and write cleaned up markup. It detects and corrects many common coding
     39    errors and strives to produce visually equivalent markup that is both
     40    W3C compliant and compatible with most browsers.</para>
     41   
     42    <bridgehead renderas="sect3">Package Information</bridgehead>
     43    <itemizedlist spacing="compact">
     44      <listitem>
     45        <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para>
     46      </listitem>
     47      <listitem>
     48        <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para>
     49      </listitem>
     50      <listitem>
     51        <para>Download MD5 sum: &tidy-md5sum;</para>
     52      </listitem>
     53      <listitem>
     54        <para>Download size: &tidy-size;</para>
     55      </listitem>
     56      <listitem>
     57        <para>Estimated disk space required: &tidy-buildsize;</para>
     58      </listitem>
     59      <listitem>
     60        <para>Estimated build time: &tidy-time;</para>
     61      </listitem>
     62    </itemizedlist>
     63
     64    <note>
     65      <para><application>HTML Tidy</application> is
     66      updated very frequently by its maintainers, and the source package listed
     67      above may not be available at the listed URL due to the
     68      release of a newer version. The most current source package can be always be
     69      downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this
     70      version is newer than the version listed above, the following instructions
     71      should work, but have not yet been tested by BLFS. If you'd rather download
     72      the version listed above, you can find it at
     73      <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para>
     74    </note>
     75   
     76    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
     77   
     78    <bridgehead renderas="sect4">Documentation</bridgehead>
     79    <itemizedlist spacing="compact">
     80      <listitem>
     81       <para>Documentation: <ulink url="&tidy-docs-download;"/></para>
     82      </listitem>
     83      <listitem>
     84        <para>Download MD5 sum: &tidy-docs-md5sum;</para>
     85      </listitem>
     86      <listitem>
     87        <para>Download size: &tidy-docs-size;</para>
     88      </listitem>
     89    </itemizedlist>
     90   
     91    <bridgehead renderas="sect4">Patches</bridgehead>
     92    <itemizedlist spacing="compact">
     93      <listitem>
     94        <para>Required patch: <ulink
     95        url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
     96      </listitem>
     97    </itemizedlist>
     98   
     99    <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
     100   
     101    <bridgehead renderas="sect4">Optional</bridgehead>
     102    <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
     103   
     104  </sect2>
     105 
     106  <sect2 role="installation">
     107    <title>Installation of HTML Tidy</title>
     108
     109    <para>The <application>HTML Tidy</application> documentation
     110    is contained in a separate tarball. Unpack both the source and docs tarballs
     111    before starting the build.</para>
     112   
     113    <para>Install <application>HTML Tidy</application> by
     114    running the following commands:</para>
     115
     116<screen><userinput>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch &amp;&amp;
    103117sh build/gnuauto/setup.sh &amp;&amp;
    104118./configure --prefix=/usr &amp;&amp;
    105 make</command></userinput></screen>
     119make</userinput></screen>
    106120
    107121<para>Now, as the root user:</para>
    108 
    109 <screen><userinput role='root'><command>make install &amp;&amp;
     122   
     123    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     124   
     125<screen role="root"><userinput>make install &amp;&amp;
    110126install -v -m644 htmldoc/man_page.txt \
    111127    /usr/share/man/man1/tidy.1 &amp;&amp;
    112128install -v -d -m755 /usr/share/doc/tidy &amp;&amp;
    113 cp -v -R htmldoc /usr/share/doc/tidy</command></userinput></screen>
    114 
    115 </sect2>
    116 
    117 <sect2>
    118 <title>Command explanations</title>
    119 
    120 <para><command>sh build/gnuauto/setup.sh</command>: This command prepares the
    121 source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote>
    122 tools.</para>
    123 
    124 </sect2>
    125 
    126 <sect2>
    127 <title>Configuring <application><acronym>HTML</acronym>
    128 Tidy</application></title>
    129 
    130 <sect3><title>Config files</title>
    131 <para>The absolute path of the file specified in
    132 <envar>$HTML_TIDY</envar>.</para>
    133 </sect3>
    134 
    135 <sect3><title>Configuration Information</title>
    136 
    137 <para>The default configuration options can be set in the file defined in
    138 <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
    139 <command>tidy</command> via command line parameters or the
    140 <parameter>-config &lt;file&gt;</parameter> parameter.</para>
    141 </sect3>
    142 
    143 </sect2>
    144 
    145 <sect2>
    146 <title>Contents</title>
    147 
    148 <segmentedlist>
    149 <segtitle>Installed Programs</segtitle>
    150 <segtitle>Installed Library</segtitle>
    151 <segtitle>Installed Directory</segtitle>
    152 <seglistitem>
    153 <seg>tab2space and tidy</seg>
    154 <seg>libtidy.[so,a]</seg>
    155 <seg>/usr/share/doc/tidy</seg>
    156 </seglistitem>
    157 </segmentedlist>
    158 
    159 <variablelist>
    160 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
    161 <?dbfo list-presentation="list"?>
    162 
    163 <varlistentry id="tab2space">
    164 <term><command>tab2space</command></term>
    165 <listitem><para>is a utility to expand tabs and ensure consistent line
    166 endings.</para>
    167 <indexterm zone="html-tidy tab2space">
    168 <primary sortas="b-tab2space">tab2space</primary></indexterm>
    169 </listitem>
    170 </varlistentry>
    171 
    172 <varlistentry id="tidy">
    173 <term><command>tidy</command></term>
    174 <listitem><para>validates, corrects, and pretty-prints <acronym>HTML</acronym>
    175 files.</para>
    176 <indexterm zone="html-tidy tidy">
    177 <primary sortas="b-tidy">tidy</primary></indexterm>
    178 </listitem>
    179 </varlistentry>
    180 
    181 <varlistentry id="libtidy">
    182 <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
    183 <listitem><para>libraries provide the
    184 <application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym>
    185 functions to <command>tidy</command> and can also be called by other
    186 programs.</para>
    187 <indexterm zone="html-tidy libtidy">
    188 <primary sortas="c-libtidy">libtidy.[so,a]</primary></indexterm>
    189 </listitem>
    190 </varlistentry>
    191 </variablelist>
    192 
    193 </sect2>
     129cp -v -R htmldoc /usr/share/doc/tidy</userinput></screen>
     130   
     131  </sect2>
     132 
     133  <sect2 role="commands">
     134    <title>Command Explanations</title>
     135
     136    <para><command>sh build/gnuauto/setup.sh</command>: This command prepares
     137    the source tree for building using the GNU <quote>Auto</quote> tools.</para>
     138   
     139  </sect2>
     140 
     141  <sect2 role="configuration">
     142    <title>Configuring HTML Tidy</title>
     143
     144    <sect3>
     145      <title>Config Files</title>
     146     
     147      <para>The absolute path of the file specified in
     148      <envar>$HTML_TIDY</envar>.</para>
     149   
     150    </sect3>
     151
     152    <sect3>
     153      <title>Configuration Information</title>
     154     
     155      <para>The default configuration options can be set in the file defined in
     156      <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
     157      <command>tidy</command> via command line parameters or the
     158      <option>-config &lt;file&gt;</option> parameter.</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,a]</seg>
     174    <seg>/usr/share/doc/tidy</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>is a utility to expand tabs and ensure consistent line
     187          endings.</para>
     188          <indexterm zone="html-tidy tab2space">
     189            <primary sortas="b-tab2space">tab2space</primary>
     190          </indexterm>
     191        </listitem>
     192      </varlistentry>
     193     
     194      <varlistentry id="tidy">
     195        <term><command>tidy</command></term>
     196        <listitem>
     197          <para>validates, corrects, and pretty-prints HTML files.</para>
     198          <indexterm zone="html-tidy tidy">
     199            <primary sortas="b-tidy">tidy</primary>
     200          </indexterm>
     201        </listitem>
     202      </varlistentry>
     203     
     204      <varlistentry id="libtidy">
     205        <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
     206        <listitem>
     207          <para>libraries provide the <application>HTML Tidy</application> API
     208          functions to <command>tidy</command> and can also be called by other
     209          programs.</para>
     210          <indexterm zone="html-tidy libtidy">
     211            <primary sortas="c-libtidy">libtidy.[so,a]</primary>
     212          </indexterm>
     213        </listitem>
     214      </varlistentry>
     215   
     216    </variablelist>
     217
     218  </sect2>
    194219
    195220</sect1>
Note: See TracChangeset for help on using the changeset viewer.