NAME¶

jw, docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps, docbook2rtf, docbook2tex, docbook2texi, docbook2txt - (Jade Wrapper) converts SGML files to other formats

SYNOPSIS¶

jw [ -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 | --version ]
SGML-file

docbook2dvi SGML-file

docbook2html SGML-file

docbook2man SGML-file

docbook2pdf SGML-file

docbook2ps SGML-file

docbook2rtf SGML-file

docbook2tex SGML-file

docbook2texi SGML-file

docbook2txt SGML-file

DESCRIPTION¶

The 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 areinstalled. The list includes:

•

the ISO character entities for SGML

•

James Clark's DSSSL engine, jade, or an equivalent parserlike OpenJade

•

the DocBook DTD from the OASIS consortium

•

Norman Walsh's DocBook modular style sheets (or some otherset of DSSSL style sheets)

•

Sebastian Rahtz's jadetex set of TeX macros for jade(for backends intended to "printing" formats like PDF, RTF orPostScript)

•

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.sgml

where mydoc.sgml is a SGML file.

The command line above uses default options: it convertsfrom DocBook (the default frontend) to HTML (the default backend),does not put the result in a subdirectory (unless specifiedotherwise 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 extensionsfor 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 canuse any of the backends stored in the backends/ subdirectory of the DocBook-utils distribution directory (usually /usr/share/docbook-utils). 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 witharbitrary file names in the current directory. This default behaviorcan be changed through command line options and/or customizationstyle sheets.

OPTIONS¶

The 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:

-b backend | --backend backend

Allows to specify another backend than defaultHTML. The list of currently available backends is:

-c file | --cat file

Allows to use an extra SGML Open Catalog that will listother files like customization style sheets, adaptations to theDocBook Document Type Definition, special character entities,etc. This catalog is added to the list of catalogs determinedby the script (see option --nostd below)

-n | --nostd

Do not use the standard SGML Open Catalogs. Normally,the standard catalogs list is determined like this:

-d file|default|none | --dsl file|default|none

Allows to use a customized style sheet insteadof the default one.

A "target" starting with a hash mark "#" can be appendedto the file name. As a result, only the corresponding partof the style sheet is executed (the "style specification" whose"identificator" is equal to the target's name). A common use of thismechanism is to define "#html" and "#print" targets to triggerthe corresponding part of a replacement style sheet which iscommon for both HTML and printout conversion.

By replacing the file name with "default", the defaultstyle sheet provided with the frontend is used. For example, thedocbook frontend returns ./docbook.dsl#html (or ./docbook.dsl#print) in the SGML base directory.

By replacing the file name with "none", no replacementstyle sheet is used, not even the default style sheet. The stylesheet which is used is also determined by the frontend. Forexample, 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" isused.

-l file | --dcl file

Allows to use a customized SGML declaration insteadof the default one. The file name of the default SGMLdeclaration is not set for SGML files, and is set toxml.dcl in the SGML base directory for XML files.

-s path | --sgmlbase path

Allows to use another location for the SGML basedirectory. This is the directory below which all SGML DTDs,style sheets, entities, etc are installed. The default valueis /usr/share/sgml.

-p program | --parser program

Specify 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 directory

Set output directory where all the resulting files willbe stored. If the style sheets define a subdirectory where tostore the resulting files too, the subdirectory defined by thestyle sheets will be placed below the subdirectory defined bythis option.

-V variable=[value]

Set a variable (to a value, if one is specified).

-u | --nochunks

Output only one big file. This option is useful onlywhen generating HTML, because the output can be split intoseveral files. This option overrides the setting that may bedone in the style sheets.

-i section | --include section

Declare a SGML marked section as "include". A SGML markedsection is a kind of conditional part of a document. If it isdeclared "ignore", it will be left ignored, otherwise it willbe 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|list

Enables 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 correspondingwarnings, the other types enable them.

If the warning type is replaced with "list", thena list of allowed warning types is displayed.

-e type|list | --error type|list

Disables 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", thena list of allowed error types is displayed.

-h | --help

Print a short help message and exit

-v | --version

Print the version identifier and exit

FILES¶

/etc/sgml/sgml-docbook.cat

Centralized SGML open catalog. This file name mightvary if another frontend than docbook is used.

/usr/share/docbook-utils/backends

The various backends

/usr/share/docbook-utils/frontends

The various frontends

/usr/share/perl5/sgmlspl-specs

The various helper scripts like docbook2man or docbook2texi

AUTHORS¶

Eric Bischoff (jw shell script and a few backends),Jochem Huhmann (the man and texi backends)

SEE ALSO¶

docbook2man-spec.pl(1), docbook2texi-spec.pl(1), install-catalog(8), onsgmls(1), docbook-utils homepage <URL:http://sources.redhat.com/docbook-tools/>.