Convert to mdoc.
[dragonfly.git] / libexec / makewhatis.local / makewhatis.local.8
CommitLineData
984263bc
MD
1.\" Copyright (c) April 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
ae4803a1
JS
25.\" $FreeBSD: src/usr.bin/makewhatis/makewhatis.local.8,v 1.13 2002/07/14 15:12:00 charnier Exp $
26.\" $DragonFly: src/libexec/makewhatis.local/makewhatis.local.8,v 1.1 2004/03/25 18:05:49 joerg Exp $
984263bc
MD
27.Dd April 26, 1996
28.Dt MAKEWHATIS.LOCAL 8
29.Os
30.Sh NAME
31.Nm makewhatis.local , catman.local
32.Nd start makewhatis or catman for local file systems
33.Sh SYNOPSIS
34.Nm /usr/libexec/makewhatis.local
35.Op options
36.Ar directories ...
37.Nm /usr/libexec/catman.local
38.Op options
39.Ar directories ...
40.Sh DESCRIPTION
ae4803a1 41The
984263bc 42.Nm
ae4803a1
JS
43utility starts
44.Xr makewhatis 8
984263bc
MD
45only for file systems physically mounted on the system
46where the
47.Nm
48is being executed. Running makewhatis
49by
50.Pa periodic weekly
51for rw nfs-mounted /usr may kill
52your NFS server -- all NFS clients start makewhatis at the same time!
53So use this wrapper for
54.Xr cron 8
55instead of calling makewhatis directly.
ae4803a1 56The
984263bc 57.Nm catman.local
ae4803a1 58utility is using for same purposes as
984263bc
MD
59.Nm
60but for
61.Xr catman 1 .
62.Sh FILES
63.Bl -tag -width /etc/periodic/weekly/320.whatis.XXX -compact
64.It Pa /etc/periodic/weekly/320.whatis
65run
66.Nm
67every week
68.It Pa /etc/periodic/weekly/330.catman
69run
70.Nm catman.local
71every week
72.El
73.Sh SEE ALSO
74.Xr catman 1 ,
75.Xr find 1 ,
76.Xr makewhatis 1 ,
77.Xr cron 8 ,
78.Xr periodic 8
79.Sh HISTORY
80The
81.Nm
ae4803a1 82utility appeared in
984263bc 83.Fx 2.2 .