problems in one or more man pages you maintain

problems in one or more man pages you maintain

[Peter Stephenson]

I meant to forward this.  I can't see any any reason not to
apply the changes to the yodl files as given.

------- Forwarded Message

Date: Tue, 9 Dec 2003 14:28:55 -0500
From: esr@thyrsus.com
Message-Id: <200312091928.hB9JStae029559@snark.thyrsus.com>
To: pws@zsh.org
Subject: problems in one or more man pages you maintain

(My apologies if you get this twice.  My first run of sends had a bug.)

This is automatically generated email about problems in a man page for which
you appear to be responsible.  If you are not the right person or list, tell
me and I will attempt to correct my database.

See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated.  Feel free to email me with any questions.

Problems with zsh.1:
1. Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).

--- zsh.1-orig	2003-11-20 13:24:46.000000000 -0500
+++ zsh.1	2003-11-20 13:25:02.000000000 -0500
@@ -2,7 +2,7 @@
 .SH "NAME"
 zsh \- the Z shell
 .\" Yodl file: Zsh/intro.yo
-.SH "SYNOPSIS"
+.SH "OVERVIEW"
 Because zsh contains many features, the zsh manual has been split into
 a number of sections:
 .PP
Problems with zshcompctl.1:
1. Command synopsis in a non-Synopsis section.  DocBook can't
handle this.

--- zshcompctl.1-orig	2003-12-03 12:09:05.000000000 -0500
+++ zshcompctl.1	2003-12-03 12:09:31.000000000 -0500
@@ -3,13 +3,6 @@
 zshcompctl \- zsh programmable completion
 .\" Yodl file: Zsh/compctl.yo
 .SH "SYNOPSIS"
-This version of zsh has two ways of performing completion of words on the
-command line\&.  New users of the shell may prefer to use the newer
-and more powerful system based on shell functions; this is described in
-\fIzshcompsys\fP(1), and the basic shell mechanisms which support it are
-described in \fIzshcompwid\fP(1)\&.  This manual entry describes the older
-\fBcompctl\fP command\&.
-.SH "DESCRIPTION"
 .PD 0
 .TP
 \fBcompctl\fP [ \fB\-CDT\fP ] \fIoptions\fP [ \fIcommand\fP \&.\&.\&. ]
@@ -22,6 +15,13 @@
 .TP
 \fBcompctl\fP \fB+\fP \fIcommand\fP \&.\&.\&.
 .PD
+.SH "DESCRIPTION"
+This version of zsh has two ways of performing completion of words on the
+command line\&.  New users of the shell may prefer to use the newer
+and more powerful system based on shell functions; this is described in
+\fIzshcompsys\fP(1), and the basic shell mechanisms which support it are
+described in \fIzshcompwid\fP(1)\&.  This manual entry describes the older
+\fBcompctl\fP command\&.
 .PP
 Control the editor's completion behavior according to the supplied set
 of \fIoptions\fP\&.  Various editing commands, notably

--
                             Eric S. Raymond

------- End of Forwarded Message