Subject: various man(1) related fixes
To: None <netbsd-bugs@sun-lamp.cs.berkeley.edu>
From: Luke Mewburn <lm@rmit.edu.au>
List: netbsd-bugs
Date: 03/19/1994 16:19:59
(Sorry 'bout the non send-pr format - my netbsd machine isn't
net.connected and I'm too lazy to setup things to get around this)
I decided to go through and clean up the manual pages/whatis
information. I made changes to the following files:
makewhatis support for gzipped (.gz) files
makewhatis.sed handle names with `.', `+', and `-' in them
The latter fixes the whatis.db entries for files like send-pr, g++,
and config.new.
The following manuals were getting put in the wrong directory due to
Makefile problems:
amq, atrun, mtree, renice, showmount
The following man pages had typos:
quot, tcpdump, vmstat, monop, tcsetpgrp, ld
The man page for bcd/ppt/morse had to be broken up into three manuals
because makewhatis.sed doesn't handle multiple items under `NAME',
and no other manual pages in /usr/share/man (that I could find) were
also done like this.
I also added a pointer to /usr/local/man/whatis.db to /etc/man.conf.
Finally, Marc Boschma was telling me about some hacks he made to
<bsd.man.mk> that gzip a man page (or link as .0.gz). I like this
concept, but we're going to rewrite that method so that it detects
an environ var called MAN_COMPRESS or something like that. Sound ok?
I've also written a program called `fixman' which compresses an entire
man tree, maintaining sym & hard links. Anyone want it?
Luke.
--
*** ./usr.sbin/mtree/Makefile.ORIG Sat Mar 19 14:53:11 1994
--- ./usr.sbin/mtree/Makefile Sat Mar 19 14:53:19 1994
***************
*** 3,8 ****
--- 3,9 ----
PROG= mtree
#CFLAGS+=-DDEBUG
+ MAN8= mtree.0
SRCS= compare.c crc.c create.c misc.c mtree.c spec.c verify.c
.PATH: ${.CURDIR}/../../usr.bin/cksum
*** ./usr.sbin/tcpdump/tcpdump.8.ORIG Sat Mar 19 13:45:52 1994
--- ./usr.sbin/tcpdump/tcpdump.8 Sat Mar 19 13:46:00 1994
***************
*** 21,27 ****
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\" $Id: tcpdump.8,v 1.1 1993/11/14 21:21:06 deraadt Exp $
.\"
! .TH TCPDUMP 1 "4 Jan 1992"
.SH NAME
tcpdump \- dump traffic on a network
.SH SYNOPSIS
--- 21,27 ----
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\" $Id: tcpdump.8,v 1.1 1993/11/14 21:21:06 deraadt Exp $
.\"
! .TH TCPDUMP 8 "4 Jan 1992"
.SH NAME
tcpdump \- dump traffic on a network
.SH SYNOPSIS
*** ./usr.sbin/amd/amq/Makefile.ORIG Sat Mar 19 14:50:14 1994
--- ./usr.sbin/amd/amq/Makefile Sat Mar 19 14:50:21 1994
***************
*** 2,7 ****
--- 2,8 ----
PROG = amq
SRCS = amq.c amq_clnt.c misc_rpc.c
+ MAN8 = amq.0
CFLAGS+=-I${.CURDIR}/../config
CFLAGS+=-I${.CURDIR}/../include
CFLAGS+=-DARCH_REP=\"${MACHINE}\"
*** ./usr.sbin/quot/quot.8.ORIG Sat Mar 19 13:44:21 1994
--- ./usr.sbin/quot/quot.8 Sat Mar 19 13:44:32 1994
***************
*** 30,36 ****
.\" $Id: quot.8,v 1.2 1994/02/11 00:23:39 cgd Exp $
.\"
.Dd February 8, 1994
! .Dt QUOT 1
.Os BSD 4
.Sh NAME
.Nm quot
--- 30,36 ----
.\" $Id: quot.8,v 1.2 1994/02/11 00:23:39 cgd Exp $
.\"
.Dd February 8, 1994
! .Dt QUOT 8
.Os BSD 4
.Sh NAME
.Nm quot
*** ./games/ppt/ppt.6.ORIG Sat Mar 19 14:22:37 1994
--- ./games/ppt/ppt.6 Sat Mar 19 14:25:47 1994
***************
*** 0 ****
--- 1,47 ----
+ .\" Copyright (c) 1988 Regents of the University of California.
+ .\" All rights reserved.
+ .\"
+ .\" Redistribution and use in source and binary forms, with or without
+ .\" modification, are permitted provided that the following conditions
+ .\" are met:
+ .\" 1. Redistributions of source code must retain the above copyright
+ .\" notice, this list of conditions and the following disclaimer.
+ .\" 2. Redistributions in binary form must reproduce the above copyright
+ .\" notice, this list of conditions and the following disclaimer in the
+ .\" documentation and/or other materials provided with the distribution.
+ .\" 3. All advertising materials mentioning features or use of this software
+ .\" must display the following acknowledgement:
+ .\" This product includes software developed by the University of
+ .\" California, Berkeley and its contributors.
+ .\" 4. Neither the name of the University nor the names of its contributors
+ .\" may be used to endorse or promote products derived from this software
+ .\" without specific prior written permission.
+ .\"
+ .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ .\" SUCH DAMAGE.
+ .\"
+ .\" from: @(#)bcd.6 6.7 (Berkeley) 6/23/90
+ .\" $Id: bcd.6,v 1.3 1993/08/05 01:46:31 jtc Exp $
+ .\"
+ .Dd June 23, 1990
+ .Dt PPT 6
+ .Os
+ .Sh NAME
+ .Nm ppt
+ .Nd format input as paper tape
+ .Sh SYNOPSIS
+ .Nm ppt
+ .Op Ar string ...
+ .Sh DESCRIPTION
+ .Nm Ppt
+ converts command line arguments, if provided, or standard input into a form
+ familiar to old-timers.
*** ./games/ppt/Makefile.ORIG Sat Mar 19 14:24:54 1994
--- ./games/ppt/Makefile Sat Mar 19 14:25:09 1994
***************
*** 2,8 ****
# $Id: Makefile,v 1.2 1993/08/01 05:44:46 mycroft Exp $
PROG= ppt
! NOMAN= noman
HIDEGAME=hidegame
.include <bsd.prog.mk>
--- 2,8 ----
# $Id: Makefile,v 1.2 1993/08/01 05:44:46 mycroft Exp $
PROG= ppt
! MAN6= ppt.0
HIDEGAME=hidegame
.include <bsd.prog.mk>
*** ./games/morse/morse.6.ORIG Sat Mar 19 14:27:26 1994
--- ./games/morse/morse.6 Sat Mar 19 14:29:15 1994
***************
*** 0 ****
--- 1,51 ----
+ .\" Copyright (c) 1988 Regents of the University of California.
+ .\" All rights reserved.
+ .\"
+ .\" Redistribution and use in source and binary forms, with or without
+ .\" modification, are permitted provided that the following conditions
+ .\" are met:
+ .\" 1. Redistributions of source code must retain the above copyright
+ .\" notice, this list of conditions and the following disclaimer.
+ .\" 2. Redistributions in binary form must reproduce the above copyright
+ .\" notice, this list of conditions and the following disclaimer in the
+ .\" documentation and/or other materials provided with the distribution.
+ .\" 3. All advertising materials mentioning features or use of this software
+ .\" must display the following acknowledgement:
+ .\" This product includes software developed by the University of
+ .\" California, Berkeley and its contributors.
+ .\" 4. Neither the name of the University nor the names of its contributors
+ .\" may be used to endorse or promote products derived from this software
+ .\" without specific prior written permission.
+ .\"
+ .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ .\" SUCH DAMAGE.
+ .\"
+ .\" from: @(#)bcd.6 6.7 (Berkeley) 6/23/90
+ .\" $Id: bcd.6,v 1.3 1993/08/05 01:46:31 jtc Exp $
+ .\"
+ .Dd June 23, 1990
+ .Dt MORSE 6
+ .Os
+ .Sh NAME
+ .Nm morse
+ .Nd format input as morse code
+ .Sh SYNOPSIS
+ .Nm morse
+ .Op Fl s
+ .Op Ar string ...
+ .Sh DESCRIPTION
+ .Nm Morse
+ converts command line arguments, if provided, or standard input into a form
+ familiar to old-timers.
+ The
+ .Fl s
+ option produces dots and dashes rather than words.
*** ./games/morse/Makefile.ORIG Sat Mar 19 14:27:31 1994
--- ./games/morse/Makefile Sat Mar 19 14:27:43 1994
***************
*** 2,8 ****
# $Id: Makefile,v 1.2 1993/08/01 05:44:57 mycroft Exp $
PROG= morse
! NOMAN= noman
HIDEGAME=hidegame
.include <bsd.prog.mk>
--- 2,8 ----
# $Id: Makefile,v 1.2 1993/08/01 05:44:57 mycroft Exp $
PROG= morse
! MAN6= morse.0
HIDEGAME=hidegame
.include <bsd.prog.mk>
*** ./games/monop/monop.6.ORIG Sat Mar 19 13:59:27 1994
--- ./games/monop/monop.6 Sat Mar 19 13:59:36 1994
***************
*** 32,39 ****
.\" from: @(#)monop.6 6.4 (Berkeley) 6/23/90
.\" $Id: monop.6,v 1.6 1993/09/16 17:03:11 jtc Exp $
.\"
! .Dt March 25, 1993
! .Dd MONOP 6
.Os
.Sh NAME
.Nm monop
--- 32,39 ----
.\" from: @(#)monop.6 6.4 (Berkeley) 6/23/90
.\" $Id: monop.6,v 1.6 1993/09/16 17:03:11 jtc Exp $
.\"
! .Dd March 25, 1993
! .Dt MONOP 6
.Os
.Sh NAME
.Nm monop
*** ./games/bcd/bcd.6.ORIG Sat Mar 19 14:21:16 1994
--- ./games/bcd/bcd.6 Sat Mar 19 14:24:29 1994
***************
*** 38,68 ****
.Sh NAME
.Nm bcd
.Nd format input as punch cards
- .br
- .Nm ppt
- .Nd format input as paper tape
- .br
- .Nm morse
- .Nd format input as morse code
.Sh SYNOPSIS
.Nm bcd
.Op Ar string ...
- .br
- .Nm ppt
- .Op Ar string ...
- .br
- .Nm morse
- .Op Fl s
- .Op Ar string ...
.Sh DESCRIPTION
! .Nm Bcd ,
! .Nm ppt
! and
! .Nm morse
! convert command line arguments, if provided, or standard input into a form
familiar to old-timers.
- The
- .Fl s
- option for
- .Nm morse
- produces dots and dashes rather than words.
--- 38,47 ----
.Sh NAME
.Nm bcd
.Nd format input as punch cards
.Sh SYNOPSIS
.Nm bcd
.Op Ar string ...
.Sh DESCRIPTION
! .Nm Bcd
! converts command line arguments, if provided, or standard input into a form
familiar to old-timers.
*** ./games/bcd/Makefile.ORIG Sat Mar 19 14:22:47 1994
--- ./games/bcd/Makefile Sat Mar 19 14:22:59 1994
***************
*** 3,9 ****
PROG= bcd
MAN6= bcd.0
- MLINKS= bcd.6 morse.6 bcd.6 ppt.6
HIDEGAME=hidegame
.include <bsd.prog.mk>
--- 3,8 ----
*** ./gnu/usr.bin/ld/ld.1.ORIG Sat Mar 19 14:54:52 1994
--- ./gnu/usr.bin/ld/ld.1 Sat Mar 19 14:54:56 1994
***************
*** 30,36 ****
.\" $Id: ld.1,v 1.5 1994/01/29 02:03:04 jtc Exp $
.\"
.Dd October 14, 1993
! .Dt LD 8
.Os NetBSD 0.9
.Sh NAME
.Nm ld
--- 30,36 ----
.\" $Id: ld.1,v 1.5 1994/01/29 02:03:04 jtc Exp $
.\"
.Dd October 14, 1993
! .Dt LD 1
.Os NetBSD 0.9
.Sh NAME
.Nm ld
*** ./lib/libc/gen/tcsetpgrp.3.ORIG Sat Mar 19 14:32:26 1994
--- ./lib/libc/gen/tcsetpgrp.3 Sat Mar 19 14:32:32 1994
***************
*** 33,39 ****
.\" $Id: tcsetpgrp.3,v 1.2 1993/07/30 08:39:43 mycroft Exp $
.\"
.Dd "March 29, 1992"
! .Dt TCSETPGRP
.Os
.Sh NAME
.Nm tcsetpgrp
--- 33,39 ----
.\" $Id: tcsetpgrp.3,v 1.2 1993/07/30 08:39:43 mycroft Exp $
.\"
.Dd "March 29, 1992"
! .Dt TCSETPGRP 3
.Os
.Sh NAME
.Nm tcsetpgrp
*** ./libexec/makewhatis/makewhatis.sh.ORIG Sat Mar 19 12:55:07 1994
--- ./libexec/makewhatis/makewhatis.sh Sat Mar 19 13:42:20 1994
***************
*** 41,47 ****
find $MANDIR -type f -name '*.0' -print | while read file
do
sed -n -f /usr/share/man/makewhatis.sed $file;
! done | sort -u > /tmp/whatis$$
install -o bin -g bin -m 444 /tmp/whatis$$ "$MANDIR/whatis.db"
exit 0
--- 41,54 ----
find $MANDIR -type f -name '*.0' -print | while read file
do
sed -n -f /usr/share/man/makewhatis.sed $file;
! done > /tmp/whatis$$
!
! find $MANDIR -type f -name '*.0.gz' -print | while read file
! do
! gzip -dc $file | sed -n -f /usr/share/man/makewhatis.sed;
! done >> /tmp/whatis$$
!
! sort -u -o /tmp/whatis$$ /tmp/whatis$$
install -o bin -g bin -m 444 /tmp/whatis$$ "$MANDIR/whatis.db"
exit 0
*** ./libexec/atrun/Makefile.ORIG Sat Mar 19 14:51:17 1994
--- ./libexec/atrun/Makefile Sat Mar 19 14:51:27 1994
***************
*** 2,7 ****
--- 2,8 ----
PROG= atrun
BINDIR= /usr/libexec
+ MAN8= atrun.0
BINOWN= root
*** ./share/man/makewhatis.sed.ORIG Sat Mar 19 13:19:12 1994
--- ./share/man/makewhatis.sed Sat Mar 19 14:45:12 1994
***************
*** 34,41 ****
# @(#)makewhatis.sed 5.5 (Berkeley) 4/17/91
#
! /^[a-zA-Z_][a-zA-Z_0-9]*(\([a-zA-Z_0-9]*\).*/ {
! s;^[a-zA-Z_0-9]*(\([a-zA-Z_0-9]*\).*;\1;
h
d
}
--- 34,41 ----
# @(#)makewhatis.sed 5.5 (Berkeley) 4/17/91
#
! /^[a-zA-Z_][a-zA-Z_0-9\.+-]*(\([a-zA-Z_0-9\.+-]*\).*/ {
! s;^[a-zA-Z_0-9\.+-]*(\([a-zA-Z_0-9\.+-]*\).*;\1;
h
d
}
***************
*** 58,64 ****
/-/!d
s;.;;g
s;\([a-z][A-z]\)-[ ][ ]*;\1;
! s;\([a-zA-Z_0-9,]\)[ ][ ]*;\1 ;g
! s;[^a-zA-Z_0-9]*\([a-zA-Z_0-9]*\)[^a-zA-Z_0-9]*\(.*\) - \(.*\);\2 (\1) - \3;
p
q
--- 58,64 ----
/-/!d
s;.;;g
s;\([a-z][A-z]\)-[ ][ ]*;\1;
! s;\([a-zA-Z_0-9,\.+-]\)[ ][ ]*;\1 ;g
! s;[^a-zA-Z_0-9\.+-]*\([a-zA-Z_0-9\.+-]*\)[^a-zA-Z_0-9\.+-]*\(.*\) - \(.*\);\2 (\1) - \3;
p
q
*** ./usr.bin/vmstat/vmstat.8.ORIG Sat Mar 19 13:46:47 1994
--- ./usr.bin/vmstat/vmstat.8 Sat Mar 19 13:46:55 1994
***************
*** 33,39 ****
.\" $Id: vmstat.8,v 1.5 1993/10/06 19:16:41 jtc Exp $
.\"
.Dd June 20, 1991
! .Dt VMSTAT 1
.Os
.Sh NAME
.Nm vmstat
--- 33,39 ----
.\" $Id: vmstat.8,v 1.5 1993/10/06 19:16:41 jtc Exp $
.\"
.Dd June 20, 1991
! .Dt VMSTAT 8
.Os
.Sh NAME
.Nm vmstat
*** ./usr.bin/showmount/Makefile.ORIG Sat Mar 19 14:53:55 1994
--- ./usr.bin/showmount/Makefile Sat Mar 19 14:54:03 1994
***************
*** 2,6 ****
--- 2,7 ----
# $Id: Makefile,v 1.3 1993/10/08 02:35:52 cgd Exp $
PROG= showmount
+ MAN8= showmount.0
.include <bsd.prog.mk>
*** ./usr.bin/renice/Makefile.ORIG Sat Mar 19 14:52:14 1994
--- ./usr.bin/renice/Makefile Sat Mar 19 14:52:19 1994
***************
*** 2,6 ****
--- 2,7 ----
# $Id: Makefile,v 1.2 1993/07/30 23:51:34 mycroft Exp $
PROG= renice
+ MAN8= renice
.include <bsd.prog.mk>
--
Luke Mewburn Programmer, Technical Services Group,
Email: <lm@rmit.edu.au> Department of Computer Science, RMIT,
Phone: +61 3 660 3210 Melbourne, Victoria, Australia.
------------------------------------------------------------------------------