[d7fb898e] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[d7fb898e] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY docbook-utils-download-http "https://sourceware.org/ftp/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
| 8 | <!ENTITY docbook-utils-download-ftp "ftp://sourceware.org/pub/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
[2dde015] | 9 | <!ENTITY docbook-utils-md5sum "6b41b18c365c01f225bc417cf632d81c">
|
---|
[e8b9dbf7] | 10 | <!ENTITY docbook-utils-size "124 KB">
|
---|
| 11 | <!ENTITY docbook-utils-buildsize "1.44 MB">
|
---|
[738c5f8] | 12 | <!ENTITY docbook-utils-time "less than 0.1 SBU">
|
---|
[d7fb898e] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
|
---|
[5bae145] | 16 | <?dbhtml filename="docbook-utils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>DocBook-utils-&docbook-utils-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="docbook-utils">
|
---|
| 25 | <primary sortas="a-DocBook-utils">DocBook-utils</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to DocBook-utils</title>
|
---|
| 30 |
|
---|
[fa3edfef] | 31 | <para>
|
---|
| 32 | The <application>DocBook-utils</application> package is a collection
|
---|
| 33 | of utility scripts used to convert and analyze SGML documents in general,
|
---|
| 34 | and DocBook files in particular. The scripts are used to convert from
|
---|
| 35 | DocBook or other SGML formats into <quote>classical</quote> file formats
|
---|
| 36 | like HTML, man, info, RTF and many more. There's also a utility to compare
|
---|
| 37 | two SGML files and only display the differences in markup. This is useful
|
---|
| 38 | for comparing documents prepared for different languages.
|
---|
| 39 | </para>
|
---|
[5bae145] | 40 |
|
---|
[48cb482] | 41 | &lfs112_checked;
|
---|
[00555b0f] | 42 |
|
---|
[5bae145] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
[fa3edfef] | 46 | <para>
|
---|
| 47 | Download (HTTP): <ulink url="&docbook-utils-download-http;"/>
|
---|
| 48 | </para>
|
---|
[5bae145] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[fa3edfef] | 51 | <para>
|
---|
| 52 | Download (FTP): <ulink url="&docbook-utils-download-ftp;"/>
|
---|
| 53 | </para>
|
---|
[5bae145] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[fa3edfef] | 56 | <para>
|
---|
| 57 | Download MD5 sum: &docbook-utils-md5sum;
|
---|
| 58 | </para>
|
---|
[5bae145] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[fa3edfef] | 61 | <para>
|
---|
| 62 | Download size: &docbook-utils-size;
|
---|
| 63 | </para>
|
---|
[5bae145] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[fa3edfef] | 66 | <para>
|
---|
| 67 | Estimated disk space required: &docbook-utils-buildsize;
|
---|
| 68 | </para>
|
---|
[5bae145] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[fa3edfef] | 71 | <para>
|
---|
| 72 | Estimated build time: &docbook-utils-time;
|
---|
| 73 | </para>
|
---|
[5bae145] | 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
[8a67713c] | 77 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 78 | <itemizedlist spacing='compact'>
|
---|
| 79 | <listitem>
|
---|
[fa3edfef] | 80 | <para>
|
---|
| 81 | Required patch: <ulink url=
|
---|
| 82 | "&patch-root;/docbook-utils-&docbook-utils-version;-grep_fix-1.patch"/>
|
---|
| 83 | </para>
|
---|
[8a67713c] | 84 | </listitem>
|
---|
| 85 | </itemizedlist>
|
---|
| 86 |
|
---|
[5bae145] | 87 | <bridgehead renderas="sect3">DocBook-utils Dependencies</bridgehead>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[3f8a5e2] | 90 | <para role="required">
|
---|
[dc6ba1c0] | 91 | <xref linkend="openjade"/>,
|
---|
[3f8a5e2] | 92 | <xref linkend="docbook-dsssl"/>, and
|
---|
| 93 | <xref linkend="sgml-dtd-3"/>
|
---|
| 94 | </para>
|
---|
[5bae145] | 95 |
|
---|
[738c5f8] | 96 | <bridgehead renderas="sect4">Optional (Runtime Dependencies Only)</bridgehead>
|
---|
[3f8a5e2] | 97 | <para role="optional">
|
---|
[4392a40] | 98 | <xref role="runtime" linkend="perl-sgmlspm"/> (for conversion to man and
|
---|
[f5cdf41] | 99 | texinfo), and
|
---|
| 100 | <xref role="runtime" linkend="lynx"/> or
|
---|
| 101 | <xref role="runtime" linkend="Links"/> or
|
---|
[1eac9eb] | 102 | <ulink role="runtime" url="&w3m-url;">W3m</ulink>
|
---|
| 103 | (for conversion to ASCII text)
|
---|
[3f8a5e2] | 104 | </para>
|
---|
[5bae145] | 105 |
|
---|
[977061b0] | 106 | <para condition="html" role="usernotes">User Notes:
|
---|
| 107 | <ulink url="&blfs-wiki;/docbook-utils"/></para>
|
---|
| 108 |
|
---|
[5bae145] | 109 | </sect2>
|
---|
| 110 |
|
---|
| 111 | <sect2 role="installation">
|
---|
| 112 | <title>Installation of DocBook-utils</title>
|
---|
| 113 |
|
---|
[fa3edfef] | 114 | <para>
|
---|
| 115 | Install <application>DocBook-utils</application> by running the
|
---|
| 116 | following commands:
|
---|
| 117 | </para>
|
---|
[2dde015] | 118 |
|
---|
[e958dbb2] | 119 | <screen><userinput>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch &&
|
---|
[8fc8e98] | 120 | sed -i 's:/html::' doc/HTML/Makefile.in &&
|
---|
[512f843] | 121 |
|
---|
[fc6725ee] | 122 | ./configure --prefix=/usr --mandir=/usr/share/man &&
|
---|
[5bae145] | 123 | make</userinput></screen>
|
---|
[2dde015] | 124 |
|
---|
[fa3edfef] | 125 | <para>
|
---|
| 126 | This package does not come with a test suite.
|
---|
| 127 | </para>
|
---|
[738c5f8] | 128 |
|
---|
[fa3edfef] | 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
[eb091c9] | 132 |
|
---|
[cf67717] | 133 | <screen role="root"><userinput>make docdir=/usr/share/doc install</userinput></screen>
|
---|
[eb091c9] | 134 |
|
---|
[fa3edfef] | 135 | <para>
|
---|
| 136 | Many packages use an alternate name for the
|
---|
| 137 | <application>DocBook-utils</application> scripts. If you wish to create
|
---|
| 138 | these alternate names, use the following command as
|
---|
| 139 | the <systemitem class="username">root</systemitem> user:
|
---|
| 140 | </para>
|
---|
[5bae145] | 141 |
|
---|
| 142 | <screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
|
---|
[eb091c9] | 143 | do
|
---|
[cf67717] | 144 | ln -svf docbook2$doctype /usr/bin/db2$doctype
|
---|
[5bae145] | 145 | done</userinput></screen>
|
---|
| 146 |
|
---|
[4570991] | 147 | <note>
|
---|
[fa3edfef] | 148 | <para>
|
---|
| 149 | The <command>jw</command> script uses the <command>which</command>
|
---|
| 150 | command to locate required utilities. You must install
|
---|
| 151 | <xref linkend="which"/> before attempting to use any of the
|
---|
| 152 | <application>DocBook-utils</application> programs.
|
---|
| 153 | </para>
|
---|
[4570991] | 154 | </note>
|
---|
| 155 |
|
---|
[5bae145] | 156 | </sect2>
|
---|
| 157 |
|
---|
[ecb6484a] | 158 | <sect2 role="commands">
|
---|
| 159 | <title>Command Explanations</title>
|
---|
| 160 |
|
---|
[fa3edfef] | 161 | <para>
|
---|
| 162 | <command>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch</command>:
|
---|
| 163 | This patch corrects the syntax in the jw (Jade Wrapper) script which is
|
---|
| 164 | at the heart of much db2* processing, so that the current version of
|
---|
| 165 | <application>grep</application> will not reject it.
|
---|
| 166 | </para>
|
---|
[8a67713c] | 167 |
|
---|
[fa3edfef] | 168 | <para>
|
---|
| 169 | <command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
|
---|
| 170 | This command changes the installation directory of the HTML documents.
|
---|
| 171 | </para>
|
---|
[ecb6484a] | 172 |
|
---|
[fa3edfef] | 173 | <para>
|
---|
| 174 | <option>docdir=/usr/share/doc</option>: This option is placed on the
|
---|
| 175 | <command>make install</command> line because is is not
|
---|
| 176 | recognized by <command>configure</command>.
|
---|
| 177 | </para>
|
---|
[cf67717] | 178 |
|
---|
[ecb6484a] | 179 | </sect2>
|
---|
| 180 |
|
---|
[5bae145] | 181 | <sect2 role="content">
|
---|
| 182 | <title>Contents</title>
|
---|
| 183 |
|
---|
| 184 | <segmentedlist>
|
---|
| 185 | <segtitle>Installed Programs</segtitle>
|
---|
| 186 | <segtitle>Installed Libraries</segtitle>
|
---|
| 187 | <segtitle>Installed Directories</segtitle>
|
---|
| 188 | <segtitle>Installed Symlinks</segtitle>
|
---|
| 189 |
|
---|
| 190 | <seglistitem>
|
---|
| 191 | <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
|
---|
| 192 | docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and
|
---|
| 193 | sgmldiff</seg>
|
---|
| 194 | <seg>None</seg>
|
---|
[ecb6484a] | 195 | <seg>/usr/share/doc/docbook-utils-&docbook-utils-version; and
|
---|
[5bae145] | 196 | /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
|
---|
| 197 | <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi,
|
---|
| 198 | and db2txt</seg>
|
---|
| 199 | </seglistitem>
|
---|
| 200 | </segmentedlist>
|
---|
| 201 |
|
---|
| 202 | <variablelist>
|
---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 204 | <?dbfo list-presentation="list"?>
|
---|
| 205 | <?dbhtml list-presentation="table"?>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="docbook2">
|
---|
| 208 | <term><command>docbook2*</command></term>
|
---|
| 209 | <listitem>
|
---|
[fa3edfef] | 210 | <para>
|
---|
| 211 | are simple one-line wrapper scripts to <command>jw</command>.
|
---|
| 212 | They are provided as easy-to-remember names used to convert
|
---|
[4c24eb0a] | 213 | DocBook or other SGML files to the respective format
|
---|
[fa3edfef] | 214 | </para>
|
---|
[5bae145] | 215 | <indexterm zone="docbook-utils docbook2">
|
---|
| 216 | <primary sortas="b-docbook2-star">docbook2*</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="db2">
|
---|
| 222 | <term><command>db2*</command></term>
|
---|
| 223 | <listitem>
|
---|
[fa3edfef] | 224 | <para>
|
---|
| 225 | are symlinks pointing at the respectively named
|
---|
| 226 | <command>docbook2*</command> commands, created to satisfy some
|
---|
[4c24eb0a] | 227 | program's use of these names
|
---|
[fa3edfef] | 228 | </para>
|
---|
[5bae145] | 229 | <indexterm zone="docbook-utils db2">
|
---|
[b960e3ec] | 230 | <primary sortas="b-db2-star">db2*</primary>
|
---|
[5bae145] | 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
| 234 |
|
---|
| 235 | <varlistentry id="jw">
|
---|
| 236 | <term><command>jw</command></term>
|
---|
| 237 | <listitem>
|
---|
[fa3edfef] | 238 | <para>
|
---|
| 239 | is a script used to convert DocBook or other SGML files to various
|
---|
| 240 | output formats. It hides most of
|
---|
| 241 | <application>OpenJade</application>'s complexity and adds
|
---|
[4c24eb0a] | 242 | comfortable features
|
---|
[fa3edfef] | 243 | </para>
|
---|
[5bae145] | 244 | <indexterm zone="docbook-utils jw">
|
---|
| 245 | <primary sortas="b-jw">jw</primary>
|
---|
| 246 | </indexterm>
|
---|
| 247 | </listitem>
|
---|
| 248 | </varlistentry>
|
---|
| 249 |
|
---|
| 250 | <varlistentry id="sgmldiff">
|
---|
| 251 | <term><command>sgmldiff</command></term>
|
---|
| 252 | <listitem>
|
---|
[fa3edfef] | 253 | <para>
|
---|
| 254 | is used to compare two SGML files and only return the differences
|
---|
| 255 | in the markup. This is especially useful to compare files that
|
---|
[4c24eb0a] | 256 | should be identical except for language differences in the content
|
---|
[fa3edfef] | 257 | </para>
|
---|
[5bae145] | 258 | <indexterm zone="docbook-utils sgmldiff">
|
---|
| 259 | <primary sortas="b-sgmldiff">sgmldiff</primary>
|
---|
| 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
| 263 |
|
---|
| 264 | </variablelist>
|
---|
| 265 |
|
---|
| 266 | </sect2>
|
---|
[d7fb898e] | 267 |
|
---|
| 268 | </sect1>
|
---|