Initial import from FreeBSD RELENG_4:
[games.git] / gnu / usr.bin / man / makewhatis / makewhatis.local.8
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 .\"
25 .\" $FreeBSD: src/gnu/usr.bin/man/makewhatis/makewhatis.local.8,v 1.8.2.3 2001/08/16 10:14:57 ru Exp $
26 .Dd April 26, 1996
27 .Dt MAKEWHATIS.LOCAL 8
28 .Os
29 .Sh NAME
30 .Nm makewhatis.local , catman.local
31 .Nd start makewhatis or catman for local file systems
32 .Sh SYNOPSIS
33 .Nm /usr/libexec/makewhatis.local
34 .Op options
35 .Ar directories ...
36 .Nm /usr/libexec/catman.local
37 .Op options
38 .Ar directories ...
39 .Sh DESCRIPTION 
40 .Nm
41 start 
42 .Xr makewhatis 1
43 only for file systems physically mounted on the system
44 where the 
45 .Nm
46 is being executed. Running makewhatis
47 by 
48 .Pa periodic weekly
49 for rw nfs-mounted /usr may kill
50 your NFS server -- all NFS clients start makewhatis at the same time!
51 So use this wrapper for 
52 .Xr cron 8
53 instead of calling makewhatis directly.
54 .Nm catman.local
55 is using for same purposes as
56 .Nm
57 but for
58 .Xr catman 1 .
59 .Sh FILES
60 .Bl -tag -width /etc/periodic/weekly/320.whatis.XXX -compact
61 .It Pa /etc/periodic/weekly/320.whatis
62 run
63 .Nm
64 every week
65 .It Pa /etc/periodic/weekly/330.catman
66 run
67 .Nm catman.local
68 every week
69 .El
70 .Sh SEE ALSO
71 .Xr catman 1 ,
72 .Xr find 1 ,
73 .Xr makewhatis 1 ,
74 .Xr cron 8 ,
75 .Xr periodic 8
76 .Sh HISTORY
77 The
78 .Nm
79 command appeared in
80 .Fx 2.2 .