You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
248 lines
4.7 KiB
248 lines
4.7 KiB
.\"
|
|
.\" mxmldoc man page for mini-XML, a small XML-like file parsing library.
|
|
.\"
|
|
.\" Copyright 2003-2017 by Michael R Sweet.
|
|
.\"
|
|
.\" These coded instructions, statements, and computer programs are the
|
|
.\" property of Michael R Sweet and are protected by Federal copyright
|
|
.\" law. Distribution and use rights are outlined in the file "COPYING"
|
|
.\" which should have been included with this file. If this file is
|
|
.\" missing or damaged, see the license at:
|
|
.\"
|
|
.\" https://michaelrsweet.github.io/mxml
|
|
.\"
|
|
.TH mxmldoc 1 "Mini-XML" "6 April 2017" "Michael Sweet"
|
|
.SH NAME
|
|
mxmldoc \- mini-xml documentation generator
|
|
.SH SYNOPSIS
|
|
.B mxmldoc
|
|
\-\-no-output [
|
|
.I filename.xml
|
|
]
|
|
.I source file(s)
|
|
]
|
|
.br
|
|
.B mxmldoc
|
|
[ \-\-author
|
|
.I author
|
|
] [ \-\-copyright
|
|
.I copyright
|
|
] [ \-\-footer
|
|
.I footerfile
|
|
] [ \-\-header
|
|
.I headerfile
|
|
] [ \-\-intro
|
|
.I introfile
|
|
] [ \-\-section
|
|
.I section
|
|
] [ \-\-title
|
|
.I title
|
|
] [
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
] >
|
|
.I filename.html
|
|
.br
|
|
.B mxmldoc
|
|
\-\-docset
|
|
.I directory.docset
|
|
[ \-\-author
|
|
.I author
|
|
] [ \-\-copyright
|
|
.I copyright
|
|
] [ \-\-docversion
|
|
.I version
|
|
] [ \-\-feedname
|
|
.I name
|
|
] [ \-\-feedurl
|
|
.I url
|
|
] [ \-\-footer
|
|
.I footerfile
|
|
] [ \-\-header
|
|
.I headerfile
|
|
] [ \-\-intro
|
|
.I introfile
|
|
] [ \-\-section
|
|
.I section
|
|
] [ \-\-title
|
|
.I title
|
|
] [
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
]
|
|
.br
|
|
.B mxmldoc
|
|
\-\-tokens
|
|
.I path
|
|
[
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
] > tokens.xml
|
|
.br
|
|
.B mxmldoc
|
|
\-\-framed
|
|
.I basename
|
|
[ \-\-author
|
|
.I author
|
|
] [ \-\-copyright
|
|
.I copyright
|
|
] [ \-\-footer
|
|
.I footerfile
|
|
] [ \-\-header
|
|
.I headerfile
|
|
] [ \-\-intro
|
|
.I introfile
|
|
] [ \-\-section
|
|
.I section
|
|
] [ \-\-title
|
|
.I title
|
|
] [
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
]
|
|
.br
|
|
.B mxmldoc
|
|
[ \-\-author
|
|
.I author
|
|
] [ \-\-copyright
|
|
.I copyright
|
|
] [ \-\-footer
|
|
.I footerfile
|
|
] [ \-\-header
|
|
.I headerfile
|
|
] [ \-\-intro
|
|
.I introfile
|
|
] \-\-man
|
|
.I manpage
|
|
[ \-\-section
|
|
.I section
|
|
] [ \-\-title
|
|
.I title
|
|
] [
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
] >
|
|
.I filename.man
|
|
.br
|
|
.B mxmldoc
|
|
\-\-epub
|
|
.I filename.epub
|
|
[ \-\-author
|
|
.I author
|
|
] [ \-\-copyright
|
|
.I copyright
|
|
] [ \-\-docversion
|
|
.I version
|
|
] [ \-\-feedname
|
|
.I name
|
|
] [ \-\-feedurl
|
|
.I url
|
|
] [ \-\-footer
|
|
.I footerfile
|
|
] [ \-\-header
|
|
.I headerfile
|
|
] [ \-\-intro
|
|
.I introfile
|
|
] [ \-\-section
|
|
.I section
|
|
] [ \-\-title
|
|
.I title
|
|
] [
|
|
.I filename.xml
|
|
] [
|
|
.I source file(s)
|
|
]
|
|
.SH DESCRIPTION
|
|
\fImxmldoc\fR scans the specified C and C++ source files to produce
|
|
an XML representation of globally accessible classes, constants,
|
|
enumerations, functions, structures, typedefs, unions, and variables
|
|
- the XML file is updated as necessary. By default, a HTML
|
|
representation of the XML file is written to the standard output.
|
|
Use the \fI\-\-no-output\fR option to disable the HTML output.
|
|
.PP
|
|
Man page source can be generated using the \fI\-\-man\fR option.
|
|
.PP
|
|
If no source files are specified then the current XML file is
|
|
converted to the standard output.
|
|
.PP
|
|
In general, any C or C++ source code is handled by \fImxmldoc\fR,
|
|
however it was specifically written to handle code with
|
|
documentation that is formatted according to the CUPS Developer
|
|
Guide which is available at "http://www.cups.org/doc/spec-cmp.html".
|
|
.SH OPTIONS
|
|
.TP 5
|
|
\-\-author "author name"
|
|
.br
|
|
Specifies the name of the documentation author.
|
|
.TP 5
|
|
\-\-copyright "copyright text"
|
|
.br
|
|
Specifies the copyright text to use.
|
|
.TP 5
|
|
\-\-docset directory.docset
|
|
.br
|
|
Creates an Xcode documentation set in the specified directory.
|
|
.TP 5
|
|
\-\-docversion version
|
|
.br
|
|
Specifies the version number for the Xcode documentation set.
|
|
.TP 5
|
|
\-\-epub filename.epub
|
|
.br
|
|
Creates an EPUB book with the specified filename.
|
|
.TP 5
|
|
\-\-feedname name
|
|
.br
|
|
Specifies the Xcode documentation set feed name, typically the project or
|
|
company name.
|
|
.TP 5
|
|
\-\-feedurl url
|
|
.br
|
|
Specifies the Xcode documentation set feed URL which must point to an ATOM file
|
|
linking to updates.
|
|
.TP 5
|
|
\-\-footer footerfile
|
|
.br
|
|
Inserts the specified file at the bottom of the output documentation.
|
|
.TP 5
|
|
\-\-framed basename
|
|
.br
|
|
Creates HTML documentation using frames - one for the table-of-contents and
|
|
one for the body.
|
|
.TP 5
|
|
\-\-header headerfile
|
|
.br
|
|
Inserts the specified file at the top of the output documentation.
|
|
.TP 5
|
|
\-\-intro introfile
|
|
.br
|
|
Inserts the specified file before the table of contents.
|
|
.TP 5
|
|
\-\-man manpage
|
|
.br
|
|
Generated a man page instead of HTML documentation.
|
|
.TP 5
|
|
\-\-no-output
|
|
.br
|
|
Disables generation of documentation on the standard output.
|
|
.TP 5
|
|
\-\-section section
|
|
.br
|
|
Sets the section/keywords in the output documentation.
|
|
.TP 5
|
|
\-\-title title
|
|
.br
|
|
Sets the title of the output documentation.
|
|
.TP 5
|
|
\-\-tokens
|
|
.br
|
|
Generates a Tokens.xml file for use with the Xcode documentation tools.
|
|
.SH SEE ALSO
|
|
mxml(3), Mini-XML Programmers Manual, https://michaelrsweet.github.io/mxml
|
|
.SH COPYRIGHT
|
|
Copyright \[co] 2003-2017 by Michael R Sweet.
|
|
|