xref: /netbsd-src/usr.sbin/catman/catman.8 (revision 1b6126848e3372fcb280d62f67b7532f6b353404)
1aee4b07bSmycroft.\"
278df5febSjtc.\" Copyright (c) 1993 Winning Strategies, Inc.
378df5febSjtc.\" All rights reserved.
478df5febSjtc.\"
578df5febSjtc.\" Redistribution and use in source and binary forms, with or without
678df5febSjtc.\" modification, are permitted provided that the following conditions
778df5febSjtc.\" are met:
878df5febSjtc.\" 1. Redistributions of source code must retain the above copyright
978df5febSjtc.\"    notice, this list of conditions and the following disclaimer.
1078df5febSjtc.\" 2. Redistributions in binary form must reproduce the above copyright
1178df5febSjtc.\"    notice, this list of conditions and the following disclaimer in the
1278df5febSjtc.\"    documentation and/or other materials provided with the distribution.
1378df5febSjtc.\" 3. All advertising materials mentioning features or use of this software
1478df5febSjtc.\"    must display the following acknowledgement:
1578df5febSjtc.\"      This product includes software developed by Winning Strategies, Inc.
1678df5febSjtc.\" 4. The name of the author may not be used to endorse or promote products
1742f840d2Sjtc.\"    derived from this software without specific prior written permission
1878df5febSjtc.\"
1978df5febSjtc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
2078df5febSjtc.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
2178df5febSjtc.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
2278df5febSjtc.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
2378df5febSjtc.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2478df5febSjtc.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2578df5febSjtc.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2678df5febSjtc.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2778df5febSjtc.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2878df5febSjtc.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2978df5febSjtc.\"
30*1b612684Schristos.\"	$NetBSD: catman.8,v 1.12 2021/08/15 11:00:43 christos Exp $
3178df5febSjtc.\"
32*1b612684Schristos.Dd August 15, 2021
3378df5febSjtc.Dt CATMAN 8
3478df5febSjtc.Os
3578df5febSjtc.Sh NAME
3678df5febSjtc.Nm catman
3778df5febSjtc.Nd format cat pages from man pages
3878df5febSjtc.Sh SYNOPSIS
39272b4a40Slukem.Nm
40afaaa071Schopps.Op Fl knpsw
41bea74446Sdante.Op Fl m Ar directory
42bea74446Sdante.Op Ar sections
43990562bfSwiz.Nm
44bea74446Sdante.Op Fl knpsw
4578df5febSjtc.Op Fl M Ar directory
4678df5febSjtc.Op Ar sections
4778df5febSjtc.Sh DESCRIPTION
48272b4a40Slukem.Nm
4978df5febSjtccreates formatted versions of the on-line manual pages from their
5078df5febSjtc.Xr nroff 1
5178df5febSjtcsource.
5278df5febSjtcManual pages whose formatted versions are missing or out of date are
5378df5febSjtcregenerated.
54dd243c0bScgdIf manual pages are regenerated,
55272b4a40Slukem.Nm
56c6ac3ac2Scgdalso regenerates the
57272b4a40Slukem.Pa whatis
5878df5febSjtcdatabase.
5978df5febSjtc.Pp
60dd243c0bScgdThe optional
61dd243c0bScgd.Ar sections
62dd243c0bScgdargument is one word, and contains the section numbers of all the
63c6ac3ac2Scgdsections to be checked.  For example, if
64c6ac3ac2Scgd.Ar sections
65bea74446Sdanteis ``13f8'', the
66bea74446Sdantemanual pages in sections 1, 3f, and 8 will be checked and regenerated.
67c6ac3ac2ScgdIf no
68dd243c0bScgd.Ar sections
69dd243c0bScgdargument is provided,
70272b4a40Slukem.Nm
71dd243c0bScgdwill try to operate on all of the known manual sections.
72dd243c0bScgd.Pp
7378df5febSjtcThe options are as follows:
7478df5febSjtc.Bl -tag -width indent
75afaaa071Schopps.It Fl k
76dd243c0bScgdIgnore errors from nroff when building manpages.
7778df5febSjtc.It Fl n
7878df5febSjtcDo not create the
79272b4a40Slukem.Pa whatis
8078df5febSjtcdatabase.
8178df5febSjtc.It Fl p
8278df5febSjtcDisplay the commands that would have been executed, but do not actually
8378df5febSjtcexecute them.
84afaaa071Schopps.It Fl s
85dd243c0bScgdPerform work silently; do not echo commands as they are executed.  This
86afaaa071Schoppsflag is ignored if
87afaaa071Schopps.Fl p
88afaaa071Schoppsis specified.
8978df5febSjtc.It Fl w
9078df5febSjtcOnly create the
91272b4a40Slukem.Pa whatis
9278df5febSjtcdatabase.
93bea74446Sdante.It Fl m Ar directory
94bea74446SdanteAdd
95bea74446Sdante.Ar directory
96bea74446Sdanteto the set of directories to be updated.
9778df5febSjtc.It Fl M Ar directory
9878df5febSjtcUpdate manual pages in
9978df5febSjtc.Ar directory .
10078df5febSjtc.El
10178df5febSjtc.Sh SEE ALSO
10278df5febSjtc.Xr apropos 1 ,
10378df5febSjtc.Xr man 1 ,
10478df5febSjtc.Xr whatis 1
105afaaa071Schopps.Sh BUGS
106bea74446SdanteCurrently does not handle hard links.
107*1b612684SchristosActs oddly on nights with full moons.
108