db2x_texixml(1) | docbook2X | db2x_texixml(1) |
NAME¶
db2x_texixml - Make Texinfo files from Texi-XMLSYNOPSIS¶
db2x_texixml
[options]... [ xml-document]
DESCRIPTION¶
db2x_texixml converts a Texi-XML document into one or more Texinfo documents. If xml-document is not given, then the document to convert comes from standard input. The filenames of the Texinfo documents are determined by markup in the Texi-XML source. (If the filenames are not specified in the markup, then db2x_texixml attempts to deduce them from the name of the input file. However, the Texi-XML source should specify the filename, because it does not work when there are multiple output files or when the Texi-XML source comes from standard input.)OPTIONS¶
- --encoding=encoding
- Select the character encoding used for the output files.
The available encodings are those of iconv(1). The default encoding
is us-ascii.
- --list-files
- Write a list of all the output files to standard output, in addition to normal processing.
- --output-dir=dir
- Specify the directory where the output files are placed.
The default is the current working directory.
- --to-stdout
- Write the output to standard output instead of to
individual files.
- --info
- Pipe the Texinfo output to makeinfo(1), creating Info files directly instead of Texinfo files.
- --plaintext
- Pipe the Texinfo output to makeinfo --no-headers, thereby creating plain text files.
- --help
- Show brief usage information and exit.
- --version
- Show version and exit.
- --utf8trans-program=path, --utf8trans-map= charmap
- Use the character map charmap with the utf8trans(1) program, included with docbook2X, found under path.
- --iconv-program=path
- The location of the iconv(1) program, used for encoding conversions.
NOTES¶
Texinfo language compatibility. The Texinfo files generated by db2x_texixml sometimes require Texinfo version 4.7 (the latest version) to work properly. In particular:- •
- db2x_texixml relies on makeinfo to automatically add punctuation after a @ref if it it not already there. Otherwise the hyperlink will not work in the Info reader (although makeinfo will not emit any error).
- •
- The new @comma{} command is used for commas (,) occurring
inside argument lists to Texinfo commands, to disambiguate it from the
comma used to separate different arguments. The only alternative otherwise
would be to translate , to . which is obviously undesirable (but earlier
docbook2X versions did this).
BUGS¶
- •
- Text wrapping in menus is utterly broken for non-ASCII text. It is probably also broken everywhere else in the output, but that would be makeinfo’s fault.
- •
- --list-files might not work correctly with --info. Specifically, when the output Info file get too big, makeinfo will decide to split it into parts named abc.info-1, abc.info-2, abc.info-3, etc. db2x_texixml does not know exactly how many of these files there are, though you can just do an ls to find out.
AUTHOR¶
Steve Cheng <stevecheng@users.sourceforge.net>.SEE ALSO¶
The docbook2X manual (in Texinfo or HTML format) fully describes how to convert DocBook to man pages and Texinfo. Up-to-date information about this program can be found at the docbook2X Web site ⟨http://docbook2x.sourceforge.net/⟩ . The input to db2x_texixml is defined by the XML DTD present at dtd/Texi-XML in the docbook2X distribution.3 March 2007 | docbook2X 0.8.8 |