1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!ENTITY jw SYSTEM "refentry/jw.sgml">
3 <!ENTITY docbook2man SYSTEM "refentry/docbook2man-spec.pl.sgml">
4 <!ENTITY docbook2texi SYSTEM "refentry/docbook2texi-spec.pl.sgml">
5 <!ENTITY backend-spec SYSTEM "refentry/backend-spec.sgml">
6 <!ENTITY frontend-spec SYSTEM "refentry/frontend-spec.sgml">
7 <!ENTITY sgmldiff SYSTEM "refentry/sgmldiff.sgml">
8 <!ENTITY version SYSTEM "version">
11 <book lang="en" id="docbook-utils">
13 <title>DocBook Utils</title>
14 <pubdate>18 June 2000</pubdate>
17 <para>Permission is granted to copy, distribute and/or modify this
18 document under the terms of the GNU Free Documentation License,
19 Version 1.1 or any later version published by the Free Software
20 Foundation. A copy of the license is included in the section
21 entitled "GNU Free Documentation License".</para>
25 <para>This documentation describes the DocBook-utils version
28 <para>The DocBook-utils are a collection of various utilites to
29 convert and analyse SGML documents in general and DocBook files
30 in particular. They are developped by many authors and released
31 under GPL licence.</para>
36 <firstname>Eric</firstname> <surname>Bischoff</surname>
38 <address><email>ebisch@cybercable.tm.fr</email></address>
42 <firstname>Jochem</firstname> <surname>Huhmann</surname>
44 <address><email>joh@revier.com</email></address>
48 <firstname>Steve</firstname> <surname>Cheng</surname>
50 <address><email>steve@ggi-project.org</email></address>
54 <firstname>Frederik</firstname> <surname>Fouvry</surname>
56 <address><email>fouvry@sfs.nphil.uni-tuebingen.de</email></address>
63 <chapter id="introduction">
66 <firstname>Eric</firstname> <surname>Bischoff</surname>
69 <title>Introduction</title>
71 <para>The DocBook-utils are a collection of various utilites to
72 convert and analyse SGML documents in general and DocBook files
73 in particular. They are developped by many authors and released
74 under GPL licence.</para>
76 <para><ulink url="http://www.oasis-open.org/docbook/">DocBook</ulink>
77 is a SGML-based or XML-based standard for writing technical
78 documentation defined by the DocBook Technical Committee of the
79 OASIS consortium.</para>
81 <para>The DocBook-utils try to be as general as possible, and
82 therefore it is possible to use them with other SGML formats
83 than DocBook, like TEI or HTML. But each time there was an
84 opportunity to make them biased to DocBook to ease the life of
85 DocBook users, this opportunity has been given a higher priority
86 than generality considerations. This is why this package is not
87 called "SGML-utils".</para>
89 <para>The DocBook-utils are independant of any existing distribution
90 of SGML parsers and of DocBook resources. However, they conform
91 with the new draft on SGML and DocBook standardization being
92 discussed at Linux Standard Base project.</para>
94 <para>So far, the DocBook-utils only consist of:
97 <para><application>jw</application>, a script used to convert
98 from DocBook or other SGML formats into "classical" file
99 formats like HTML, man, info, RTF...</para>
102 <para><application>sgmldiff</application>, a script used to
103 compare the markup of a SGML file with its translation into
104 another language.</para>
107 but we would like to see them accomplish other tasks in the future:
110 <para>Conversion from "legacy" formats like LinuxDoc, man,
111 info, HTML or PDF into DocBook.</para>
114 <para>Refined analysis of DocBook files like a "sgmlgrep"
115 program that would allow context-sensitive searchs.</para>
118 <para>Support for XML.</para>
123 <para>If you want to help or keep informed of the latest developments,
124 please subscribe to the "docbook-utils@bazar.conectiva.com.br"
125 mailing list. This list has been set up to allow collaborative
130 <simpara>To subscribe: Send a message to
131 <email>docbook-utils-subscribe@bazar.conectiva.com.br</email>
132 - you will get a confirmation message, just reply to it.</simpara>
134 <simpara>To unsubscribe: Send a message to
135 <email>docbook-utils-unsubscribe@bazar.conectiva.com.br</email>
136 and reply to the confirmation message</simpara>
138 <simpara>For any additional information, write to <ulink
139 url="mailto:godoy@conectiva.com.br">Jorge Godoy</ulink> who is
140 the maintainer of this list.</simpara>
145 <chapter id="intro-jw">
148 <firstname>Jochem</firstname> <surname>Huhmann</surname>
154 <title>Command reference</title>
156 <para><citerefentry> <refentrytitle>jw</refentrytitle>
157 <manvolnum>1</manvolnum> </citerefentry> converts DocBook or other
158 SGML-based formats into "classical" file formats.</para>
160 <para>The modular architecture used by
161 <application>jw</application> allows to write plug-in
162 programs (we call them <firstterm>backends</firstterm> and
163 <firstterm>frontends</firstterm>). The backends are specific to
164 output formats while the frontends are specific to input formats. We
165 would like to encourage you to write such programs and to submit
166 them to the docbook-utils project.</para>
168 <para>While most backends are based on Jame's Clark Jade, or its
169 OpenJade alternative, some of the backends make use of the programs
170 from the <firstterm>docbook2X</firstterm> project. We call these
171 <firstterm>helper</firstterm> programs.</para>
180 <firstName>Steve</firstname> <surname>Cheng</surname>
183 <title>Helper programs</title>
185 <para><firstterm>docbook2X</firstterm> is the collective name for a
186 bunch of tools for converting DocBook documents into the traditional
187 Unix documentation formats: <application>roff -man</application>
188 pages and <application>Texinfo</application>. Currently the formaters
189 are implemented as Perl SGMLSpm spec files.</para>
191 <para>The <ulink URL="docbook2X.tar.gz">latest version of
192 docbook2X</ulink> is available as a tarball. It also includes example
193 SGML documents for testing. For other examples, please see the
194 <ulink URL="ftp://ftp.ggi-project.org/pub/ggi/doc/"> documentation
195 at the GGI Project</ulink>.</para>
204 <title>Application programming interface</title>
206 <para>The backends and the frontends use an application
207 programming interface (<acronym>API</acronym>) that is described
208 in <citerefentry> <refentrytitle>backend-spec</refentrytitle>
209 <manvolnum>7</manvolnum> </citerefentry> and in
210 <citerefentry> <refentrytitle>frontend-spec</refentrytitle>
211 <manvolnum>7</manvolnum> </citerefentry>. Be aware that, since
212 these specifications should be treated as first drafts, they might
213 change anytime.</para>
222 <chapter id="intro-sgmldiff">
225 <firstname>Frederik</firstname> <surname>Fouvry</surname>
228 <title>sgmldiff</title>
230 <para><citerefentry> <refentrytitle>sgmldiff</refentrytitle>
231 <manvolnum>1</manvolnum> </citerefentry> compares two SGML files
232 taking only the markup into account, thus allowing to see if the
233 translation of an SGML file has been left unchanged during its
241 <title>GNU Free Documentation License</title>
245 GNU Free Documentation License
246 Version 1.1, March 2000
248 Copyright (C) 2000 Free Software Foundation, Inc.
249 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
250 Everyone is permitted to copy and distribute verbatim copies
251 of this license document, but changing it is not allowed.
256 The purpose of this License is to make a manual, textbook, or other
257 written document "free" in the sense of freedom: to assure everyone
258 the effective freedom to copy and redistribute it, with or without
259 modifying it, either commercially or noncommercially. Secondarily,
260 this License preserves for the author and publisher a way to get
261 credit for their work, while not being considered responsible for
262 modifications made by others.
264 This License is a kind of "copyleft", which means that derivative
265 works of the document must themselves be free in the same sense. It
266 complements the GNU General Public License, which is a copyleft
267 license designed for free software.
269 We have designed this License in order to use it for manuals for free
270 software, because free software needs free documentation: a free
271 program should come with manuals providing the same freedoms that the
272 software does. But this License is not limited to software manuals;
273 it can be used for any textual work, regardless of subject matter or
274 whether it is published as a printed book. We recommend this License
275 principally for works whose purpose is instruction or reference.
278 1. APPLICABILITY AND DEFINITIONS
280 This License applies to any manual or other work that contains a
281 notice placed by the copyright holder saying it can be distributed
282 under the terms of this License. The "Document", below, refers to any
283 such manual or work. Any member of the public is a licensee, and is
286 A "Modified Version" of the Document means any work containing the
287 Document or a portion of it, either copied verbatim, or with
288 modifications and/or translated into another language.
290 A "Secondary Section" is a named appendix or a front-matter section of
291 the Document that deals exclusively with the relationship of the
292 publishers or authors of the Document to the Document's overall subject
293 (or to related matters) and contains nothing that could fall directly
294 within that overall subject. (For example, if the Document is in part a
295 textbook of mathematics, a Secondary Section may not explain any
296 mathematics.) The relationship could be a matter of historical
297 connection with the subject or with related matters, or of legal,
298 commercial, philosophical, ethical or political position regarding
301 The "Invariant Sections" are certain Secondary Sections whose titles
302 are designated, as being those of Invariant Sections, in the notice
303 that says that the Document is released under this License.
305 The "Cover Texts" are certain short passages of text that are listed,
306 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
307 the Document is released under this License.
309 A "Transparent" copy of the Document means a machine-readable copy,
310 represented in a format whose specification is available to the
311 general public, whose contents can be viewed and edited directly and
312 straightforwardly with generic text editors or (for images composed of
313 pixels) generic paint programs or (for drawings) some widely available
314 drawing editor, and that is suitable for input to text formatters or
315 for automatic translation to a variety of formats suitable for input
316 to text formatters. A copy made in an otherwise Transparent file
317 format whose markup has been designed to thwart or discourage
318 subsequent modification by readers is not Transparent. A copy that is
319 not "Transparent" is called "Opaque".
321 Examples of suitable formats for Transparent copies include plain
322 ASCII without markup, Texinfo input format, LaTeX input format, SGML
323 or XML using a publicly available DTD, and standard-conforming simple
324 HTML designed for human modification. Opaque formats include
325 PostScript, PDF, proprietary formats that can be read and edited only
326 by proprietary word processors, SGML or XML for which the DTD and/or
327 processing tools are not generally available, and the
328 machine-generated HTML produced by some word processors for output
331 The "Title Page" means, for a printed book, the title page itself,
332 plus such following pages as are needed to hold, legibly, the material
333 this License requires to appear in the title page. For works in
334 formats which do not have any title page as such, "Title Page" means
335 the text near the most prominent appearance of the work's title,
336 preceding the beginning of the body of the text.
341 You may copy and distribute the Document in any medium, either
342 commercially or noncommercially, provided that this License, the
343 copyright notices, and the license notice saying this License applies
344 to the Document are reproduced in all copies, and that you add no other
345 conditions whatsoever to those of this License. You may not use
346 technical measures to obstruct or control the reading or further
347 copying of the copies you make or distribute. However, you may accept
348 compensation in exchange for copies. If you distribute a large enough
349 number of copies you must also follow the conditions in section 3.
351 You may also lend copies, under the same conditions stated above, and
352 you may publicly display copies.
355 3. COPYING IN QUANTITY
357 If you publish printed copies of the Document numbering more than 100,
358 and the Document's license notice requires Cover Texts, you must enclose
359 the copies in covers that carry, clearly and legibly, all these Cover
360 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
361 the back cover. Both covers must also clearly and legibly identify
362 you as the publisher of these copies. The front cover must present
363 the full title with all words of the title equally prominent and
364 visible. You may add other material on the covers in addition.
365 Copying with changes limited to the covers, as long as they preserve
366 the title of the Document and satisfy these conditions, can be treated
367 as verbatim copying in other respects.
369 If the required texts for either cover are too voluminous to fit
370 legibly, you should put the first ones listed (as many as fit
371 reasonably) on the actual cover, and continue the rest onto adjacent
374 If you publish or distribute Opaque copies of the Document numbering
375 more than 100, you must either include a machine-readable Transparent
376 copy along with each Opaque copy, or state in or with each Opaque copy
377 a publicly-accessible computer-network location containing a complete
378 Transparent copy of the Document, free of added material, which the
379 general network-using public has access to download anonymously at no
380 charge using public-standard network protocols. If you use the latter
381 option, you must take reasonably prudent steps, when you begin
382 distribution of Opaque copies in quantity, to ensure that this
383 Transparent copy will remain thus accessible at the stated location
384 until at least one year after the last time you distribute an Opaque
385 copy (directly or through your agents or retailers) of that edition to
388 It is requested, but not required, that you contact the authors of the
389 Document well before redistributing any large number of copies, to give
390 them a chance to provide you with an updated version of the Document.
395 You may copy and distribute a Modified Version of the Document under
396 the conditions of sections 2 and 3 above, provided that you release
397 the Modified Version under precisely this License, with the Modified
398 Version filling the role of the Document, thus licensing distribution
399 and modification of the Modified Version to whoever possesses a copy
400 of it. In addition, you must do these things in the Modified Version:
402 A. Use in the Title Page (and on the covers, if any) a title distinct
403 from that of the Document, and from those of previous versions
404 (which should, if there were any, be listed in the History section
405 of the Document). You may use the same title as a previous version
406 if the original publisher of that version gives permission.
407 B. List on the Title Page, as authors, one or more persons or entities
408 responsible for authorship of the modifications in the Modified
409 Version, together with at least five of the principal authors of the
410 Document (all of its principal authors, if it has less than five).
411 C. State on the Title page the name of the publisher of the
412 Modified Version, as the publisher.
413 D. Preserve all the copyright notices of the Document.
414 E. Add an appropriate copyright notice for your modifications
415 adjacent to the other copyright notices.
416 F. Include, immediately after the copyright notices, a license notice
417 giving the public permission to use the Modified Version under the
418 terms of this License, in the form shown in the Addendum below.
419 G. Preserve in that license notice the full lists of Invariant Sections
420 and required Cover Texts given in the Document's license notice.
421 H. Include an unaltered copy of this License.
422 I. Preserve the section entitled "History", and its title, and add to
423 it an item stating at least the title, year, new authors, and
424 publisher of the Modified Version as given on the Title Page. If
425 there is no section entitled "History" in the Document, create one
426 stating the title, year, authors, and publisher of the Document as
427 given on its Title Page, then add an item describing the Modified
428 Version as stated in the previous sentence.
429 J. Preserve the network location, if any, given in the Document for
430 public access to a Transparent copy of the Document, and likewise
431 the network locations given in the Document for previous versions
432 it was based on. These may be placed in the "History" section.
433 You may omit a network location for a work that was published at
434 least four years before the Document itself, or if the original
435 publisher of the version it refers to gives permission.
436 K. In any section entitled "Acknowledgements" or "Dedications",
437 preserve the section's title, and preserve in the section all the
438 substance and tone of each of the contributor acknowledgements
439 and/or dedications given therein.
440 L. Preserve all the Invariant Sections of the Document,
441 unaltered in their text and in their titles. Section numbers
442 or the equivalent are not considered part of the section titles.
443 M. Delete any section entitled "Endorsements". Such a section
444 may not be included in the Modified Version.
445 N. Do not retitle any existing section as "Endorsements"
446 or to conflict in title with any Invariant Section.
448 If the Modified Version includes new front-matter sections or
449 appendices that qualify as Secondary Sections and contain no material
450 copied from the Document, you may at your option designate some or all
451 of these sections as invariant. To do this, add their titles to the
452 list of Invariant Sections in the Modified Version's license notice.
453 These titles must be distinct from any other section titles.
455 You may add a section entitled "Endorsements", provided it contains
456 nothing but endorsements of your Modified Version by various
457 parties--for example, statements of peer review or that the text has
458 been approved by an organization as the authoritative definition of a
461 You may add a passage of up to five words as a Front-Cover Text, and a
462 passage of up to 25 words as a Back-Cover Text, to the end of the list
463 of Cover Texts in the Modified Version. Only one passage of
464 Front-Cover Text and one of Back-Cover Text may be added by (or
465 through arrangements made by) any one entity. If the Document already
466 includes a cover text for the same cover, previously added by you or
467 by arrangement made by the same entity you are acting on behalf of,
468 you may not add another; but you may replace the old one, on explicit
469 permission from the previous publisher that added the old one.
471 The author(s) and publisher(s) of the Document do not by this License
472 give permission to use their names for publicity for or to assert or
473 imply endorsement of any Modified Version.
476 5. COMBINING DOCUMENTS
478 You may combine the Document with other documents released under this
479 License, under the terms defined in section 4 above for modified
480 versions, provided that you include in the combination all of the
481 Invariant Sections of all of the original documents, unmodified, and
482 list them all as Invariant Sections of your combined work in its
485 The combined work need only contain one copy of this License, and
486 multiple identical Invariant Sections may be replaced with a single
487 copy. If there are multiple Invariant Sections with the same name but
488 different contents, make the title of each such section unique by
489 adding at the end of it, in parentheses, the name of the original
490 author or publisher of that section if known, or else a unique number.
491 Make the same adjustment to the section titles in the list of
492 Invariant Sections in the license notice of the combined work.
494 In the combination, you must combine any sections entitled "History"
495 in the various original documents, forming one section entitled
496 "History"; likewise combine any sections entitled "Acknowledgements",
497 and any sections entitled "Dedications". You must delete all sections
498 entitled "Endorsements."
501 6. COLLECTIONS OF DOCUMENTS
503 You may make a collection consisting of the Document and other documents
504 released under this License, and replace the individual copies of this
505 License in the various documents with a single copy that is included in
506 the collection, provided that you follow the rules of this License for
507 verbatim copying of each of the documents in all other respects.
509 You may extract a single document from such a collection, and distribute
510 it individually under this License, provided you insert a copy of this
511 License into the extracted document, and follow this License in all
512 other respects regarding verbatim copying of that document.
516 7. AGGREGATION WITH INDEPENDENT WORKS
518 A compilation of the Document or its derivatives with other separate
519 and independent documents or works, in or on a volume of a storage or
520 distribution medium, does not as a whole count as a Modified Version
521 of the Document, provided no compilation copyright is claimed for the
522 compilation. Such a compilation is called an "aggregate", and this
523 License does not apply to the other self-contained works thus compiled
524 with the Document, on account of their being thus compiled, if they
525 are not themselves derivative works of the Document.
527 If the Cover Text requirement of section 3 is applicable to these
528 copies of the Document, then if the Document is less than one quarter
529 of the entire aggregate, the Document's Cover Texts may be placed on
530 covers that surround only the Document within the aggregate.
531 Otherwise they must appear on covers around the whole aggregate.
536 Translation is considered a kind of modification, so you may
537 distribute translations of the Document under the terms of section 4.
538 Replacing Invariant Sections with translations requires special
539 permission from their copyright holders, but you may include
540 translations of some or all Invariant Sections in addition to the
541 original versions of these Invariant Sections. You may include a
542 translation of this License provided that you also include the
543 original English version of this License. In case of a disagreement
544 between the translation and the original English version of this
545 License, the original English version will prevail.
550 You may not copy, modify, sublicense, or distribute the Document except
551 as expressly provided for under this License. Any other attempt to
552 copy, modify, sublicense or distribute the Document is void, and will
553 automatically terminate your rights under this License. However,
554 parties who have received copies, or rights, from you under this
555 License will not have their licenses terminated so long as such
556 parties remain in full compliance.
559 10. FUTURE REVISIONS OF THIS LICENSE
561 The Free Software Foundation may publish new, revised versions
562 of the GNU Free Documentation License from time to time. Such new
563 versions will be similar in spirit to the present version, but may
564 differ in detail to address new problems or concerns. See
565 http:///www.gnu.org/copyleft/.
567 Each version of the License is given a distinguishing version number.
568 If the Document specifies that a particular numbered version of this
569 License "or any later version" applies to it, you have the option of
570 following the terms and conditions either of that specified version or
571 of any later version that has been published (not as a draft) by the
572 Free Software Foundation. If the Document does not specify a version
573 number of this License, you may choose any version ever published (not
574 as a draft) by the Free Software Foundation.
577 ADDENDUM: How to use this License for your documents
579 To use this License in a document you have written, include a copy of
580 the License in the document and put the following copyright and
581 license notices just after the title page:
583 Copyright (c) YEAR YOUR NAME.
584 Permission is granted to copy, distribute and/or modify this document
585 under the terms of the GNU Free Documentation License, Version 1.1
586 or any later version published by the Free Software Foundation;
587 with the Invariant Sections being LIST THEIR TITLES, with the
588 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
589 A copy of the license is included in the section entitled "GNU
590 Free Documentation License".
592 If you have no Invariant Sections, write "with no Invariant Sections"
593 instead of saying which ones are invariant. If you have no
594 Front-Cover Texts, write "no Front-Cover Texts" instead of
595 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
597 If your document contains nontrivial examples of program code, we
598 recommend releasing these examples in parallel under your choice of
599 free software license, such as the GNU General Public License,
600 to permit their use in free software.