fam
[Top] [All Lists]

problems in one or more man pages you maintain

To: fam@xxxxxxxxxxx
Subject: problems in one or more man pages you maintain
From: esr@xxxxxxxxxxx
Date: Fri, 16 Jul 2004 20:14:43 -0400
Sender: fam-bounce@xxxxxxxxxxx
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.

Note: This patch does not change the mod date of the manual page.  You
may wish to do that by hand.

Problems with fam.3x:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

2. 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).

--- fam.3x-orig 2003-11-30 04:55:50.000000000 -0500
+++ fam.3x      2003-11-30 04:56:36.000000000 -0500
@@ -1,5 +1,5 @@
 '\"macro stdmacro
-.if n .pH g3x.fam @(#)fam      30.3 of 1/19/86
+.\" g3x.fam @(#)fam    30.3 of 1/19/86
 .nr X
 .if \nX=0 .ds x} FAM 3X "Specialized Libraries" "\&"
 .if \nX=1 .ds x} FAM 3X "Specialized Libraries"
@@ -79,8 +79,6 @@
 .SH USING FAM
 Here are the steps required to use \fIFAM \fPin an application:
 .PP
-.AL
-.LI
 .IP 1.
 Create a connection to \fIfam\fP by calling FAMOpen.  This routine
 will pass back a FAMConnection structure used in all \fIfam \fP
@@ -262,8 +260,6 @@
 .PP
 There are two ways to for applications to receive \fIFAM \fPevents:
 .PP
-.AL
-.LI
 1. The Select approach - The application selects on the file
     descriptor returned from FAMOpen, in the FAMConnection structure.
     When this file descriptor becomes active, the application calls

--
                             Eric S. Raymond

<Prev in Thread] Current Thread [Next in Thread>