1db2x_manxml(1)                     docbook2X                    db2x_manxml(1)
2
3
4

NAME

6       db2x_manxml - Make man pages from Man-XML
7

SYNOPSIS

9       db2x_manxml [options] [xml-document]
10

DESCRIPTION

12       db2x_manxml  converts  a  Man-XML  document into one or more man pages.
13       They are written in the current directory.
14
15       If xml-document is not given, then the document to convert is read from
16       standard input.
17

OPTIONS

19       --encoding=encoding
20              Select  the  character  encoding used for the output files.  The
21              available encodings are those of iconv(1).  The default encoding
22              is us-ascii.
23
24              The XML source may contain characters that are not representable
25              in the encoding that you select; in this case the  program  will
26              bomb out during processing, and you should choose another encod‐
27              ing.  (This is guaranteed not to happen with any Unicode  encod‐
28              ing  such  as  UTF-8,  but unfortunately not everyone is able to
29              process Unicode texts.)
30
31              If you are using  GNU’s  version  of  iconv(1),  you  can  affix
32              //TRANSLIT  to the end of the encoding name to attempt translit‐
33              erations of any unconvertible characters in the output.  Beware,
34              however, that the really inconvertible characters will be turned
35              into another of those damned question marks. (Aren’t you sick of
36              this?)
37
38              The suffix //TRANSLIT applied to a Unicode encoding — in partic‐
39              ular, utf-8//TRANSLIT — means that the output files are  to  re‐
40              main  in  Unicode, but markup-level character translations using
41              utf8trans are still to be done. So in most  cases,  an  English-
42              language  document,  converted  using --encoding=utf-8//TRANSLIT
43              will actually end up as a US-ASCII document, but any untranslat‐
44              able characters will remain as UTF-8 without any warning whatso‐
45              ever.  (Note: strictly speaking this is not  “transliteration”.)
46              This  method  of conversion is a compromise over strict --encod‐
47              ing=us-ascii processing,  which  aborts  if  any  untranslatable
48              characters are encountered.
49
50              Note that man pages and Texinfo documents in non-ASCII encodings
51              (including UTF-8) may not be portable to older (non-internation‐
52              alized)  systems, which is why the default value for this option
53              is us-ascii.
54
55              To suppress any automatic character mapping or encoding  conver‐
56              sion whatsoever, pass the option --encoding=utf-8.
57
58       --list-files
59              Write  a list of all the output files to standard output, in ad‐
60              dition to normal processing.
61
62       --output-dir=dir
63              Specify the directory where the output files  are  placed.   The
64              default is the current working directory.
65
66              This  option  is ignored if the output is to be written to stan‐
67              dard output (triggered by the option --to-stdout).
68
69       --to-stdout
70              Write the output to standard output  instead  of  to  individual
71              files.
72
73              If this option is used even when there are supposed to be multi‐
74              ple output documents, then everything is concatenated  to  stan‐
75              dard  output.   But beware that most other programs will not ac‐
76              cept this concatenated output.
77
78              This option is incompatible with --list-files, obviously.
79
80       --help Show brief usage information and exit.
81
82       --version
83              Show version and exit.
84
85       Some man pages may be referenced under two or more  names,  instead  of
86       just one. For example, strcpy(3) and strncpy(3) often point to the same
87       man page which describes the two functions together.  Choose one of the
88       following options to select how such man pages are to be generated:
89
90       --symlinks
91              For  each  of all the alternate names for a man page, erect sym‐
92              bolic links to the file that contains the real man page content.
93
94       --solinks
95              Generate stub pages (using .so roff requests) for the  alternate
96              names, pointing them to the real man page content.
97
98       --no-links
99              Do  not  make any alternative names available.  The man page can
100              only be referenced under its principal name.
101
102       This program uses certain other programs for its  operation.   If  they
103       are  not  in  their default installed locations, then use the following
104       options to set their location:
105
106       --utf8trans-program=path, --utf8trans-map=charmap
107              Use the character map charmap with the utf8trans(1) program, in‐
108              cluded with docbook2X, found under path.
109
110       --iconv-program=path
111              The  location of the iconv(1) program, used for encoding conver‐
112              sions.
113

NOTES

115       The man pages produced should be compatible with most troff implementa‐
116       tions  and other tools that process man pages.  Some backwards-compati‐
117       ble groff(1) extensions are used to make the output look nicer.
118

AUTHOR

120       Steve Cheng <stevecheng@users.sourceforge.net>.
121

SEE ALSO

123       The docbook2X manual (in Texinfo or HTML format) fully describes how to
124       convert DocBook to man pages and Texinfo.
125
126       Up-to-date information about this program can be found at the docbook2X
127       Web site ⟨http://docbook2x.sourceforge.net/⟩ .
128
129       The input  to  db2x_manxml  is  defined  by  the  XML  DTD  present  at
130       dtd/Man-XML in the docbook2X distribution.
131
132
133
134docbook2X 0.8.7                  18 April 2006                  db2x_manxml(1)
Impressum