Merge from vendor branch GROFF:
[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 25.\" $FreeBSD: src/usr.bin/makewhatis/makewhatis.local.8,v 1.13 2002/07/14 15:12:00 charnier Exp $
d0de9052 26.\" $DragonFly: src/libexec/makewhatis.local/makewhatis.local.8,v 1.4 2005/08/05 22:35:10 swildner Exp $
984263bc
MD
27.Dd April 26, 1996
28.Dt MAKEWHATIS.LOCAL 8
29.Os
30.Sh NAME
d0de9052
SW
31.Nm makewhatis.local ,
32.Nm catman.local
984263bc
MD
33.Nd start makewhatis or catman for local file systems
34.Sh SYNOPSIS
35.Nm /usr/libexec/makewhatis.local
36.Op options
37.Ar directories ...
38.Nm /usr/libexec/catman.local
39.Op options
40.Ar directories ...
1bf4b486 41.Sh DESCRIPTION
ae4803a1 42The
984263bc 43.Nm
ae4803a1
JS
44utility starts
45.Xr makewhatis 8
984263bc 46only for file systems physically mounted on the system
1bf4b486 47where the
984263bc
MD
48.Nm
49is being executed. Running makewhatis
1bf4b486 50by
984263bc
MD
51.Pa periodic weekly
52for rw nfs-mounted /usr may kill
53your NFS server -- all NFS clients start makewhatis at the same time!
1bf4b486 54So use this wrapper for
984263bc
MD
55.Xr cron 8
56instead of calling makewhatis directly.
ae4803a1 57The
984263bc 58.Nm catman.local
ae4803a1 59utility is using for same purposes as
984263bc
MD
60.Nm
61but for
62.Xr catman 1 .
63.Sh FILES
64.Bl -tag -width /etc/periodic/weekly/320.whatis.XXX -compact
65.It Pa /etc/periodic/weekly/320.whatis
66run
67.Nm
68every week
69.It Pa /etc/periodic/weekly/330.catman
70run
71.Nm catman.local
72every week
73.El
74.Sh SEE ALSO
75.Xr catman 1 ,
76.Xr find 1 ,
984263bc 77.Xr cron 8 ,
7e42719e 78.Xr makewhatis 8 ,
984263bc
MD
79.Xr periodic 8
80.Sh HISTORY
81The
82.Nm
ae4803a1 83utility appeared in
984263bc 84.Fx 2.2 .