1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY docbook-utils-download-http "http://sources-redhat.mirrors.redwire.net/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
8 | <!ENTITY docbook-utils-download-ftp "ftp://sources.redhat.com/pub/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
9 | <!ENTITY docbook-utils-size "125 KB">
|
---|
10 | <!ENTITY docbook-utils-buildsize "1.5 MB">
|
---|
11 | <!ENTITY docbook-utils-time ".04 SBU">
|
---|
12 | ]>
|
---|
13 |
|
---|
14 | <sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
|
---|
15 | <sect1info>
|
---|
16 | <othername>$LastChangedBy$</othername>
|
---|
17 | <date>$Date$</date>
|
---|
18 | </sect1info>
|
---|
19 | <?dbhtml filename="docbook-utils.html"?>
|
---|
20 | <title>DocBook-utils-&docbook-utils-version;</title>
|
---|
21 |
|
---|
22 |
|
---|
23 | <sect2>
|
---|
24 | <title>Introduction to <application>DocBook-utils</application></title>
|
---|
25 |
|
---|
26 | <para>The <application>DocBook-utils</application> package is a collection of
|
---|
27 | utility scripts used to convert and analyze <acronym>SGML</acronym> documents
|
---|
28 | in general, and DocBook files in particular. The scripts are used to convert
|
---|
29 | from DocBook or other <acronym>SGML</acronym> formats into
|
---|
30 | <quote>classical</quote> file formats like <acronym>HTML</acronym>, man, info,
|
---|
31 | <acronym>RTF</acronym> and many more. There's also a utility to compare two
|
---|
32 | <acronym>SGML</acronym> files and only display the differences in markup. This
|
---|
33 | is useful for comparing documents prepared for different languages.</para>
|
---|
34 |
|
---|
35 | <sect3><title>Package information</title>
|
---|
36 | <itemizedlist spacing='compact'>
|
---|
37 | <listitem><para>Download (HTTP): <ulink url="&docbook-utils-download-http;"/></para></listitem>
|
---|
38 | <listitem><para>Download (FTP): <ulink url="&docbook-utils-download-ftp;"/></para></listitem>
|
---|
39 | <listitem><para>Download size: &docbook-utils-size;</para></listitem>
|
---|
40 | <listitem><para>Estimated Disk space required: &docbook-utils-buildsize;</para></listitem>
|
---|
41 | <listitem><para>Estimated build time: &docbook-utils-time;</para></listitem></itemizedlist>
|
---|
42 | </sect3>
|
---|
43 |
|
---|
44 | <sect3><title><application>DocBook-utils</application> dependencies</title>
|
---|
45 |
|
---|
46 | <sect4><title>Required</title>
|
---|
47 | <para><xref linkend="openjade"/>,
|
---|
48 | <xref linkend="docbook-dsssl"/> and
|
---|
49 | <xref linkend="sgml-dtd-3"/></para></sect4>
|
---|
50 |
|
---|
51 | <sect4><title>Optional</title>
|
---|
52 | <para><xref linkend="jadetex"/> (for conversion to <acronym>DVI</acronym>,
|
---|
53 | <acronym>PS</acronym> and <acronym>PDF</acronym>),
|
---|
54 | <xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for conversion to
|
---|
55 | man and texinfo), and
|
---|
56 | <xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
|
---|
57 | (for conversion to <acronym>ASCII</acronym> text)</para></sect4>
|
---|
58 | </sect3>
|
---|
59 |
|
---|
60 | </sect2>
|
---|
61 |
|
---|
62 | <sect2>
|
---|
63 | <title>Installation of <application>DocBook-utils</application></title>
|
---|
64 |
|
---|
65 | <para>Install <application>DocBook-utils</application> by running the
|
---|
66 | following commands:</para>
|
---|
67 |
|
---|
68 | <screen><userinput><command>sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
69 | /etc/sgml/catalog &&
|
---|
70 | sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
71 | /etc/sgml/sgml-docbook.cat &&
|
---|
72 | ./configure --prefix=/usr &&
|
---|
73 | make &&
|
---|
74 | make install &&
|
---|
75 | cp /etc/sgml/catalog.orig /etc/sgml/catalog &&
|
---|
76 | cp /etc/sgml/sgml-docbook.cat.orig /etc/sgml/sgml-docbook.cat</command></userinput></screen>
|
---|
77 | </sect2>
|
---|
78 |
|
---|
79 | <sect2>
|
---|
80 | <title>Command explanations</title>
|
---|
81 |
|
---|
82 | <para><command>sed -i.orig -e ...</command>: These two <command>sed</command>'s
|
---|
83 | remove <application>OpenSP</application> catalog definitions from the
|
---|
84 | <acronym>SGML</acronym> catalogs because the SGMLDECL unicode.sd declaration
|
---|
85 | creates errors when <command>openjade</command> builds the
|
---|
86 | <application>DocBook-utils</application> documentation files. Backup copies of
|
---|
87 | the files are made and copied back to their original place after the build is
|
---|
88 | complete. Though these errors are harmless, and won't affect
|
---|
89 | <application>DocBook-utils</application> functionality after the build, the
|
---|
90 | declarations are temporarily removed to provide a clean package build.</para>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2>
|
---|
95 | <title>Contents</title>
|
---|
96 |
|
---|
97 | <para>The <application>DocBook-utils</application> package contains
|
---|
98 | <command>docbook2dvi</command>, <command>docbook2html</command>,
|
---|
99 | <command>docbook2man</command>, <command>docbook2pdf</command>,
|
---|
100 | <command>docbook2ps</command>, <command>docbook2rtf</command>,
|
---|
101 | <command>docbook2tex</command>, <command>docbook2texi</command>,
|
---|
102 | <command>docbook2txt</command>, <command>jw</command> and
|
---|
103 | <command>sgmldiff</command>.</para>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2><title>Description</title>
|
---|
108 |
|
---|
109 | <sect3><title>docbook2{dvi,html,man,pdf,ps,rtf,tex,texi,txt}</title>
|
---|
110 |
|
---|
111 | <para>The <command>docbook2{format}</command> scripts are simple one-line
|
---|
112 | wrappers to <command>jw</command>. They are provided as easy-to-remember
|
---|
113 | names used to convert DocBook or other <acronym>SGML</acronym> files to the
|
---|
114 | respective format.</para></sect3>
|
---|
115 |
|
---|
116 | <sect3><title>jw</title>
|
---|
117 |
|
---|
118 | <para><command>jw</command> is a script used to convert DocBook or other
|
---|
119 | <acronym>SGML</acronym> files to various output formats. It hides most of
|
---|
120 | <application>OpenJade</application>'s complexity and adds comfortable
|
---|
121 | features.</para></sect3>
|
---|
122 |
|
---|
123 | <sect3><title>sgmldiff</title>
|
---|
124 |
|
---|
125 | <para><command>sgmldiff</command> is used to compare two
|
---|
126 | <acronym>SGML</acronym> files and only return the differences in the markup.
|
---|
127 | This is especially useful to compare files that should be identical except
|
---|
128 | for language differences in the content.</para></sect3>
|
---|
129 |
|
---|
130 | </sect2>
|
---|
131 |
|
---|
132 | </sect1>
|
---|
133 |
|
---|