develooper Front page | perl.documentation | Postings from December 2003

problems in one or more man pages you maintain

Thread Previous | Thread Next
From:
esr
Date:
December 9, 2003 11:39
Subject:
problems in one or more man pages you maintain
Message ID:
200312091931.hB9JVQae030010@snark.thyrsus.com
(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 DynaLoader.3pm:
1. There are multiple name lines.  This makes it impossible to translate
the page to DocBook.  It may also confuse some implementations
of man -k.

--- DynaLoader.3pm-orig	2003-12-04 04:42:22.000000000 -0500
+++ DynaLoader.3pm	2003-12-04 04:43:13.000000000 -0500
@@ -131,9 +131,7 @@
 .IX Title "DynaLoader 3pm"
 .TH DynaLoader 3pm "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
 .SH "NAME"
-DynaLoader \- Dynamically load C libraries into Perl code
-.PP
-dl_error(), dl_findfile(), dl_expandspec(), dl_load_file(), dl_unload_file(), dl_find_symbol(), dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), dl_load_flags(), bootstrap() \- routines used by DynaLoader modules
+dl_error(), dl_findfile(), dl_expandspec(), dl_load_file(), dl_unload_file(), dl_find_symbol(), dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), dl_load_flags(), bootstrap() \- dynamically load C libraries into Perl code
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 4
Problems with Getopt::Std.3pm:
1. There are multiple name lines.  This makes it impossible to translate
the page to DocBook.  It may also confuse some implementations
of man -k.

--- Getopt::Std.3pm-orig	2003-12-02 02:42:17.000000000 -0500
+++ Getopt::Std.3pm	2003-12-02 02:42:40.000000000 -0500
@@ -131,9 +131,7 @@
 .IX Title "Getopt::Std 3pm"
 .TH Getopt::Std 3pm "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
 .SH "NAME"
-getopt \- Process single\-character switches with switch clustering
-.PP
-getopts \- Process single\-character switches with switch clustering
+getopt, getopts \- Process single\-character switches with switch clustering
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
Problems with perlce.1:
1. Missing or garbled name section.  The most common form of garbling
is a missing - or extra -. Or your manual page may have been generated
by a tool that doesn't emit a NAME section as it should.  These
problems make it impossible to lift the page to DocBook.  They
can also confuse some implementations of man -k.

--- perlce.1	2003-02-16 19:38:54.000000000 -0500
+++ perlce.1	2003-02-16 19:39:19.000000000 -0500
@@ -132,7 +132,7 @@
 .TH PERLCE 1 "2002-06-08" "perl v5.8.0" "Perl Programmers Reference Guide"
 .SH "Name"
 .IX Header "Name"
-Perl for WinCE
+perlce \- Perl for WinCE
 .SH "Description"
 .IX Header "Description"
 This file gives the instructions for building Perl5.6 and above for

--
                             Eric S. Raymond

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About