AIR
/
mxml
mirror of https://github.com/michaelrsweet/mxml.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use \- instead of - in man pages (STR #68)

Browse Source
pull/193/head
Michael R Sweet 17 years ago
parent ada7da928c
commit 5f263362a9
6 changed files with 47 additions and 29 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 2
      CHANGES
  2. 9
      doc/intro.html
  3. 6
      doc/intro.man
  4. 38
      doc/mxmldoc.man
  5. 19
      doc/relnotes.html
  6. 2
      mxmldoc.c

2
CHANGES
Unescape View File

@ -3,6 +3,8 @@ CHANGES - 2008-01-12
CHANGES IN Mini-XML 2.4.1 CHANGES IN Mini-XML 2.4.1
- The man pages and man page output from mxmldoc did
not use "\-" for dashes (STR #68)
- The debug version of the Mini-XML DLL could not be - The debug version of the Mini-XML DLL could not be
built (STR #65) built (STR #65)
- Processing instructions and directives did not work - Processing instructions and directives did not work

9
doc/intro.html
Unescape View File

@ -1,7 +1,7 @@
<html> <html>
<head> <head>
<title>Mini-XML Programmers Manual, Version 2.4</title> <title>Mini-XML Programmers Manual, Version 2.4.1</title>
<meta name='copyright' content='Copyright 2003-2007'> <meta name='copyright' content='Copyright 2003-2008'>
<meta name='author' content='Michael R. Sweet'> <meta name='author' content='Michael R. Sweet'>
<meta name='keywords' content='XML, C, C++, library'> <meta name='keywords' content='XML, C, C++, library'>
</head> </head>
@ -10,7 +10,7 @@
<h1 align='right'><a name='INTRO'><img src="0.gif" align="right" <h1 align='right'><a name='INTRO'><img src="0.gif" align="right"
hspace="10" width="100" height="100" alt="0"></a>Introduction</h1> hspace="10" width="100" height="100" alt="0"></a>Introduction</h1>
<p>This programmers manual describes Mini-XML version 2.4, a small <p>This programmers manual describes Mini-XML version 2.4.1, a small
XML parsing library that you can use to read and write XML data XML parsing library that you can use to read and write XML data
files in your C and C++ applications.</p> files in your C and C++ applications.</p>
@ -53,9 +53,6 @@ following projects/software applications:</p>
<li><a href='http://www.cups.org/ddk/'>CUPS Driver <li><a href='http://www.cups.org/ddk/'>CUPS Driver
Development Kit</a></li> Development Kit</a></li>
<li><a href='http://www.easysw.com/printpro/'>ESP Print
Pro</a></li>
<li><a <li><a
href='http://zynaddsubfx.sourceforge.net'>ZynAddSubFX</a></li> href='http://zynaddsubfx.sourceforge.net'>ZynAddSubFX</a></li>

6
doc/intro.man
Unescape View File

@ -1,7 +1,7 @@
.SH INCLUDE FILE .SH INCLUDE FILE
#include <mxml.h> #include <mxml.h>
.SH LIBRARY .SH LIBRARY
-lmxml \-lmxml
.SH DESCRIPTION .SH DESCRIPTION
Mini-XML is a small XML parsing library that you can use to Mini-XML is a small XML parsing library that you can use to
read XML and XML-like data files in your application without read XML and XML-like data files in your application without
@ -149,6 +149,6 @@ is used for a particular node or the entire tree:
mxmlDelete(tree); mxmlDelete(tree);
.fi .fi
.SH SEE ALSO .SH SEE ALSO
mxmldoc(1), Mini-XML Programmers Manual, http://www.easysw.com/~mike/mxml/ mxmldoc(1), Mini-XML Programmers Manual, http://www.minixml.org/
.SH COPYRIGHT .SH COPYRIGHT
Copyright 2003-2007 by Michael Sweet. Copyright 2003-2008 by Michael Sweet.

38
doc/mxmldoc.man
Unescape View File

@ -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$".
.\" .\"

19
doc/relnotes.html
Unescape View File

@ -5,6 +5,25 @@
hspace="10" width="100" height="100" alt="B"></a>Release Notes</h1> hspace="10" width="100" height="100" alt="B"></a>Release Notes</h1>
<h2 _hd_omit_toc>Changes in Mini-XML 2.4.1</h2>
<ul>
<li>The man pages and man page output from mxmldoc did
not use "\-" for dashes (STR #68)</li>
<li>The debug version of the Mini-XML DLL could not be
built (STR #65)</li>
<li>Processing instructions and directives did not work
when not at the top level of a document (STR #67)</li>
<li>Spaces around the "=" in attributes were not supported
(STR #67)</li>
</ul>
<h2 _hd_omit_toc>Changes in Mini-XML 2.4</h2> <h2 _hd_omit_toc>Changes in Mini-XML 2.4</h2>
<ul> <ul>

2
mxmldoc.c
Unescape View File

@ -3882,7 +3882,7 @@ write_string(const char *s, /* I - String to write */
case OUTPUT_MAN : case OUTPUT_MAN :
while (*s) while (*s)
{ {
if (*s == '\\') if (*s == '\\' || *s == '-')
putchar('\\'); putchar('\\');
putchar(*s++); putchar(*s++);

Write Preview
Loading…
Cancel
Save