xref: /netbsd/usr.sbin/catman/catman.8 (revision bf9ec67e)
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.\"	$NetBSD: catman.8,v 1.10 2002/01/19 03:07:33 wiz 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
40.Op Fl knpsw
41.Op Fl m Ar directory
42.Op Ar sections
43.Nm ""
44.Op Fl knpsw
45.Op Fl M Ar directory
46.Op Ar sections
47.Sh DESCRIPTION
48.Nm
49creates formatted versions of the on-line manual pages from their
50.Xr nroff 1
51source.
52Manual pages whose formatted versions are missing or out of date are
53regenerated.
54If manual pages are regenerated,
55.Nm
56also regenerates the
57.Pa whatis
58database.
59.Pp
60The optional
61.Ar sections
62argument is one word, and contains the section numbers of all the
63sections to be checked.  For example, if
64.Ar sections
65is ``13f8'', the
66manual pages in sections 1, 3f, and 8 will be checked and regenerated.
67If no
68.Ar sections
69argument is provided,
70.Nm
71will try to operate on all of the known manual sections.
72.Pp
73The options are as follows:
74.Bl -tag -width indent
75.It Fl k
76Ignore errors from nroff when building manpages.
77.It Fl n
78Do not create the
79.Pa whatis
80database.
81.It Fl p
82Display the commands that would have been executed, but do not actually
83execute them.
84.It Fl s
85Perform work silently; do not echo commands as they are executed.  This
86flag is ignored if
87.Fl p
88is specified.
89.It Fl w
90Only create the
91.Pa whatis
92database.
93.It Fl m Ar directory
94Add
95.Ar directory
96to the set of directories to be updated.
97.It Fl M Ar directory
98Update manual pages in
99.Ar directory .
100.El
101.Sh SEE ALSO
102.Xr apropos 1 ,
103.Xr man 1 ,
104.Xr whatis 1
105.Sh BUGS
106Currently does not handle hard links.
107