xref: /netbsd-src/usr.sbin/catman/catman.8 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\"
2.\" Copyright (c) 1993 Winning Strategies, Inc.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"      This product includes software developed by Winning Strategies, Inc.
16.\" 4. The name of the author may not be used to endorse or promote products
17.\"    derived from this software without specific prior written permission
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\"	$Id: catman.8,v 1.6 1994/04/27 22:40:48 cgd Exp $
31.\"
32.Dd July 30, 1993
33.Dt CATMAN 8
34.Os
35.Sh NAME
36.Nm catman
37.Nd format cat pages from man pages
38.Sh SYNOPSIS
39.Nm catman
40.Op Fl knpsw
41.Op Fl M Ar directory
42.Op Ar sections
43.Sh DESCRIPTION
44.Nm Catman
45creates formatted versions of the on-line manual pages from their
46.Xr nroff 1
47source.
48Manual pages whose formatted versions are missing or out of date are
49regenerated.
50If manual pages are regenerated,
51.Nm catman
52also regenerates the
53.Nm whatis
54database.
55.Pp
56The optional
57.Ar sections
58argument is one word, and contains the section numbers of all the
59sections to be checked.  For example, if
60.Ar sections
61is ``138'', the
62manual pages in sections 1, 3, and 8 will be checked and regenerated.
63If no
64.Ar sections
65argument is provided,
66.Nm catman
67will try to operate on all of the known manual sections.
68.Pp
69The options are as follows:
70.Bl -tag -width indent
71.It Fl k
72Ignore errors from nroff when building manpages.
73.It Fl n
74Do not create the
75.Nm whatis
76database.
77.It Fl p
78Display the commands that would have been executed, but do not actually
79execute them.
80.It Fl s
81Perform work silently; do not echo commands as they are executed.  This
82flag is ignored if
83.Fl p
84is specified.
85.It Fl w
86Only create the
87.Nm whatis
88database.
89.It Fl M Ar directory
90Update manual pages in
91.Ar directory.
92.El
93.Sh SEE ALSO
94.Xr apropos 1 ,
95.Xr man 1 ,
96.Xr whatis 1
97.Sh BUGS
98Currently knows nothing about
99.Pa /etc/man.conf
100and machine specific man pages.
101