bug-gnu-utils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Markup error in the addr2line.1 man page


From: Eric S. Raymond
Subject: Markup error in the addr2line.1 man page
Date: Sun, 21 Jul 2002 15:17:12 -0400

I'm working on a program that automatically translates manual page sources
to DocBook markup.  You can find out more about this program at 

        http://www.tuxedo.org/~esr/doclifter/

If you are not already considering it, please think about moving your
documentation masters to DocBook (or some format from which you can
generate DocBook).  Tools to generate man pages (docbook2man) HTML
(docbook2html) and PostScript (docbook2ps) from DocBook files are
open source and generally available.  My program, doclifter, should
make moving your masters to DocBook a pretty painless process.

Many major open source projects (including the Linux Documentation
Project, GNOME, KDE, and FreeBSD) have moved to DocBook or are in the
process of doing so.  The format has many advantages over man, info,
texinfo, or HTML; by moving everybody to it, we should be able to
support unified browsing of all system documentation with Web-like 
hypertext capabilities, automatic indexing, and rich search facilities.

In the process of debugging doclifter, I have discovered many bugs in 
man page layout.  These are significant because they make automated
translation to DocBook more difficult, and often confuse other document-
mining tools (such as indexers).

I have found some markup bugs on a manual page you maintain.
Please fix these in your next release.

There's an unclosed [] group in the synopsis.

This should be fixed up in the POD source for the man page, which I 
don't have.

--- addr2line.1 2002/07/21 19:09:39     1.1
+++ addr2line.1 2002/07/21 19:13:25
@@ -144,7 +144,7 @@
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 addr2line [\fB\-b\fR \fIbfdname\fR|\fB\*(--target=\fR\fIbfdname\fR]
-          [\fB\-C\fR|\fB\*(--demangle\fR[=\fIstyle\fR]
+          [\fB\-C\fR|\fB\*(--demangle\fR[=\fIstyle\fR]]
           [\fB\-e\fR \fIfilename\fR|\fB\*(--exe=\fR\fIfilename\fR]
           [\fB\-f\fR|\fB\*(--functions\fR] [\fB\-s\fR|\fB\*(--basename\fR]
           [\fB\-H\fR|\fB\*(--help\fR] [\fB\-V\fR|\fB\*(--version\fR]

-- 
                <a href="http://www.tuxedo.org/~esr/";>Eric S. Raymond</a>

Rifles, muskets, long-bows and hand-grenades are inherently democratic
weapons.  A complex weapon makes the strong stronger, while a simple
weapon -- so long as there is no answer to it -- gives claws to the
weak.
        -- George Orwell, "You and the Atom Bomb", 1945



reply via email to

[Prev in Thread] Current Thread [Next in Thread]