Go to:
Gentoo Home
Documentation
Forums
Lists
Bugs
Planet
Store
Wiki
Get Gentoo!
Gentoo's Bugzilla – Attachment 164889 Details for
Bug 184551
app-text/docbook-sgml-utils-0.6.14 fails to merge
Home
|
New
–
[Ex]
|
Browse
|
Search
|
Privacy Policy
|
[?]
|
Reports
|
Requests
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
The build.log of my persistent failure
build.log (text/plain), 1.75 MB, created by
Jason Cornez
on 2008-09-08 09:35:43 UTC
(
hide
)
Description:
The build.log of my persistent failure
Filename:
MIME Type:
Creator:
Jason Cornez
Created:
2008-09-08 09:35:43 UTC
Size:
1.75 MB
patch
obsolete
>>>> Unpacking source... >>>> Unpacking docbook-utils-0.6.14.tar.gz to /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work > [32;01m*[0m Applying docbook-utils-0.6.14-elinks.patch ... >[A[105C [34;01m[ [32;01mok[34;01m ][0m >>>> Source unpacked. >>>> Compiling source in /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14 ... >./configure --prefix=/usr --host=i686-pc-linux-gnu --mandir=/usr/share/man --infodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib --build=i686-pc-linux-gnu >checking for a BSD-compatible install... /usr/bin/install -c >checking whether build environment is sane... yes >checking for gawk... gawk >checking whether make sets $(MAKE)... yes >configure: creating ./config.status >config.status: creating Makefile >config.status: creating docbook-utils.spec >config.status: creating bin/Makefile >config.status: creating bin/jw >config.status: creating bin/sgmldiff >config.status: creating backends/Makefile >config.status: creating backends/man >config.status: creating backends/texi >config.status: creating frontends/Makefile >config.status: creating frontends/docbook >config.status: creating helpers/Makefile >config.status: creating doc/Makefile >config.status: creating doc/version >config.status: creating doc/refentry/Makefile >config.status: creating doc/man/Makefile >config.status: creating doc/HTML/Makefile >Making all in backends >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >make[1]: Nothing to be done for `all'. >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >Making all in bin >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >make[1]: Nothing to be done for `all'. >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >Making all in doc >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >Making all in refentry >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >make[2]: Nothing to be done for `all'. >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >Making all in man >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >make[2]: Nothing to be done for `all'. >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >Making all in HTML >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > n the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > n the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > n the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Worn the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > d > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > n the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections ijade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > n the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >make[2]: Nothing to be done for `all-am'. >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >Making all in frontends >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/frontends' >make[1]: Nothing to be done for `all'. >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/frontends' >Making all in helpers >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/helpers' >make[1]: Nothing to be done for `all'. >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/helpers' >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14' >make[1]: Nothing to be done for `all-am'. >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14' >>>> Source compiled. >>>> Test phase [not enabled]: app-text/docbook-sgml-utils-0.6.14 > >>>> Install docbook-sgml-utils-0.6.14 into /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image/ category app-text >Making install in backends >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >make[2]: Nothing to be done for `install-exec-am'. >mkdir -p -- . /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends > /usr/bin/install -c -m 644 dvi /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/dvi > /usr/bin/install -c -m 644 html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/html > /usr/bin/install -c -m 644 man /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/man > /usr/bin/install -c -m 644 pdf /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/pdf > /usr/bin/install -c -m 644 ps /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/ps > /usr/bin/install -c -m 644 rtf /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/rtf > /usr/bin/install -c -m 644 tex /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/tex > /usr/bin/install -c -m 644 texi /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/texi > /usr/bin/install -c -m 644 txt /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/sgml/docbook/utils-0.6.14/backends/txt >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/backends' >Making install in bin >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >mkdir -p -- . /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin > /usr/bin/install -c jw /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/jw > /usr/bin/install -c sgmldiff /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/sgmldiff > /usr/bin/install -c docbook2dvi /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2dvi > /usr/bin/install -c docbook2html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2html > /usr/bin/install -c docbook2man /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2man > /usr/bin/install -c docbook2pdf /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2pdf > /usr/bin/install -c docbook2ps /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2ps > /usr/bin/install -c docbook2rtf /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2rtf > /usr/bin/install -c docbook2tex /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2tex > /usr/bin/install -c docbook2texi /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2texi > /usr/bin/install -c docbook2txt /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/bin/docbook2txt >make[2]: Nothing to be done for `install-data-am'. >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/bin' >Making install in doc >make[1]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >Making install in refentry >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >make[3]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >make[3]: Nothing to be done for `install-exec-am'. >make[3]: Nothing to be done for `install-data-am'. >make[3]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/refentry' >Making install in man >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >make[3]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >make[3]: Nothing to be done for `install-exec-am'. >mkdir -p -- . /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man1 > /usr/bin/install -c -m 644 ./jw.1 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man1/jw.1 > /usr/bin/install -c -m 644 ./docbook2man-spec.pl.1 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man1/docbook2man-spec.pl.1 > /usr/bin/install -c -m 644 ./docbook2texi-spec.pl.1 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man1/docbook2texi-spec.pl.1 > /usr/bin/install -c -m 644 ./sgmldiff.1 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man1/sgmldiff.1 >mkdir -p -- . /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man7 > /usr/bin/install -c -m 644 ./backend-spec.7 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man7/backend-spec.7 > /usr/bin/install -c -m 644 ./frontend-spec.7 /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/man/man7/frontend-spec.7 >make[3]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/man' >Making install in HTML >make[2]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > make[3]: Entering directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >make[3]: Nothing to be done for `install-exec-am'. >SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > SGML_CATALOG_FILES=/etc/sgml/catalog \ > SGML_SEARCH_PATH=../..:../../doc:.. \ > jade -t sgml -i html -d ../../docbook-utils.dsl\#html \ > -V '%use-id-as-filename%' ../../doc/docbook-utils.sgml >jade:../../docbook-utils.dsl:9:96:W: cannot generate system identifier for public text "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" >jade:../../docbook-utils.dsl:19:39:E: no style-specification or external-specification with ID "DOCBOOK" >DocBook Utils18 June 2000Permission is granted to copy, distribute and/or modify this > document under the terms of the GNU Free Documentation License, > Version 1.1 or any later version published by the Free Software > Foundation. A copy of the license is included in the section > entitled "GNU Free Documentation License".This documentation describes the DocBook-utils version > 0.2.The DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.EricBischoffebisch@cybercable.tm.frJochemHuhmannjoh@revier.comSteveChengsteve@ggi-project.orgFrederikFouvryfouvry@sfs.nphil.uni-tuebingen.deEricBischoffIntroductionThe DocBook-utils are a collection of various utilites to > convert and analyse SGML documents in general and DocBook files > in particular. They are developped by many authors and released > under GPL licence.DocBook > is a SGML-based or XML-based standard for writing technical > documentation defined by the DocBook Technical Committee of the > OASIS consortium.The DocBook-utils try to be as general as possible, and > therefore it is possible to use them with other SGML formats > than DocBook, like TEI or HTML. But each time there was an > opportunity to make them biased to DocBook to ease the life of > DocBook users, this opportunity has been given a higher priority > than generality considerations. This is why this package is not > called "SGML-utils".The DocBook-utils are independant of any existing distribution > of SGML parsers and of DocBook resources. However, they conform > with the new draft on SGML and DocBook standardization being > discussed at Linux Standard Base project.So far, the DocBook-utils only consist of: > jw, a script used to convert > from DocBook or other SGML formats into "classical" file > formats like HTML, man, info, RTF...sgmldiff, a script used to > compare the markup of a SGML file with its translation into > another language. > but we would like to see them accomplish other tasks in the future: > Conversion from "legacy" formats like LinuxDoc, man, > info, HTML or PDF into DocBook.Refined analysis of DocBook files like a "sgmlgrep" > program that would allow context-sensitive searchs.Support for XML. > If you want to help or keep informed of the latest developments, > please subscribe to the "docbook-utils@bazar.conectiva.com.br" > mailing list. This list has been set up to allow collaborative > development of these > tools.To subscribe: Send a message to > docbook-utils-subscribe@bazar.conectiva.com.br > - you will get a confirmation message, just reply to it.To unsubscribe: Send a message to > docbook-utils-unsubscribe@bazar.conectiva.com.br > and reply to the confirmation messageFor any additional information, write to Jorge Godoy who is > the maintainer of this list.JochemHuhmannjwCommand referencejw1 converts DocBook or other > SGML-based formats into "classical" file formats.The modular architecture used by > jw allows to write plug-in > programs (we call them backends and > frontends). The backends are specific to > output formats while the frontends are specific to input formats. We > would like to encourage you to write such programs and to submit > them to the docbook-utils project.While most backends are based on Jame's Clark Jade, or its > OpenJade alternative, some of the backends make use of the programs > from the docbook2X project. We call these > helper programs.EricBischoffebisch@cybercable.tm.frjw1jwdocbook2dvidocbook2htmldocbook2mandocbook2pdfdocbook2psdocbook2rtfdocbook2texdocbook2texidocbook2txt(Jade Wrapper) converts SGML files to other formatsjw-f > frontend--frontend > frontend-b > backend--backend backend-c file--cat file-n--nostd-d > file|default|none--dsl > file|default|none-l file--dcl file-s path--sgmlbase path-p program--parser program-o directory--output directory-V > variable[=value]-u--nochunks-i section--include section-w type|list--warning type|list-e type|list--error type|list-h--help-v--versionSGML-filedocbook2dviSGML-filedocbook2htmlSGML-filedocbook2manSGML-filedocbook2pdfSGML-filedocbook2psSGML-filedocbook2rtfSGML-filedocbook2texSGML-filedocbook2texiSGML-filedocbook2txtSGML-fileDescriptionThe jw shell script allows to > convert a DocBook file (or some other SGML-based format) to > other formats (including HTML, RTF, PS and PDF) with > an easy-to-understand syntax. It hides most of Jade's > or OpenJade complexity and adds comfortable features.Other scripts like docbook2html, > docbook2rtf or > docbook2ps provide different ways of > calling jw that might be easier to > remember.For the moment, jw does not handle XML, but only SGML.This utility assumes that several other components are > installed. The list includes: > the ISO character entities for SGMLJames Clark's DSSSL engine, jade, or an equivalent parser > like OpenJadethe DocBook DTD from the OASIS consortiumNorman Walsh's DocBook modular style sheets (or some other > set of DSSSL style sheets)Sebastian Rahtz's jadetex set of TeX macros for jade > (for backends intended to "printing" formats like PDF, RTF or > PostScript)A perl interpreter (for backends that use perl)SGMLSpm from CPAN (for backends that use sgmls)Lynx HTML browser (for the txt > backend) > The jw script is basically called like this:jw mydoc.sgmlwhere mydoc.sgml is a SGML file.The command line above uses default options: it converts > from DocBook (the default frontend) to HTML (the default backend), > does not put the result in a subdirectory (unless specified > otherwise in the style sheets), etc.In this example, the "mydoc" file name as well as the ".sgml" > extension can be replaced by anything else. Current extensions > for SGML DocBook files include ".sgml", ".sgm", ".docbook", and > ".db". The processed file mydoc.sgml can > be in any other directory than the current one.Here we have chosen to generate HTML output. In fact we can > use any of the backends stored in the backends/ > subdirectory of the DocBook-utils distribution directory (usually > /usr/share/sgml/docbook/utils-0.6.14). > Similarly, you can use any frontend defined in the > frontends/ subdirectory to convert from another > input format.This sample command creates one or many HTML files with > arbitrary file names in the current directory. This default behavior > can be changed through command line options and/or customization > style sheets.OptionsThe following options apply to the conversion script:-f > frontend--frontend > frontend > Allows to specify another frontend than default docbook. > The list of currently available frontends is: > docbookConverts docbook with Norman Walsh's > style sheets. This frontend searches in the > subdirectories of the base SGML directory for a > file named html/docbook.dsl or > print/docbook.dsl (depending on the > backend's type: html or print). > -b > backend--backend > backend > Allows to specify another backend than default > HTML. The list of currently available > backends is: > dviConverts to DVI (DeVice Independant > files) by calling Jade or > OpenJade.htmlConverts to HTML (HyperText Markup > Language) by calling Jade > or OpenJade.manConverts a refentry to a Unix manual page > by calling docbook2man. Does not work with other SGML > document types than DocBook.pdfConverts to PDF (Portable Document > Format) by calling Jade or > OpenJade.psConverts to PostScript by > calling Jade or > OpenJade.rtfConverts to RTF (Rich Text Format) > by calling Jade or > OpenJade. The resulting file can > then be inported into MS Word > or one of its Linux replacement programs.texConverts to TeX by calling Jade or > OpenJade.texiConverts to GNU TeXinfo pages by calling > docbook2texi. Does not work with other SGML document types > than DocBook.txtConverts to a bare text file > by calling Jade > or OpenJade, then > Lynx. > -c file--cat fileAllows to use an extra SGML Open Catalog that will list > other files like customization style sheets, adaptations to the > DocBook Document Type Definition, special character entities, > etc. This catalog is added to the list of catalogs determined > by the script (see option --nostd below)-n--nostdDo not use the standard SGML Open Catalogs. Normally, > the standard catalogs list is determined like this: > if the centralized catalog exists, then > use it. The centralized catalog is a list of all > catalogs that might be necessary that usually > resides in /etc/sgml. Its > name is provided by the frontend, for example > the docbook frontend returns > /etc/sgml/sgml-docbook.cat.Otherwise, take all the files > named catalog from the > subdirectories of the SGML base directory (usually > /usr/share/sgml). > This option is useful in conjunction with the > --cat option to use only the catalogs that > are specified on the command line.-d > file|default|none--dsl > file|default|noneAllows to use a customized style sheet instead > of the default one.A "target" starting with a hash mark "#" can be appended > to the file name. As a result, only the corresponding part > of the style sheet is executed (the "style specification" whose > "identificator" is equal to the target's name). A common use of this > mechanism is to define "#html" and "#print" targets to trigger > the corresponding part of a replacement style sheet which is > common for both HTML and printout conversion.By replacing the file name with "default", the default > style sheet provided with the frontend is used. For example, the > docbook frontend returns > ./docbook.dsl#html (or > ./docbook.dsl#print) in the SGML base > directory.By replacing the file name with "none", no replacement > style sheet is used, not even the default style sheet. The style > sheet which is used is also determined by the frontend. For > example, the docbook frontend returns > Norman Walsh's html/docbook.dsl (or > print/docbook.dsl) found somewhere below > the SGML base directory.If no --dsl option is specified, then "--dsl default" is > used.-l file--dcl fileAllows to use a customized SGML declaration instead > of the default one. The file name of the default SGML > declaration is not set for SGML files, and is set to > xml.dcl in the SGML base directory > for XML files.-s path--sgmlbase pathAllows to use another location for the SGML base > directory. This is the directory below which all SGML DTDs, > style sheets, entities, etc are installed. The default value > is /usr/share/sgml.-p program--parser programSpecify the parser to use (Jade > or OpenJade) if several > are installed. If this option is not specified, > the script first tries to use Jade, then it tries > OpenJade.-o directory--output directorySet output directory where all the resulting files will > be stored. If the style sheets define a subdirectory where to > store the resulting files too, the subdirectory defined by the > style sheets will be placed below the subdirectory defined by > this option.-V > variable=[value]Set a variable (to a value, if one is specified).-u--nochunksOutput only one big file. This option is useful only > when generating HTML, because the output can be split into > several files. This option overrides the setting that may be > done in the style sheets.-i section--include sectionDeclare a SGML marked section as "include". A SGML marked > section is a kind of conditional part of a document. If it is > declared "ignore", it will be left ignored, otherwise it will > be processed. An example of such a marked section would be: > <DOCTYPE mydoc [ > <!ENTITY % confidential "ignore"> > ]> > <mydoc> > ... > <![ %confidential [ Some confidential text... ]]> > ... > </mydoc> > > -w type|list--warning type|listEnables or disables the display of given types of warnings. > Several -w options might be entered on the command line. > Warning types that start with "no-" disable the corresponding > warnings, the other types enable them.If the warning type is replaced with "list", then > a list of allowed warning types is displayed.-e type|list--error type|listDisables given types of errors. > Several -e options might be entered on the command line. > All error types start with "no-".If the error type is replaced with "list", then > a list of allowed error types is displayed.-h--helpPrint a short help message and exit-v--versionPrint the version identifier and exitFiles/etc/sgml/sgml-docbook.catCentralized SGML open catalog. This file name might > vary if another frontend than docbook > is used./usr/share/sgml/docbook/utils-0.6.14/backendsThe various backends/usr/share/sgml/docbook/utils-0.6.14/frontendsThe various frontends/usr/share/sgml/docbook/utils-0.6.14/helpersThe various helper scripts like docbook2man or docbook2texiAuthorsEric Bischoff (jw shell script and a few backends), > Jochem Huhmann (the man and > texi backends)See Alsodocbook2man-spec.pl1, > docbook2texi-spec.pl1, > install-catalog8, > nsgmls1, docbook-utils > homepage.SteveChengHelper programsdocbook2X is the collective name for a > bunch of tools for converting DocBook documents into the traditional > Unix documentation formats: roff -man > pages and Texinfo. Currently the formaters > are implemented as Perl SGMLSpm spec files.The latest version of > docbook2X is available as a tarball. It also includes example > SGML documents for testing. For other examples, please see the > documentation > at the GGI Project.docbook2man-spec.pl1docbook2man-spec.plconvert DocBook RefEntries to man pagessgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2man-spec.plDescriptiondocbook2man is a sgmlspl spec file that produced man >pages (using the -man macros) from DocBook RefEntry markup.The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Markup not found in RefEntry is discarded.Its output, the converted man pages, are written to the current directory. If >RefMeta information is not specified in a >RefEntry, then the man page will be written to standard >output.The file manpage.links will also be created, which contains >any aliases of the manpages generated. This file is in the format: > >man page alias >manpageThe manpage.refs file keeps track of >XRef references. Note that if the input document has any >forward references, then docbook2man may have to be >invoked twice (the first time updating manpage.refs) to >resolve them.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doObvious stuff: > > Fix docbook2man breakages found in >the test documents, especially >weird.sgml.Add new element handling and fix existing handling. >Be robust. Produce cleanest, readable man output as possible (unlike some >other converters). Follow Linux >man7 >convention. As conversion to man pages is usually not done very often, it is >better to be slower/more complicated than to produce wrong output. Also if >someone wants to give up using DocBook for whatever reason, the last-converted >man pages can then be maintained manually. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.Support other (human) languages. But what to do with non-ASCII charsets? >SGMLSpm doesn't report them and roff does not grok them. > >text after enclosed lists (and SS blocks) will break docbook2man >If we do this, more people can use DocBook.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.docbook2texi-spec.pl1docbook2texi-spec.plconvert DocBook Books >to Texinfo documentssgmlspldocbook2man-spec.plnsgmlssgml document| sgmlspldocbook2texi-spec.plbasenameDescriptiondocbook2texi is a sgmlspl spec file that produces >GNU Texinfo documents from DocBook documents. The program reads ESIS produced by nsgmls (or other SGML parsers) from >standard input. Currently the document element must be Book, >otherwise the results are undefined.Its output, the converted Texinfo document, is written to standard >output.The file basename.refs will also >be created, which contains all the nodes in the document and their immediate >'child' nodes. As node processing always require forward references, >docbook2texi must be run twice for each document: the >first time to build the references, and the second to actually generate a valid >document.RequirementsThe SGMLSpm package from CPAN. This package includes the sgmlspl script >that is also needed.LimitationsTrying docbook2man on non-DocBook or non-conformant >SGML results in undefined behavior. :-)This program is a slow, dodgy Perl script.This program does not come close to supporting all the possible markup >in DocBook, and may produce wrong output in some cases with supported >markup.To doHow the hell do you represent a backslash (\) in Texinfo!!@? >I've tried \\ but TeX complains about it.Fix breakages found in the test documents.Add new element handling and fix existing handling. >Be robust. Make it faster. I think most of the speed problems so far is with parsing >ESIS. Rewrite SGMLS.pm with C and/or get input directly >from SP.There are some dependencies on elements occurring when they are actually >optional (according to the DTD). We need to fix that (preferably) or >prominently state the requirements.Allow other more common document elements.Separate out node referencing to a separate script. Not only would it >make it faster/easier to maintain because it's separate from the main >code, but also I would like it to evolve into an automatic DocBook >ToC generator.CopyrightCopyright (C) 1998-1999 Steve Cheng steve@ggi-project.orgThis program is free software; you can redistribute it and/or modify it >under the terms of the GNU General Public License as published by the >Free Software Foundation; either version 2, or (at your option) any >later version.You should have received a copy of the GNU General Public License along with >this program; see the file COPYING. If not, please write >to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.Application programming interfaceThe backends and the frontends use an application > programming interface (API) that is described > in backend-spec7 and in > frontend-spec7. Be aware that, since > these specifications should be treated as first drafts, they might > change anytime.JochemHuhmannjoh@revier.combackend-spec7backend-specinterface between jw and its backendsDescriptionjw1 calls backends like > backends/html to do the "real" conversion > work. The backend gets all necessary data delivered > via environment variables ready to use.This documentation describes those environment variables.The backend is run in the directory where the output > files are to be created. It should return 0 if there weren't any problem, > and return a positive value otherwise.Variables SGML_FILE_NAME > The bare name of the source file SGML_FILE > The full name and path of the source file SGML_JADE > The name of the parser (usually > Jade or > OpenJade) SGML_ARGUMENTS > The full argument-string for > Jade or > OpenJade SGML_CATALOG_FILES > The list of catalog files needed by > Jade or > OpenJade SGML_STYLESHEET > The style sheet to use SGML_BASE_DIR > The base directory of the SGML system (default is > /usr/share/sgml)FilesSee alsofrontend-spec7AuthorsJochem Huhmann joh@revier.comEricBischoffebisch@cybercable.tm.frfrontend-spec7frontend-specinterface between jw and its frontendsDescriptionjw1 calls frontends like > frontends/docbook to get the informations > specific to a given input format. The frontend knows which information > to return from the first command line parameter. It gets all necessary > data via environment variables ready to use.This document describes that command line parameter and those > environment variables.The frontend should return 0 if there weren't any problem, > and return a positive value otherwise.Variables $1 > The command line parameter, specifying which information > to return. It can take the following values: > centralized-catalogThe frontend must return the DTD-specific > centralized catalog name. Centralized catalogs normally > reside in /etc/sgml and provide the > location of all the catalog files useful for handling > this input type (the catalog for the DTD, the catalog > for the stylesheets, the catalog for the entities, > ...)style-sheetThe frontend must return the filename > of the style sheet to be used for this document type and > with the chosen backend. > SGML_CATALOGS_DIR > The directory where the centralized catalogs reside. It is normally > /etc/sgml.(This variable is valid only while determining > the centralized catalog to use.) SGML_BASE_DIR > The base directory of the SGML system. It is normally > /usr/share/sgml.(This variable is valid only while determining > the style sheet to use.) SGML_FILE > The name of the file to convert.(This variable is valid only while determining > the centralized catalog to use.) SGML_TYPE > The type of the backend to use, whether it produces output > files to be displayed online or to be printed out. > It can take the value html or > print.(This variable is valid only while determining > the style sheet to use). SGML_STYLESHEETS > The desired custom stylesheet type, either none > or default. > If none, the frontend must return the file name of > the style sheet provided by the system beneath the docbook-utils. > If default, the frontend must return the custom > stylesheet provided by the docbook-utils.(This variable is valid only while determining > the style sheet to use). SGML_XML > The metalanguage of the file to convert, either sgml > or xml.(This variable is valid only while determining > the centralized catalog to use).FilesSee alsobackend-spec7AuthorsJochem Huhmann joh@revier.comFrederikFouvrysgmldiffsgmldiff1 compares two SGML files > taking only the markup into account, thus allowing to see if the > translation of an SGML file has been left unchanged during its > translation.FrederikFouvryfouvry@sfs.nphil.uni-tuebingen.desgmldiff1sgmldiffFind differences in the markup of two SGML filessgmldiffoptions file1file2-a--attributes-c attributesnestingtextpos--context attributesnestingtextpos-s--statistics-h--help-v--versionDescriptionThis perl script allows to determine the structural differences > between two SGML files. It compares the files, regardless of what > is in between the tags, to only focus on the markup. Its output > is similar to diff1.The typical use of sgmldiff is to > compare an SGML file with its translation into another language. If > the translation was done cleanly, sgmldiff > returns without finding any difference in the markup.An example of a typical call to sgmldiff is: sgmldiff english.sgml italiano.sgml > If there are differences in markup between both files, > sgmldiff will output a series of differences > reports summarized with lines of the form: > 169a164At line 169 of the first file, line 164 of the > second file has been added.8a12,15At line 8 of the first file, lines 12 to 15 > of the second file have been added.41d28Line 41 of the first file has been destroyed, to > obtain line 28 of the second file.63,66d61Lines 63 to 66 of the first file have been > destroyed. to obtain line 61 of the second file.52c51Line 52 of the first file has been changed into > line 51 of the second file.5,7c8,10Lines 5 to 7 of the first file have been changed > into lines 8 to 10 of the second line. > In addition to those summaries, the lines of the first file are > shown preceeded by '<' and the lines of the second file are > shown preceeded by '>".OptionsHere is the list of actions that can be requested to > sgmldiff: -a--attributes > Include the attribute values in the difference tests. > Don't set this value if the attributes are likely to be > translated. Set this value if the attributes value shouldn't > change between both files. Default is to don't include the > attributes in the difference tests. -c attributesnestingtextpos--context attributesnestingtextpos > Add more context to the difference. Since every test between the tags is removed before testing the differences, sgmldiff is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.The allowed values for the --context option are: > attributesTake into account the attribute > names. The attribute > values are controlled by the > attributes option.nestingTake into account the nesting level of all the compared tags.textposTake into account the position in the text. > -s--statistics > Print some SGML information at the end. -h--help > Print a short help message and exit -v--version > Print the version identifier and exitFilesAuthors Frederik Fouvry > Developer of sgmldiff.See Also jw1 > conversion from a SGML file to other file formats > nsgmls1 > a base component of Jade DSSSL engine > http://sources.redhat.com/docbook-tools/ > the home page of the DocBook tools, a compendium of > all tools necessary to process DocBook files, including > the DocBook-utilsGNU Free Documentation License GNU Free Documentation License > Version 1.1, March 2000 > > Copyright (C) 2000 Free Software Foundation, Inc. > 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA > Everyone is permitted to copy and distribute verbatim copies > of this license document, but changing it is not allowed. > > >0. PREAMBLE > >The purpose of this License is to make a manual, textbook, or other >written document "free" in the sense of freedom: to assure everyone >the effective freedom to copy and redistribute it, with or without >modifying it, either commercially or noncommercially. Secondarily, >this License preserves for the author and publisher a way to get >credit for their work, while not being considered responsible for >modifications made by others. > >This License is a kind of "copyleft", which means that derivative >works of the document must themselves be free in the same sense. It >complements the GNU General Public License, which is a copyleft >license designed for free software. > >We have designed this License in order to use it for manuals for free >software, because free software needs free documentation: a free >program should come with manuals providing the same freedoms that the >software does. But this License is not limited to software manuals; >it can be used for any textual work, regardless of subject matter or >whether it is published as a printed book. We recommend this License >principally for works whose purpose is instruction or reference. > > >1. APPLICABILITY AND DEFINITIONS > >This License applies to any manual or other work that contains a >notice placed by the copyright holder saying it can be distributed >under the terms of this License. The "Document", below, refers to any >such manual or work. Any member of the public is a licensee, and is >addressed as "you". > >A "Modified Version" of the Document means any work containing the >Document or a portion of it, either copied verbatim, or with >modifications and/or translated into another language. > >A "Secondary Section" is a named appendix or a front-matter section of >the Document that deals exclusively with the relationship of the >publishers or authors of the Document to the Document's overall subject >(or to related matters) and contains nothing that could fall directly >within that overall subject. (For example, if the Document is in part a >textbook of mathematics, a Secondary Section may not explain any >mathematics.) The relationship could be a matter of historical >connection with the subject or with related matters, or of legal, >commercial, philosophical, ethical or political position regarding >them. > >The "Invariant Sections" are certain Secondary Sections whose titles >are designated, as being those of Invariant Sections, in the notice >that says that the Document is released under this License. > >The "Cover Texts" are certain short passages of text that are listed, >as Front-Cover Texts or Back-Cover Texts, in the notice that says that >the Document is released under this License. > >A "Transparent" copy of the Document means a machine-readable copy, >represented in a format whose specification is available to the >general public, whose contents can be viewed and edited directly and >straightforwardly with generic text editors or (for images composed of >pixels) generic paint programs or (for drawings) some widely available >drawing editor, and that is suitable for input to text formatters or >for automatic translation to a variety of formats suitable for input >to text formatters. A copy made in an otherwise Transparent file >format whose markup has been designed to thwart or discourage >subsequent modification by readers is not Transparent. A copy that is >not "Transparent" is called "Opaque". > >Examples of suitable formats for Transparent copies include plain >ASCII without markup, Texinfo input format, LaTeX input format, SGML >or XML using a publicly available DTD, and standard-conforming simple >HTML designed for human modification. Opaque formats include >PostScript, PDF, proprietary formats that can be read and edited only >by proprietary word processors, SGML or XML for which the DTD and/or >processing tools are not generally available, and the >machine-generated HTML produced by some word processors for output >purposes only. > >The "Title Page" means, for a printed book, the title page itself, >plus such following pages as are needed to hold, legibly, the material >this License requires to appear in the title page. For works in >formats which do not have any title page as such, "Title Page" means >the text near the most prominent appearance of the work's title, >preceding the beginning of the body of the text. > > >2. VERBATIM COPYING > >You may copy and distribute the Document in any medium, either >commercially or noncommercially, provided that this License, the >copyright notices, and the license notice saying this License applies >to the Document are reproduced in all copies, and that you add no other >conditions whatsoever to those of this License. You may not use >technical measures to obstruct or control the reading or further >copying of the copies you make or distribute. However, you may accept >compensation in exchange for copies. If you distribute a large enough >number of copies you must also follow the conditions in section 3. > >You may also lend copies, under the same conditions stated above, and >you may publicly display copies. > > >3. COPYING IN QUANTITY > >If you publish printed copies of the Document numbering more than 100, >and the Document's license notice requires Cover Texts, you must enclose >the copies in covers that carry, clearly and legibly, all these Cover >Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on >the back cover. Both covers must also clearly and legibly identify >you as the publisher of these copies. The front cover must present >the full title with all words of the title equally prominent and >visible. You may add other material on the covers in addition. >Copying with changes limited to the covers, as long as they preserve >the title of the Document and satisfy these conditions, can be treated >as verbatim copying in other respects. > >If the required texts for either cover are too voluminous to fit >legibly, you should put the first ones listed (as many as fit >reasonably) on the actual cover, and continue the rest onto adjacent >pages. > >If you publish or distribute Opaque copies of the Document numbering >more than 100, you must either include a machine-readable Transparent >copy along with each Opaque copy, or state in or with each Opaque copy >a publicly-accessible computer-network location containing a complete >Transparent copy of the Document, free of added material, which the >general network-using public has access to download anonymously at no >charge using public-standard network protocols. If you use the latter >option, you must take reasonably prudent steps, when you begin >distribution of Opaque copies in quantity, to ensure that this >Transparent copy will remain thus accessible at the stated location >until at least one year after the last time you distribute an Opaque >copy (directly or through your agents or retailers) of that edition to >the public. > >It is requested, but not required, that you contact the authors of the >Document well before redistributing any large number of copies, to give >them a chance to provide you with an updated version of the Document. > > >4. MODIFICATIONS > >You may copy and distribute a Modified Version of the Document under >the conditions of sections 2 and 3 above, provided that you release >the Modified Version under precisely this License, with the Modified >Version filling the role of the Document, thus licensing distribution >and modification of the Modified Version to whoever possesses a copy >of it. In addition, you must do these things in the Modified Version: > >A. Use in the Title Page (and on the covers, if any) a title distinct > from that of the Document, and from those of previous versions > (which should, if there were any, be listed in the History section > of the Document). You may use the same title as a previous version > if the original publisher of that version gives permission. >B. List on the Title Page, as authors, one or more persons or entities > responsible for authorship of the modifications in the Modified > Version, together with at least five of the principal authors of the > Document (all of its principal authors, if it has less than five). >C. State on the Title page the name of the publisher of the > Modified Version, as the publisher. >D. Preserve all the copyright notices of the Document. >E. Add an appropriate copyright notice for your modifications > adjacent to the other copyright notices. >F. Include, immediately after the copyright notices, a license notice > giving the public permission to use the Modified Version under the > terms of this License, in the form shown in the Addendum below. >G. Preserve in that license notice the full lists of Invariant Sections > and required Cover Texts given in the Document's license notice. >H. Include an unaltered copy of this License. >I. Preserve the section entitled "History", and its title, and add to > it an item stating at least the title, year, new authors, and > publisher of the Modified Version as given on the Title Page. If > there is no section entitled "History" in the Document, create one > stating the title, year, authors, and publisher of the Document as > given on its Title Page, then add an item describing the Modified > Version as stated in the previous sentence. >J. Preserve the network location, if any, given in the Document for > public access to a Transparent copy of the Document, and likewise > the network locations given in the Document for previous versions > it was based on. These may be placed in the "History" section. > You may omit a network location for a work that was published at > least four years before the Document itself, or if the original > publisher of the version it refers to gives permission. >K. In any section entitled "Acknowledgements" or "Dedications", > preserve the section's title, and preserve in the section all the > substance and tone of each of the contributor acknowledgements > and/or dedications given therein. >L. Preserve all the Invariant Sections of the Document, > unaltered in their text and in their titles. Section numbers > or the equivalent are not considered part of the section titles. >M. Delete any section entitled "Endorsements". Such a section > may not be included in the Modified Version. >N. Do not retitle any existing section as "Endorsements" > or to conflict in title with any Invariant Section. > >If the Modified Version includes new front-matter sections or >appendices that qualify as Secondary Sections and contain no material >copied from the Document, you may at your option designate some or all >of these sections as invariant. To do this, add their titles to the >list of Invariant Sections in the Modified Version's license notice. >These titles must be distinct from any other section titles. > >You may add a section entitled "Endorsements", provided it contains >nothing but endorsements of your Modified Version by various >parties--for example, statements of peer review or that the text has >been approved by an organization as the authoritative definition of a >standard. > >You may add a passage of up to five words as a Front-Cover Text, and a >passage of up to 25 words as a Back-Cover Text, to the end of the list >of Cover Texts in the Modified Version. Only one passage of >Front-Cover Text and one of Back-Cover Text may be added by (or >through arrangements made by) any one entity. If the Document already >includes a cover text for the same cover, previously added by you or >by arrangement made by the same entity you are acting on behalf of, >you may not add another; but you may replace the old one, on explicit >permission from the previous publisher that added the old one. > >The author(s) and publisher(s) of the Document do not by this License >give permission to use their names for publicity for or to assert or >imply endorsement of any Modified Version. > > >5. COMBINING DOCUMENTS > >You may combine the Document with other documents released under this >License, under the terms defined in section 4 above for modified >versions, provided that you include in the combination all of the >Invariant Sections of all of the original documents, unmodified, and >list them all as Invariant Sections of your combined work in its >license notice. > >The combined work need only contain one copy of this License, and >multiple identical Invariant Sections may be replaced with a single >copy. If there are multiple Invariant Sections with the same name but >different contents, make the title of each such section unique by >adding at the end of it, in parentheses, the name of the original >author or publisher of that section if known, or else a unique number. >Make the same adjustment to the section titles in the list of >Invariant Sections in the license notice of the combined work. > >In the combination, you must combine any sections entitled "History" >in the various original documents, forming one section entitled >"History"; likewise combine any sections entitled "Acknowledgements", >and any sections entitled "Dedications". You must delete all sections >entitled "Endorsements." > > >6. COLLECTIONS OF DOCUMENTS > >You may make a collection consisting of the Document and other documents >released under this License, and replace the individual copies of this >License in the various documents with a single copy that is included in >the collection, provided that you follow the rules of this License for >verbatim copying of each of the documents in all other respects. > >You may extract a single document from such a collection, and distribute >it individually under this License, provided you insert a copy of this >License into the extracted document, and follow this License in all >other respects regarding verbatim copying of that document. > > > >7. AGGREGATION WITH INDEPENDENT WORKS > >A compilation of the Document or its derivatives with other separate >and independent documents or works, in or on a volume of a storage or >distribution medium, does not as a whole count as a Modified Version >of the Document, provided no compilation copyright is claimed for the >compilation. Such a compilation is called an "aggregate", and this >License does not apply to the other self-contained works thus compiled >with the Document, on account of their being thus compiled, if they >are not themselves derivative works of the Document. > >If the Cover Text requirement of section 3 is applicable to these >copies of the Document, then if the Document is less than one quarter >of the entire aggregate, the Document's Cover Texts may be placed on >covers that surround only the Document within the aggregate. >Otherwise they must appear on covers around the whole aggregate. > > >8. TRANSLATION > >Translation is considered a kind of modification, so you may >distribute translations of the Document under the terms of section 4. >Replacing Invariant Sections with translations requires special >permission from their copyright holders, but you may include >translations of some or all Invariant Sections in addition to the >original versions of these Invariant Sections. You may include a >translation of this License provided that you also include the >original English version of this License. In case of a disagreement >between the translation and the original English version of this >License, the original English version will prevail. > > >9. TERMINATION > >You may not copy, modify, sublicense, or distribute the Document except >as expressly provided for under this License. Any other attempt to >copy, modify, sublicense or distribute the Document is void, and will >automatically terminate your rights under this License. However, >parties who have received copies, or rights, from you under this >License will not have their licenses terminated so long as such >parties remain in full compliance. > > >10. FUTURE REVISIONS OF THIS LICENSE > >The Free Software Foundation may publish new, revised versions >of the GNU Free Documentation License from time to time. Such new >versions will be similar in spirit to the present version, but may >differ in detail to address new problems or concerns. See >http:///www.gnu.org/copyleft/. > >Each version of the License is given a distinguishing version number. >If the Document specifies that a particular numbered version of this >License "or any later version" applies to it, you have the option of >following the terms and conditions either of that specified version or >of any later version that has been published (not as a draft) by the >Free Software Foundation. If the Document does not specify a version >number of this License, you may choose any version ever published (not >as a draft) by the Free Software Foundation. > > >ADDENDUM: How to use this License for your documents > >To use this License in a document you have written, include a copy of >the License in the document and put the following copyright and >license notices just after the title page: > > Copyright (c) YEAR YOUR NAME. > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.1 > or any later version published by the Free Software Foundation; > with the Invariant Sections being LIST THEIR TITLES, with the > Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. > A copy of the license is included in the section entitled "GNU > Free Documentation License". > >If you have no Invariant Sections, write "with no Invariant Sections" >instead of saying which ones are invariant. If you have no >Front-Cover Texts, write "no Front-Cover Texts" instead of >"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. > >If your document contains nontrivial examples of program code, we >recommend releasing these examples in parallel under your choice of >free software license, such as the GNU General Public License, >to permit their use in free software. > > > mkdir -p -- . /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html > /usr/bin/install -c -m 644 ./api.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/api.html >/usr/bin/install: cannot stat `./api.html': No such file or directory > /usr/bin/install -c -m 644 ./backend-spec.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/backend-spec.html >/usr/bin/install: cannot stat `./backend-spec.html': No such file or directory > /usr/bin/install -c -m 644 ./docbook2man.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/docbook2man.html >/usr/bin/install: cannot stat `./docbook2man.html': No such file or directory > /usr/bin/install -c -m 644 ./docbook2texi.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/docbook2texi.html >/usr/bin/install: cannot stat `./docbook2texi.html': No such file or directory > /usr/bin/install -c -m 644 ./fdl.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/fdl.html >/usr/bin/install: cannot stat `./fdl.html': No such file or directory > /usr/bin/install -c -m 644 ./frontend-spec.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/frontend-spec.html >/usr/bin/install: cannot stat `./frontend-spec.html': No such file or directory > /usr/bin/install -c -m 644 ./helpers.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/helpers.html >/usr/bin/install: cannot stat `./helpers.html': No such file or directory > /usr/bin/install -c -m 644 ./index.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/index.html >/usr/bin/install: cannot stat `./index.html': No such file or directory > /usr/bin/install -c -m 644 ./introduction.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/introduction.html >/usr/bin/install: cannot stat `./introduction.html': No such file or directory > /usr/bin/install -c -m 644 ./intro-jw.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/intro-jw.html >/usr/bin/install: cannot stat `./intro-jw.html': No such file or directory > /usr/bin/install -c -m 644 ./intro-sgmldiff.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/intro-sgmldiff.html >/usr/bin/install: cannot stat `./intro-sgmldiff.html': No such file or directory > /usr/bin/install -c -m 644 ./jw.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/jw.html >/usr/bin/install: cannot stat `./jw.html': No such file or directory > /usr/bin/install -c -m 644 ./sgmldiff.html /var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/image//usr/share/doc/docbook-sgml-utils-0.6.14/html/sgmldiff.html >/usr/bin/install: cannot stat `./sgmldiff.html': No such file or directory >make[3]: *** [install-htmlDATA] Error 1 >make[3]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >make[2]: *** [install-am] Error 2 >make[2]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc/HTML' >make[1]: *** [install-recursive] Error 1 >make[1]: Leaving directory `/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/work/docbook-utils-0.6.14/doc' >make: *** [install-recursive] Error 1 > [31;01m*[0m > [31;01m*[0m ERROR: app-text/docbook-sgml-utils-0.6.14 failed. > [31;01m*[0m Call stack: > [31;01m*[0m ebuild.sh, line 49: Called src_install > [31;01m*[0m environment, line 2074: Called die > [31;01m*[0m The specific snippet of code: > [31;01m*[0m make DESTDIR="${D}" htmldir="/usr/share/doc/${PF}/html" install || die "Installation failed"; > [31;01m*[0m The die message: > [31;01m*[0m Installation failed > [31;01m*[0m > [31;01m*[0m If you need support, post the topmost build error, and the call stack if relevant. > [31;01m*[0m A complete build log is located at '/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/temp/build.log'. > [31;01m*[0m The ebuild environment file is located at '/var/tmp/portage/app-text/docbook-sgml-utils-0.6.14/temp/environment'. > [31;01m*[0m
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Raw
Actions:
View
Attachments on
bug 184551
:
164647
| 164889