tags 368995 fixed-upstream
thanks

Hello Justin,

> There are a number of pages (7 by my count) matching
> '^\.SH .*[^A-Z0-9./"() -]; in particular, those with lowercase
> letters.  It is my understanding (though I cannot find the reference)
> that only uppercase should be used.  

Generally, I'd agree.

> Since I can't find the relevant
> note, I've also allowed some other characters for this patch.
> 
> I generated the included patch with:
> time for p in `dpkg -L manpages{,-dev} |grep -iE
> '^/usr/share/man/man([0-9])/[a-z0-9_.-]+\.\1\.gz$' |xargs zgrep -l '^\.SH 
> .*[^A-Z0-9./"() -]'`; do [
> -L $p ] && continue; b=${p##*/}; zcat $p |perl -pe 's/^\.SH
> (.*[^A-Z0-9.\/"() -])/.SH \U$1/' >$b; zdiff -u $p $b; done;
> 
> (BTW, I don't know how many EXAMPLES you've changed to EXAMPLE:

Most by now.

> for p in `dpkg -L manpages{,-dev} |grep -iE
> '^/usr/share/man/man([0-9])/[a-z0-9_.-]+\.\1\.gz$' |xargs zgrep -i '^\.SH 
> .*AMPLE' |grep -v ':\.SH
> EXAMPLE$' |cut -d: -f1`; do [ -L $p ] || echo $p; done |wc -l
> 23)

(A note in passing: Debian is *not* my default distro.  Scripts based
on dpkg are not directly usable for me.)

> --- - 2006-05-25 19:03:48.592638000 -0400
> +++ /tmp/intro2.gz.12217      2006-05-25 19:03:48.000000000 -0400
> @@ -115,7 +115,7 @@
>       return(0);
>  }
>  .fi
> -.SH "Sample Output"
> +.SH "SAMPLE OUTPUT"

Really , it should be 

    .SS "Sample Output"

And that is what I did.

>  .nf
>  code error = 0
>  uptime = 502034s
> --- - 2006-05-25 19:03:48.642974000 -0400
> +++ /tmp/epoll4.gz.12230      2006-05-25 19:03:48.000000000 -0400
> @@ -224,7 +224,7 @@
>  with
>  .BR EPOLL_CTL_MOD .
>  
> -.SH QUESTIONS AND ANSWERS (from linux-kernel)
> +.SH QUESTIONS AND ANSWERS (FROM LINUX-KERNEL)

In fact, I just removed the "(from linux-kernel)".

>  .RS
>  .TP 
> --- - 2006-05-25 19:03:48.699173000 -0400
> +++ /tmp/bootparam7.gz.12243  2006-05-25 19:03:48.000000000 -0400
> @@ -820,7 +820,7 @@
>  .LP
>  where N is the \fIpun\fP (SCSI ID) of the subsystem.
>  
> -.SH "CD-ROMs (Non-SCSI/ATAPI/IDE)"
> +.SH "CD-ROMS (NON-SCSI/ATAPI/IDE)"

I'm inclined to just leave that one unchanged.

>  .SS "The Aztech Interface"
>  
> --- - 2006-05-25 19:03:48.751070000 -0400
> +++ /tmp/charsets7.gz.12256   2006-05-25 19:03:48.000000000 -0400
> @@ -183,7 +183,7 @@
>  is the most important encoding for Linux and includes US ASCII and
>  GB 2312.  Note that EUC-CN is often called as GB, GB 2312, or CN-GB.
>  
> -.SH Big5
> +.SH BIG5

Lacking info about whether there is some significance to the
case of the name, I've left this unchanged.

>  Big5 is a popular character set in Taiwan to express traditional
>  Chinese. (Big5 is both a character set and an encoding.) It is a
>  superset of US ASCII. Non-ASCII characters are expressed in two
> --- - 2006-05-25 19:03:48.799332000 -0400
> +++ /tmp/statfs2.gz.12269     2006-05-25 19:03:48.000000000 -0400
> @@ -180,7 +180,7 @@
>  .BR statfs ()
>  was inspired by the 4.4BSD one
>  (but they do not use the same structure).
> -.SH "NOTES ON f_fsid"
> +.SH "NOTES ON F_FSID"

I fixed this by relocating as an '.SS' under 'NOTES'

>  Solaris, Irix and POSIX have a system call
>  .BR statvfs (2)
>  that returns a
> --- - 2006-05-25 19:03:48.847971000 -0400
> +++ /tmp/clock_getres3.gz.12282       2006-05-25 19:03:48.000000000 -0400
> @@ -140,7 +140,7 @@
>  .SH NOTE
>  Most systems require the program be linked with the librt
>  library to use these functions.
> -.SH NOTE for SMP systems
> +.SH NOTE FOR SMP SYSTEMS

Not one of my pages (yet).

>  The
>  .B CLOCK_PROCESS_CPUTIME_ID
>  and
> --- - 2006-05-25 19:03:48.896520000 -0400
> +++ /tmp/gethostbyname3.gz.12295      2006-05-25 19:03:48.000000000 -0400
> @@ -236,7 +236,7 @@
>  name service switch configuration
>  .SH "CONFORMING TO"
>  4.3BSD.
> -.SH "System V/POSIX EXTENSION"
> +.SH "SYSTEM V/POSIX EXTENSION"
>  POSIX requires the
>  .BR gethostent ()
>  call, that should return the next entry in the host data base.

Fixed.

Changes will be in 2.34.

Thanks.

Michael
-- 
Michael Kerrisk
maintainer of Linux man pages Sections 2, 3, 4, 5, and 7 

Want to help with man page maintenance?  
Grab the latest tarball at
ftp://ftp.win.tue.nl/pub/linux-local/manpages/, 
read the HOWTOHELP file and grep the source 
files for 'FIXME'.


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to