[prev in list] [next in list] [prev in thread] [next in thread] 

List:       freedesktop-xorg
Subject:    doclifter cleanup of manual pages
From:       "Eric S. Raymond" <esr () thyrsus ! com>
Date:       2013-06-19 12:21:44
Message-ID: 20130619122144.GA15253 () thyrsus ! com
[Download RAW message or body]

With a couple of patches I just pushed to the public repos, and the
enclosed patch that needs to go to Keith Packard's xserver tree, the
X manual pages are now completely doclifter-clean and can all be lifted
to XML-DocBook without errors or warnings.

Some of the lifts could use improvement. In particular

(1) There might still be ad-hoc tables in various places that won't
    turn into HTML tables; these need to be found and wrapped in TBL
    markup, so doclifter can turn them into DocBook tables, so the
    HTML will be right.

(2) Not all C prototypes that should be are recognized and turned into
    DocBook prototype markup. Some are lifted as plain running text.

I have fairly reliable ways to find ad-hoc tables; I will apply them
and fix up the remaining ones.  C prototypes that won't parse aren't
so easy, alas; that will take many eyeballs looking at the lifted
DocBook synopses..
-- 
		<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>

["0001-Fix-three-broken-escape-sequences.patch" (text/x-diff)]

From 54c0b9a2124345e9c698dcfb69fc787863e6ed10 Mon Sep 17 00:00:00 2001
From: "Eric S. Raymond" <esr@thyrsus.com>
Date: Wed, 19 Jun 2013 08:03:50 -0400
Subject: [PATCH] Fix three broken escape sequences.

---
 hw/xwin/man/XWin.man   | 2 +-
 hw/xwin/man/XWinrc.man | 2 +-
 man/Xserver.man        | 3 +--
 3 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/hw/xwin/man/XWin.man b/hw/xwin/man/XWin.man
index 18ee667..f8b4d49 100644
--- a/hw/xwin/man/XWin.man
+++ b/hw/xwin/man/XWin.man
@@ -312,7 +312,7 @@ exit silently and don't display any error message.
 .TP 8
 .B "\-xkbrules \fIrule\fP"
 .TP 8
-.B "\-xkbvariant \fIvariant\fp"
+.B "\-xkbvariant \fIvariant\fP"
 These options configure the xkeyboard extension to load
 a particular keyboard map as the X server starts.  The behavior is similar
 to the \fIsetxkbmap\fP(1) program.
diff --git a/hw/xwin/man/XWinrc.man b/hw/xwin/man/XWinrc.man
index 71d8dad..01a1e02 100644
--- a/hw/xwin/man/XWinrc.man
+++ b/hw/xwin/man/XWinrc.man
@@ -149,7 +149,7 @@ When specifying an \fIicon-file\fP in the following commands several different f
 \t \t (",101" is the 1st icon inside \fIXWin.EXE\fP)
 .TP 8
 .B ICONDIRECTORY \fIWindows-path-to-icon-directory\fP
-Defines the default directory to search for \ficon-file\fP files.
+Defines the default directory to search for \fIicon-file\fP files.
 It should be a \fIWindows\fP style path (e.g. C:\\cygwin\\usr\\local\\icons).
 .TP 8
 .B DEFAULTICON \fIicon-file\fP
diff --git a/man/Xserver.man b/man/Xserver.man
index b103551..e352316 100644
--- a/man/Xserver.man
+++ b/man/Xserver.man
@@ -25,7 +25,6 @@
 .\" from The Open Group.
 .\" $XFree86: xc/programs/Xserver/Xserver.man,v 3.31 2004/01/10 22:27:46 dawes Exp $
 .\" shorthand for double quote that works everywhere.
-.ds q \N'34'
 .TH XSERVER 1 __xorgversion__
 .SH NAME
 Xserver \- X Window System display server
@@ -386,7 +385,7 @@ data (not that it is very private, being on the command line!).
 Yet another XDMCP specific value, this one allows the display manager to
 identify each display so that it can locate the shared key.
 .SH XKEYBOARD OPTIONS
-X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
+X servers that support the XKEYBOARD (a.k.a. XKB) extension accept the
 following options.  All layout files specified on the command line must be
 located in the XKB base directory or a subdirectory, and specified as the
 relative path from the XKB base directory.  The default XKB base directory is
-- 
1.8.0.1.g2b06c9a



_______________________________________________
xorg@lists.x.org: X.Org support
Archives: http://lists.freedesktop.org/archives/xorg
Info: http://lists.x.org/mailman/listinfo/xorg
Your subscription address: freedesktop-xorg@progressive-comp.com

[prev in list] [next in list] [prev in thread] [next in thread]