mxmldoc(1)
NAME
mxmldoc - mini-xml documentation generator
SYNOPSIS
mxmldoc --no-output [ filename.xml ] source file(s) ] mxmldoc [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ filename.xml ] [ source file(s) ] > filename.html mxmldoc --docset directory.docset [ --docversion version ] [ --feedname name ] [ --feedurl url ] [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ filename.xml ] [ source file(s) ] mxmldoc --tokens path [ filename.xml ] [ source file(s) ] > tokens.xml mxmldoc --framed basename [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ filename.xml ] [ source file(s) ] mxmldoc [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] --man manpage [ --section section ] [ --title title ] [ filename.xml ] [ source file(s) ] > filename.man
DESCRIPTION
mxmldoc 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 --no-output option to disable the HTML output. Man page source can be generated using the --man option. If no source files are specified then the current XML file is converted to the standard output. In general, any C or C++ source code is handled by mxmldoc, 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/documentation.php".
OPTIONS
--docset directory.docset
Creates an Xcode documentation set in the specified directory.
--docversion version
Specifies the version number for the Xcode documentation set.
--feedname name
Specifies the Xcode documentation set feed name, typically the
project or company name.
--feedurl url
Specifies the Xcode documentation set feed URL which must point to
an ATOM file linking to updates.
--footer footerfile
Inserts the specified file at the bottom of the output
documentation.
--framed basename
Creates HTML documentation using frames - one for the table-of-
contents and one for the body.
--header headerfile
Inserts the specified file at the top of the output documentation.
--intro introfile
Inserts the specified file before the table of contents.
--man manpage
Generated a man page instead of HTML documentation.
--no-output
Disables generation of documentation on the standard output.
--section section
Sets the section/keywords in the output documentation.
--title title
Sets the title of the output documentation.
--tokens
Generates a Tokens.xml file for use with the Xcode documentation
tools.
SEE ALSO
mxml(3), Mini-XML Programmers Manual, http://www.minixml.org/
COPYRIGHT
Copyright 2003-2009 by Michael Sweet.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
