1JW(1) JW(1)
2
6 jw, docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
7 docbook2rtf, docbook2tex, docbook2texi, docbook2txt - (Jade Wrapper)
8 converts SGML files to other formats
9
11 jw [ -f frontend | --frontend frontend ]
12 [ -b backend | --backend backend ]
13 [ -c file | --cat file ]
14 [ -n | --nostd ]
15 [ -d file|default|none | --dsl file|default|none ]
16 [ -l file | --dcl file ]
17 [ -s path | --sgmlbase path ]
18 [ -p program | --parser program ]
19 [ -o directory | --output directory ]
20 [ -V variable[=value] ]
21 [ -u | --nochunks ] [ -i section | --include section ]
22 [ -w type|list | --warning type|list ]
23 [ -e type|list | --error type|list ]
24 [ -h | --help ] [ -v | --version ]
25 SGML-file
26 docbook2dvi SGML-file
29 docbook2html SGML-file
32 docbook2man SGML-file
35 docbook2pdf SGML-file
38 docbook2ps SGML-file
41 docbook2rtf SGML-file
44 docbook2tex SGML-file
47 docbook2texi SGML-file
50 docbook2txt SGML-file
53
56 The jw shell script allows to convert a DocBook file (or some other
57 SGML-based format) to other formats (including HTML, RTF, PS and PDF)
58 with an easy-to-understand syntax. It hides most of Jade's or OpenJade
59 complexity and adds comfortable features.
60 Other scripts like docbook2html, docbook2rtf or docbook2ps provide dif‐
62 ferent ways of calling jw that might be easier to remember.
63 For the moment, jw does not handle XML, but only SGML.
65 This utility assumes that several other components are installed. The
67 list includes:
68 · the ISO character entities for SGML
70 · James Clark's DSSSL engine, jade, or an equivalent parser like Open‐
72 Jade
73 · the DocBook DTD from the OASIS consortium
75 · Norman Walsh's DocBook modular style sheets (or some other set of
77 DSSSL style sheets)
78 · Sebastian Rahtz's jadetex set of TeX macros for jade (for backends
80 intended to "printing" formats like PDF, RTF or PostScript)
81 · A perl interpreter (for backends that use perl)
83 · SGMLSpm from CPAN (for backends that use sgmls)
85 · Lynx HTML browser (for the txt backend)
87 The jw script is basically called like this:
89 jw mydoc.sgml
91 where mydoc.sgml is a SGML file.
93 The command line above uses default options: it converts from DocBook
95 (the default frontend) to HTML (the default backend), does not put the
96 result in a subdirectory (unless specified otherwise in the style
97 sheets), etc.
98 In this example, the "mydoc" file name as well as the ".sgml" extension
100 can be replaced by anything else. Current extensions for SGML DocBook
101 files include ".sgml", ".sgm", ".docbook", and ".db". The processed
102 file mydoc.sgml can be in any other directory than the current one.
103 Here we have chosen to generate HTML output. In fact we can use any of
105 the backends stored in the backends/ subdirectory of the DocBook-utils
106 distribution directory (usually /usr/share/sgml/docbook/utils-0.6.14).
107 Similarly, you can use any frontend defined in the frontends/ subdirec‐
108 tory to convert from another input format.
109 This sample command creates one or many HTML files with arbitrary file
111 names in the current directory. This default behavior can be changed
112 through command line options and/or customization style sheets.
113
115 The following options apply to the conversion script:
116 -f frontend | --frontend frontend
118 Allows to specify another frontend than default docbook. The
119 list of currently available frontends is:
120 docbook
122 Converts docbook with Norman Walsh's style sheets. This
123 frontend searches in the subdirectories of the base SGML
124 directory for a file named html/docbook.dsl or print/doc‐
125 book.dsl (depending on the backend's type: html or
126 print).
127 -b backend | --backend backend
129 Allows to specify another backend than default HTML. The list of
130 currently available backends is:
131 dvi Converts to DVI (DeVice Independant files) by calling
133 Jade or OpenJade.
134 html Converts to HTML (HyperText Markup Language) by calling
136 Jade or OpenJade.
137 man Converts a refentry to a Unix manual page by calling doc‐
139 book2man. Does not work with other SGML document types
140 than DocBook.
141 pdf Converts to PDF (Portable Document Format) by calling
143 Jade or OpenJade.
144 ps Converts to PostScript by calling Jade or OpenJade.
146 rtf Converts to RTF (Rich Text Format) by calling Jade or
148 OpenJade. The resulting file can then be inported into MS
149 Word or one of its Linux replacement programs.
150 tex Converts to TeX by calling Jade or OpenJade.
152 texi Converts to GNU TeXinfo pages by calling docbook2texi.
154 Does not work with other SGML document types than Doc‐
155 Book.
156 txt Converts to a bare text file by calling Jade or OpenJade,
158 then Lynx.
159 -c file | --cat file
161 Allows to use an extra SGML Open Catalog that will list other
162 files like customization style sheets, adaptations to the Doc‐
163 Book Document Type Definition, special character entities, etc.
164 This catalog is added to the list of catalogs determined by the
165 script (see option --nostd below)
166 -n | --nostd
168 Do not use the standard SGML Open Catalogs. Normally, the stan‐
169 dard catalogs list is determined like this:
170 · if the centralized catalog exists, then use it. The central‐
172 ized catalog is a list of all catalogs that might be necessary
173 that usually resides in /etc/sgml. Its name is provided by the
174 frontend, for example the docbook frontend returns
175 /etc/sgml/sgml-docbook.cat.
176 · Otherwise, take all the files named catalog from the subdirec‐
178 tories of the SGML base directory (usually /usr/share/sgml).
179 This option is useful in conjunction with the --cat option to use only
180 the catalogs that are specified on the command line.
181 -d file|default|none | --dsl file|default|none
183 Allows to use a customized style sheet instead of the default
184 one.
185 A "target" starting with a hash mark "#" can be appended to the
187 file name. As a result, only the corresponding part of the style
188 sheet is executed (the "style specification" whose "identifica‐
189 tor" is equal to the target's name). A common use of this mecha‐
190 nism is to define "#html" and "#print" targets to trigger the
191 corresponding part of a replacement style sheet which is common
192 for both HTML and printout conversion.
193 By replacing the file name with "default", the default style
195 sheet provided with the frontend is used. For example, the doc‐
196 book frontend returns ./docbook.dsl#html (or ./doc‐
197 book.dsl#print) in the SGML base directory.
198 By replacing the file name with "none", no replacement style
200 sheet is used, not even the default style sheet. The style sheet
201 which is used is also determined by the frontend. For example,
202 the docbook frontend returns Norman Walsh's html/docbook.dsl (or
203 print/docbook.dsl) found somewhere below the SGML base direc‐
204 tory.
205 If no --dsl option is specified, then "--dsl default" is used.
207 -l file | --dcl file
209 Allows to use a customized SGML declaration instead of the
210 default one. The file name of the default SGML declaration is
211 not set for SGML files, and is set to xml.dcl in the SGML base
212 directory for XML files.
213 -s path | --sgmlbase path
215 Allows to use another location for the SGML base directory. This
216 is the directory below which all SGML DTDs, style sheets, enti‐
217 ties, etc are installed. The default value is /usr/share/sgml.
218 -p program | --parser program
220 Specify the parser to use (Jade or OpenJade) if several are
221 installed. If this option is not specified, the script first
222 tries to use Jade, then it tries OpenJade.
223 -o directory | --output directory
225 Set output directory where all the resulting files will be
226 stored. If the style sheets define a subdirectory where to store
227 the resulting files too, the subdirectory defined by the style
228 sheets will be placed below the subdirectory defined by this
229 option.
230 -V variable=[value]
232 Set a variable (to a value, if one is specified).
233 -u | --nochunks
235 Output only one big file. This option is useful only when gener‐
236 ating HTML, because the output can be split into several files.
237 This option overrides the setting that may be done in the style
238 sheets.
239 -i section | --include section
241 Declare a SGML marked section as "include". A SGML marked sec‐
242 tion is a kind of conditional part of a document. If it is
243 declared "ignore", it will be left ignored, otherwise it will be
244 processed. An example of such a marked section would be:
245 <DOCTYPE mydoc [
247 <!ENTITY % confidential "ignore">
248 ]>
249 <mydoc>
250 ...
251 <![ %confidential [ Some confidential text... ]]>
252 ...
253 </mydoc>
254 -w type|list | --warning type|list
257 Enables or disables the display of given types of warnings.
258 Several -w options might be entered on the command line. Warn‐
259 ing types that start with "no-" disable the corresponding warn‐
260 ings, the other types enable them.
261 If the warning type is replaced with "list", then a list of
263 allowed warning types is displayed.
264 -e type|list | --error type|list
266 Disables given types of errors. Several -e options might be
267 entered on the command line. All error types start with "no-".
268 If the error type is replaced with "list", then a list of
270 allowed error types is displayed.
271 -h | --help
273 Print a short help message and exit
274 -v | --version
276 Print the version identifier and exit
277
279 /etc/sgml/sgml-docbook.cat
280 Centralized SGML open catalog. This file name might vary if
281 another frontend than docbook is used.
282 /usr/share/sgml/docbook/utils-0.6.14/backends
284 The various backends
285 /usr/share/sgml/docbook/utils-0.6.14/frontends
287 The various frontends
288 /usr/share/sgml/docbook/utils-0.6.14/helpers
290 The various helper scripts like docbook2man or docbook2texi
291
293 Eric Bischoff (jw shell script and a few backends), Jochem Huhmann (the
294 man and texi backends)
295
297 docbook2man-spec.pl(1), docbook2texi-spec.pl(1), install-catalog(8),
298 nsgmls(1), docbook-utils homepage <URL:http://sources.redhat.com/doc‐
299 book-tools/>.
300 24 May 2007 JW(1)