|
|
@ -3,7 +3,7 @@ |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.\" mxmldoc man page for mini-XML, a small XML-like file parsing library. |
|
|
|
.\" mxmldoc man page for mini-XML, a small XML-like file parsing library. |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.\" Copyright 2003-2007 by Michael Sweet. |
|
|
|
.\" Copyright 2003-2008 by Michael Sweet. |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.\" This program is free software; you can redistribute it and/or |
|
|
|
.\" This program is free software; you can redistribute it and/or |
|
|
|
.\" modify it under the terms of the GNU Library General Public |
|
|
|
.\" modify it under the terms of the GNU Library General Public |
|
|
@ -15,23 +15,23 @@ |
|
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
|
.\" GNU General Public License for more details. |
|
|
|
.\" GNU General Public License for more details. |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.TH mxmldoc 1 "Mini-XML" "22 April 2007" "Michael Sweet" |
|
|
|
.TH mxmldoc 1 "Mini-XML" "12 January 2008" "Michael Sweet" |
|
|
|
.SH NAME |
|
|
|
.SH NAME |
|
|
|
mxmldoc \- mini-xml documentation generator |
|
|
|
mxmldoc \- mini-xml documentation generator |
|
|
|
.SH SYNOPSIS |
|
|
|
.SH SYNOPSIS |
|
|
|
.B mxmldoc |
|
|
|
.B mxmldoc |
|
|
|
--no-output [ |
|
|
|
\-\-no-output [ |
|
|
|
.I filename.xml |
|
|
|
.I filename.xml |
|
|
|
] |
|
|
|
] |
|
|
|
.I source file(s) |
|
|
|
.I source file(s) |
|
|
|
] |
|
|
|
] |
|
|
|
.br |
|
|
|
.br |
|
|
|
.B mxmldoc |
|
|
|
.B mxmldoc |
|
|
|
[ --intro |
|
|
|
[ \-\-intro |
|
|
|
.I introfile |
|
|
|
.I introfile |
|
|
|
] [ --section |
|
|
|
] [ \-\-section |
|
|
|
.I section |
|
|
|
.I section |
|
|
|
] [ --title |
|
|
|
] [ \-\-title |
|
|
|
.I title |
|
|
|
.I title |
|
|
|
] [ |
|
|
|
] [ |
|
|
|
.I filename.xml |
|
|
|
.I filename.xml |
|
|
@ -41,13 +41,13 @@ mxmldoc \- mini-xml documentation generator |
|
|
|
.I filename.html |
|
|
|
.I filename.html |
|
|
|
.br |
|
|
|
.br |
|
|
|
.B mxmldoc |
|
|
|
.B mxmldoc |
|
|
|
--man |
|
|
|
\-\-man |
|
|
|
.I manpage |
|
|
|
.I manpage |
|
|
|
[ --intro |
|
|
|
[ \-\-intro |
|
|
|
.I introfile |
|
|
|
.I introfile |
|
|
|
] [ --section |
|
|
|
] [ \-\-section |
|
|
|
.I section |
|
|
|
.I section |
|
|
|
] [ --title |
|
|
|
] [ \-\-title |
|
|
|
.I title |
|
|
|
.I title |
|
|
|
] [ |
|
|
|
] [ |
|
|
|
.I filename.xml |
|
|
|
.I filename.xml |
|
|
@ -61,9 +61,9 @@ an XML representation of globally accessible classes, constants, |
|
|
|
enumerations, functions, structures, typedefs, unions, and variables |
|
|
|
enumerations, functions, structures, typedefs, unions, and variables |
|
|
|
- the XML file is updated as necessary. By default, a HTML |
|
|
|
- the XML file is updated as necessary. By default, a HTML |
|
|
|
representation of the XML file is written to the standard output. |
|
|
|
representation of the XML file is written to the standard output. |
|
|
|
Use the \fI--no-output\fR option to disable the HTML output. |
|
|
|
Use the \fI\-\-no-output\fR option to disable the HTML output. |
|
|
|
.PP |
|
|
|
.PP |
|
|
|
Man page source can be generated using the \fI--man\fR option. |
|
|
|
Man page source can be generated using the \fI\-\-man\fR option. |
|
|
|
.PP |
|
|
|
.PP |
|
|
|
If no source files are specified then the current XML file is |
|
|
|
If no source files are specified then the current XML file is |
|
|
|
converted to the standard output. |
|
|
|
converted to the standard output. |
|
|
@ -74,29 +74,29 @@ documentation that is formatted according to the CUPS Developer |
|
|
|
Guide which is available at "http://www.cups.org/documentation.php". |
|
|
|
Guide which is available at "http://www.cups.org/documentation.php". |
|
|
|
.SH OPTIONS |
|
|
|
.SH OPTIONS |
|
|
|
.TP 5 |
|
|
|
.TP 5 |
|
|
|
\--intro introfile |
|
|
|
\-\-intro introfile |
|
|
|
.br |
|
|
|
.br |
|
|
|
Inserts the specified file at the top of the output documentation. |
|
|
|
Inserts the specified file at the top of the output documentation. |
|
|
|
.TP 5 |
|
|
|
.TP 5 |
|
|
|
\--man manpage |
|
|
|
\-\-man manpage |
|
|
|
.br |
|
|
|
.br |
|
|
|
Generated a man page instead of HTML documentation. |
|
|
|
Generated a man page instead of HTML documentation. |
|
|
|
.TP 5 |
|
|
|
.TP 5 |
|
|
|
\--no-output |
|
|
|
\-\-no-output |
|
|
|
.br |
|
|
|
.br |
|
|
|
Disables generation of documentation on the standard output. |
|
|
|
Disables generation of documentation on the standard output. |
|
|
|
.TP 5 |
|
|
|
.TP 5 |
|
|
|
\--section section |
|
|
|
\-\-section section |
|
|
|
.br |
|
|
|
.br |
|
|
|
Sets the section/keywords in the output documentation. |
|
|
|
Sets the section/keywords in the output documentation. |
|
|
|
.TP 5 |
|
|
|
.TP 5 |
|
|
|
\--title title |
|
|
|
\-\-title title |
|
|
|
.br |
|
|
|
.br |
|
|
|
Sets the title of the output documentation. |
|
|
|
Sets the title of the output documentation. |
|
|
|
.SH SEE ALSO |
|
|
|
.SH SEE ALSO |
|
|
|
mxml(3), Mini-XML Programmers Manual, http://www.easysw.com/~mike/mxml/ |
|
|
|
mxml(3), Mini-XML Programmers Manual, http://www.minixml.org/ |
|
|
|
.SH COPYRIGHT |
|
|
|
.SH COPYRIGHT |
|
|
|
Copyright 2003-2007 by Michael Sweet. |
|
|
|
Copyright 2003-2008 by Michael Sweet. |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.\" End of "$Id$". |
|
|
|
.\" End of "$Id$". |
|
|
|
.\" |
|
|
|
.\" |
|
|
|