|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
Packit |
e4b6da |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
Packit |
e4b6da |
<head>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"text/html; charset=us-ascii" />
|
|
Packit |
e4b6da |
<title>docbook2X: db2x_manxml</title>
|
|
Packit |
e4b6da |
<link rel="stylesheet" href="docbook2X.css" type="text/css" />
|
|
Packit |
e4b6da |
<link rev="made" href="mailto:stevecheng@users.sourceforge.net" />
|
|
Packit |
e4b6da |
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Documentation Table of Contents" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Converting to man pages" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: docbook2man" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Converting to Texinfo" />
|
|
Packit |
e4b6da |
</head>
|
|
Packit |
e4b6da |
<body>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"command">db2x_manxml
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2man.html"><< Previous
|
|
Packit |
e4b6da |
Converting to man pages
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"texinfo.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="db2x_manxml">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2525868" class="indexterm" name="id2525868">
|
|
Packit |
e4b6da |
"id2525875" class="indexterm" name="id2525875">
|
|
Packit |
e4b6da |
"id2525882" class="indexterm" name="id2525882">
|
|
Packit |
e4b6da |
"id2525889" class="indexterm" name="id2525889">
|
|
Packit |
e4b6da |
"id2525895" class="indexterm" name="id2525895">
|
|
Packit |
e4b6da |
"id2525947" class="indexterm" name="id2525947">
|
|
Packit |
e4b6da |
"id2525953" class="indexterm" name="id2525953">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Name
|
|
Packit |
e4b6da |
db2x_manxml
|
|
Packit |
e4b6da |
— Make man pages from Man-XML
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Synopsis
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
db2x_manxml [
|
|
Packit |
e4b6da |
"replaceable">options] [
|
|
Packit |
e4b6da |
"replaceable">xml-document]
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2526027">
|
|
Packit |
e4b6da |
Description
|
|
Packit |
e4b6da |
db2x_manxml
|
|
Packit |
e4b6da |
converts a Man-XML document into one or more man pages. They are
|
|
Packit |
e4b6da |
written in the current directory.
|
|
Packit |
e4b6da |
If xml-document is not
|
|
Packit |
e4b6da |
given, then the document to convert is read from standard
|
|
Packit |
e4b6da |
input.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2526053">
|
|
Packit |
e4b6da |
Options
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--encoding=
|
|
Packit |
e4b6da |
"replaceable">encoding
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Select the character encoding used for the output files. The
|
|
Packit |
e4b6da |
available encodings are those of
|
|
Packit |
e4b6da |
"citerefentry">
|
|
Packit |
e4b6da |
"command">iconv. The default encoding
|
|
Packit |
e4b6da |
is us-ascii.
|
|
Packit |
e4b6da |
The XML source may contain characters that are not representable
|
|
Packit |
e4b6da |
in the encoding that you select; in this case the program will bomb
|
|
Packit |
e4b6da |
out during processing, and you should choose another encoding.
|
|
Packit |
e4b6da |
(This is guaranteed not to happen with any Unicode encoding such as
|
|
Packit |
e4b6da |
UTF-8, but unfortunately not everyone is able to process Unicode
|
|
Packit |
e4b6da |
texts.)
|
|
Packit |
e4b6da |
If you are using GNU’s version of
|
|
Packit |
e4b6da |
"citerefentry">
|
|
Packit |
e4b6da |
"command">iconv, you can affix
|
|
Packit |
e4b6da |
//TRANSLIT to the end of the encoding
|
|
Packit |
e4b6da |
name to attempt transliterations of any unconvertible characters in
|
|
Packit |
e4b6da |
the output. Beware, however, that the really inconvertible
|
|
Packit |
e4b6da |
characters will be turned into another of those damned question
|
|
Packit |
e4b6da |
marks. (Aren’t you sick of this?)
|
|
Packit |
e4b6da |
The suffix //TRANSLIT applied to a
|
|
Packit |
e4b6da |
Unicode encoding — in particular,
|
|
Packit |
e4b6da |
"literal">utf-8//TRANSLIT — means that the output
|
|
Packit |
e4b6da |
files are to remain in Unicode, but markup-level character
|
|
Packit |
e4b6da |
translations using
|
|
Packit |
e4b6da |
"command">utf8trans are still to be done. So in
|
|
Packit |
e4b6da |
most cases, an English-language document, converted using
|
|
Packit |
e4b6da |
--encoding=
|
|
Packit |
e4b6da |
"literal">utf-8//TRANSLIT will actually end up as a
|
|
Packit |
e4b6da |
US-ASCII document, but any untranslatable characters will remain as
|
|
Packit |
e4b6da |
UTF-8 without any warning whatsoever. (Note: strictly speaking this
|
|
Packit |
e4b6da |
is not “transliteration”.) This method of conversion is
|
|
Packit |
e4b6da |
a compromise over strict
|
|
Packit |
e4b6da |
"option">--encoding=us-ascii
|
|
Packit |
e4b6da |
processing, which aborts if any untranslatable characters are
|
|
Packit |
e4b6da |
encountered.
|
|
Packit |
e4b6da |
Note that man pages and Texinfo documents in non-ASCII encodings
|
|
Packit |
e4b6da |
(including UTF-8) may not be portable to older
|
|
Packit |
e4b6da |
(non-internationalized) systems, which is why the default value for
|
|
Packit |
e4b6da |
this option is us-ascii.
|
|
Packit |
e4b6da |
To suppress any automatic character mapping or encoding
|
|
Packit |
e4b6da |
conversion whatsoever, pass the option
|
|
Packit |
e4b6da |
"option">--encoding=utf-8.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--list-files
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Write a list of all the output files to standard output, in
|
|
Packit |
e4b6da |
addition to normal processing.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--output-dir=
|
|
Packit |
e4b6da |
"replaceable">dir
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Specify the directory where the output files are placed. The
|
|
Packit |
e4b6da |
default is the current working directory.
|
|
Packit |
e4b6da |
This option is ignored if the output is to be written to
|
|
Packit |
e4b6da |
standard output (triggered by the option
|
|
Packit |
e4b6da |
"option">--to-stdout).
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--to-stdout
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Write the output to standard output instead of to individual
|
|
Packit |
e4b6da |
files.
|
|
Packit |
e4b6da |
If this option is used even when there are supposed to be
|
|
Packit |
e4b6da |
multiple output documents, then everything is concatenated to
|
|
Packit |
e4b6da |
standard output. But beware that most other programs will not
|
|
Packit |
e4b6da |
accept this concatenated output.
|
|
Packit |
e4b6da |
This option is incompatible with
|
|
Packit |
e4b6da |
"option">--list-files, obviously.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--help
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Show brief usage information and exit.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--version
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Show version and exit.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Some man pages may be referenced under two or more names,
|
|
Packit |
e4b6da |
instead of just one. For example,
|
|
Packit |
e4b6da |
"citerefentry">strcpy and
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"refentrytitle">strncpy often point to the same man
|
|
Packit |
e4b6da |
page which describes the two functions together. Choose one of the
|
|
Packit |
e4b6da |
following options to select how such man pages are to be
|
|
Packit |
e4b6da |
generated:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--symlinks
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
For each of all the alternate names for a man page, erect
|
|
Packit |
e4b6da |
symbolic links to the file that contains the real man page
|
|
Packit |
e4b6da |
content.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--solinks
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Generate stub pages (using .so roff
|
|
Packit |
e4b6da |
requests) for the alternate names, pointing them to the real man
|
|
Packit |
e4b6da |
page content.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--no-links
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Do not make any alternative names available. The man page can
|
|
Packit |
e4b6da |
only be referenced under its principal name.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This program uses certain other programs for its operation. If
|
|
Packit |
e4b6da |
they are not in their default installed locations, then use the
|
|
Packit |
e4b6da |
following options to set their location:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--utf8trans-program=
|
|
Packit |
e4b6da |
"replaceable">path,
|
|
Packit |
e4b6da |
"term">--utf8trans-map=
|
|
Packit |
e4b6da |
"replaceable">charmap
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Use the character map
|
|
Packit |
e4b6da |
"replaceable">charmap with the
|
|
Packit |
e4b6da |
"utf8trans.html">
|
|
Packit |
e4b6da |
"command">utf8trans program, included with
|
|
Packit |
e4b6da |
docbook2X, found under
|
|
Packit |
e4b6da |
"replaceable">path.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--iconv-program=
|
|
Packit |
e4b6da |
"replaceable">path
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The location of the
|
|
Packit |
e4b6da |
"refentrytitle">
|
|
Packit |
e4b6da |
"command">iconv program, used for
|
|
Packit |
e4b6da |
encoding conversions.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2526192">
|
|
Packit |
e4b6da |
Notes
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2526195" class="indexterm" name="id2526195">
|
|
Packit |
e4b6da |
The man pages produced should be compatible with most troff
|
|
Packit |
e4b6da |
implementations and other tools that process man pages. Some
|
|
Packit |
e4b6da |
backwards-compatible
|
|
Packit |
e4b6da |
"refentrytitle">
|
|
Packit |
e4b6da |
"command">groff extensions are used
|
|
Packit |
e4b6da |
to make the output look nicer.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2526549">
|
|
Packit |
e4b6da |
See Also
|
|
Packit |
e4b6da |
The input to
|
|
Packit |
e4b6da |
"command">db2x_manxml is defined by the XML DTD
|
|
Packit |
e4b6da |
present at dtd/Man-XML in the
|
|
Packit |
e4b6da |
docbook2X distribution.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2man.html"><< Previous
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"manpages.html">Up
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"texinfo.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
docbook2man
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X.html">Table of Contents
|
|
Packit |
e4b6da |
Converting to
|
|
Packit |
e4b6da |
Texinfo
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://docbook2x.sourceforge.net/" title=
|
|
Packit |
e4b6da |
"docbook2X: Home page">docbook2X home page
|
|
Packit |
e4b6da |
</body>
|
|
Packit |
e4b6da |
</html>
|