db2x_manxml — Make man pages from Man-XML
db2x_manxml
[options
] [xml-document
]
db2x_manxml converts a Man-XML document into one or more man pages. They are written in the current directory.
If xml-document
is not
given, then the document to convert is read from standard
input.
--encoding=encoding
Select the character encoding used for the output files. The
available encodings are those of iconv. The default encoding
is us-ascii
.
The XML source may contain characters that are not representable
in the encoding that you select; in this case the program will bomb
out during processing, and you should choose another encoding.
(This is guaranteed not to happen with any Unicode encoding such as
UTF-8
, but unfortunately not everyone
is able to process Unicode texts.)
If you are using GNU’s version of iconv, you can affix
//TRANSLIT
to the end of the encoding
name to attempt transliterations of any unconvertible characters in
the output. Beware, however, that the really inconvertible
characters will be turned into another of those damned question
marks. (Aren’t you sick of this?)
--list-files
Write a list of all the output files to standard output, in addition to normal processing.
--to-stdout
Write the output to standard output instead of to individual files.
If this option is used even when there are supposed to be multiple output documents, then everything is concatenated to standard output. But beware that most other programs will not accept this concatenated output.
This option is incompatible with --list-files
, obviously.
--help
Show brief usage information and exit.
--version
Show version and exit.
Some man pages may be referenced under two or more names, instead of just one. For example, strcpy and strncpy often point to the same man page which describes the two functions together. Choose one of the following options to select how such man pages are to be generated:
--symlinks
For each of all the alternate names for a man page, erect symbolic links to the file that contains the real man page content.
--solinks
Generate stub pages (using .so
roff
requests) for the alternate names, pointing them to the real man
page content.
--no-links
Do not make any alternative names available. The man page can only be referenced under its principal name.
This program uses certain other programs for its operation. If they are not in their default installed locations, then use the following options to set their location:
--utf8trans-program=path
, --utf8trans-map=charmap
Use the character map charmap
with the utf8trans program, included with
docbook2X, found under path
.
--iconv-program=path
The location of the iconv program, used for encoding conversions.