|
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: docbook2man</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: Converting to man pages" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: db2x_manxml" />
|
|
Packit |
e4b6da |
</head>
|
|
Packit |
e4b6da |
<body>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
docbook2man
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"manpages.html"><< Previous
|
|
Packit |
e4b6da |
Converting to man pages
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"db2x_manxml.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="docbook2man">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2524161" class="indexterm" name="id2524161">
|
|
Packit |
e4b6da |
"id2524167" class="indexterm" name="id2524167">
|
|
Packit |
e4b6da |
"id2524174" class="indexterm" name="id2524174">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Name
|
|
Packit |
e4b6da |
docbook2man
|
|
Packit |
e4b6da |
— Convert DocBook to man pages
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Synopsis
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
docbook2man [
|
|
Packit |
e4b6da |
"replaceable">options]
|
|
Packit |
e4b6da |
"replaceable">xml-document
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2524255">
|
|
Packit |
e4b6da |
Description
|
|
Packit |
e4b6da |
docbook2man
|
|
Packit |
e4b6da |
converts the given DocBook XML document into man pages. By default,
|
|
Packit |
e4b6da |
the man pages will be output to the current directory.
|
|
Packit |
e4b6da |
Only
|
|
Packit |
e4b6da |
the refentry content in the
|
|
Packit |
e4b6da |
DocBook document is converted. (To convert content outside of a
|
|
Packit |
e4b6da |
refentry, stylesheet
|
|
Packit |
e4b6da |
customization is required. See the docbook2X package for
|
|
Packit |
e4b6da |
details.)
|
|
Packit |
e4b6da |
The docbook2man
|
|
Packit |
e4b6da |
command is a wrapper script for a two-step conversion process.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2524319">
|
|
Packit |
e4b6da |
Options
|
|
Packit |
e4b6da |
The available options are essentially the union of the options
|
|
Packit |
e4b6da |
from
|
|
Packit |
e4b6da |
"command">db2x_xsltproc and
|
|
Packit |
e4b6da |
"db2x_manxml.html">
|
|
Packit |
e4b6da |
"command">db2x_manxml.
|
|
Packit |
e4b6da |
Some commonly-used options are listed below:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--encoding=
|
|
Packit |
e4b6da |
"replaceable">encoding
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Sets the character encoding of the output.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--string-param
|
|
Packit |
e4b6da |
parameter=
|
|
Packit |
e4b6da |
"replaceable">value
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Sets a stylesheet parameter (options that affect how the output
|
|
Packit |
e4b6da |
looks). See “Stylesheet parameters” below for the
|
|
Packit |
e4b6da |
parameters that can be set.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--sgml
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Accept an SGML source document as input instead of XML.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--solinks
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Make stub pages for alternate names for an output man page.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2524406">
|
|
Packit |
e4b6da |
Stylesheet parameters
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">uppercase-headings
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Make headings uppercase?
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
(boolean true)
|
|
Packit |
e4b6da |
Headings in man page content should be or should not be
|
|
Packit |
e4b6da |
uppercased.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">manvolnum-cite-numeral-only
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Man page section citation should use only the
|
|
Packit |
e4b6da |
number
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
(boolean true)
|
|
Packit |
e4b6da |
When citing other man pages, the man-page section is either
|
|
Packit |
e4b6da |
given as is, or has the letters stripped from it, citing only the
|
|
Packit |
e4b6da |
number of the section (e.g. section 3x
|
|
Packit |
e4b6da |
becomes 3). This option specifies
|
|
Packit |
e4b6da |
which style.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">quotes-on-literals
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Display quotes on
|
|
Packit |
e4b6da |
"sgmltag-element">literal elements?
|
|
Packit |
e4b6da |
Default setting. 0
|
|
Packit |
e4b6da |
(boolean false)
|
|
Packit |
e4b6da |
If true, render literal
|
|
Packit |
e4b6da |
elements with quotes around them.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">show-comments
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Display
|
|
Packit |
e4b6da |
"sgmltag-element">comment elements?
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
(boolean true)
|
|
Packit |
e4b6da |
If true, comments will be displayed, otherwise they are
|
|
Packit |
e4b6da |
suppressed. Comments here refers to the
|
|
Packit |
e4b6da |
"sgmltag-element">comment element, which will be renamed
|
|
Packit |
e4b6da |
remark in DocBook V4.0, not
|
|
Packit |
e4b6da |
XML comments (<-- like this -->) which are unavailable.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">function-parens
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Generate parentheses after a function?
|
|
Packit |
e4b6da |
Default setting. 0
|
|
Packit |
e4b6da |
(boolean false)
|
|
Packit |
e4b6da |
If true, the formatting of a
|
|
Packit |
e4b6da |
"sgmltag-starttag"><function> element will include
|
|
Packit |
e4b6da |
generated parenthesis.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">xref-on-link
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Should
|
|
Packit |
e4b6da |
"sgmltag-element">link generate a cross-reference?
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
(boolean true)
|
|
Packit |
e4b6da |
Man pages cannot render the hypertext links created by
|
|
Packit |
e4b6da |
link. If this option is set,
|
|
Packit |
e4b6da |
then the stylesheet renders a cross reference to the target of the
|
|
Packit |
e4b6da |
link. (This may reduce clutter). Otherwise, only the content of the
|
|
Packit |
e4b6da |
link is rendered and the
|
|
Packit |
e4b6da |
actual link itself is ignored.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">header-3
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Third header text
|
|
Packit |
e4b6da |
Default setting. (blank)
|
|
Packit |
e4b6da |
Specifies the text of the third header of a man page, typically
|
|
Packit |
e4b6da |
the date for the man page. If empty, the
|
|
Packit |
e4b6da |
"sgmltag-element">date content for the
|
|
Packit |
e4b6da |
"sgmltag-element">refentry is used.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">header-4
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Fourth header text
|
|
Packit |
e4b6da |
Default setting. (blank)
|
|
Packit |
e4b6da |
Specifies the text of the fourth header of a man page. If empty,
|
|
Packit |
e4b6da |
the refmiscinfo content for
|
|
Packit |
e4b6da |
the refentry is used.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">header-5
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Fifth header text
|
|
Packit |
e4b6da |
Default setting. (blank)
|
|
Packit |
e4b6da |
Specifies the text of the fifth header of a man page. If empty,
|
|
Packit |
e4b6da |
the “manual name”, that is,
|
|
Packit |
e4b6da |
the title of the book or
|
|
Packit |
e4b6da |
reference container is
|
|
Packit |
e4b6da |
used.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">default-manpage-section
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Default man page section
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
The source document usually indicates the sections that each man
|
|
Packit |
e4b6da |
page should belong to (with
|
|
Packit |
e4b6da |
"sgmltag-element">manvolnum in
|
|
Packit |
e4b6da |
"sgmltag-element">refmeta). In case the source document does
|
|
Packit |
e4b6da |
not indicate man-page sections, this option specifies the
|
|
Packit |
e4b6da |
default.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">custom-localization-file
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. URI of XML document containing custom
|
|
Packit |
e4b6da |
localization data
|
|
Packit |
e4b6da |
Default setting. (blank)
|
|
Packit |
e4b6da |
This parameter specifies the URI of a XML document that
|
|
Packit |
e4b6da |
describes text translations (and other locale-specific information)
|
|
Packit |
e4b6da |
that is needed by the stylesheet to process the DocBook
|
|
Packit |
e4b6da |
document.
|
|
Packit |
e4b6da |
The text translations pointed to by this parameter always
|
|
Packit |
e4b6da |
override the default text translations (from the internal parameter
|
|
Packit |
e4b6da |
localization-file). If a
|
|
Packit |
e4b6da |
particular translation is not present here, the corresponding
|
|
Packit |
e4b6da |
default translation is used as a fallback.
|
|
Packit |
e4b6da |
This parameter is primarily for changing certain punctuation
|
|
Packit |
e4b6da |
characters used in formatting the source document. The settings for
|
|
Packit |
e4b6da |
punctuation characters are often specific to the source document,
|
|
Packit |
e4b6da |
but can also be dependent on the locale.
|
|
Packit |
e4b6da |
To not use custom text translations, leave this parameter as the
|
|
Packit |
e4b6da |
empty string.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">custom-l10n-data
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. XML document containing custom localization
|
|
Packit |
e4b6da |
data
|
|
Packit |
e4b6da |
Default setting.
|
|
Packit |
e4b6da |
"literal">document($custom-localization-file)
|
|
Packit |
e4b6da |
This parameter specifies the XML document that describes text
|
|
Packit |
e4b6da |
translations (and other locale-specific information) that is needed
|
|
Packit |
e4b6da |
by the stylesheet to process the DocBook document.
|
|
Packit |
e4b6da |
This parameter is internal to the stylesheet. To point to an
|
|
Packit |
e4b6da |
external XML document with a URI or a file name, you should use the
|
|
Packit |
e4b6da |
custom-localization-file
|
|
Packit |
e4b6da |
parameter instead.
|
|
Packit |
e4b6da |
However, inside a custom stylesheet (
|
|
Packit |
e4b6da |
"emphasis">not on the command-line) this paramter
|
|
Packit |
e4b6da |
can be set to the XPath expression
|
|
Packit |
e4b6da |
"literal">document(''), which will cause the custom
|
|
Packit |
e4b6da |
translations directly embedded inside the custom stylesheet to be
|
|
Packit |
e4b6da |
read.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"parameter">author-othername-in-middle
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Brief. Is
|
|
Packit |
e4b6da |
"sgmltag-element">othername in
|
|
Packit |
e4b6da |
"sgmltag-element">author a middle name?
|
|
Packit |
e4b6da |
Default setting. 1
|
|
Packit |
e4b6da |
If true, the othername of
|
|
Packit |
e4b6da |
an author appears between the
|
|
Packit |
e4b6da |
firstname and
|
|
Packit |
e4b6da |
"sgmltag-element">surname. Otherwise,
|
|
Packit |
e4b6da |
"sgmltag-element">othername is suppressed.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2525124">
|
|
Packit |
e4b6da |
Examples
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
$
|
|
Packit |
e4b6da |
"userinput">docbook2man --solinks manpages.xml
|
|
Packit |
e4b6da |
$
|
|
Packit |
e4b6da |
"userinput">docbook2man --solinks --encoding=utf-8//TRANSLIT manpages.xml
|
|
Packit |
e4b6da |
$
|
|
Packit |
e4b6da |
"userinput">docbook2man --string-param header-4="Free Recode 3.6" document.xml
|