Next time I'll run cvs update to make sure I've added
[dragonfly.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 .\" $DragonFly: src/gnu/usr.bin/man/makewhatis/Attic/makewhatis.local.8,v 1.2 2003/06/17 04:25:46 dillon Exp $
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 
41 .Nm
42 start 
43 .Xr makewhatis 1
44 only for file systems physically mounted on the system
45 where the 
46 .Nm
47 is being executed. Running makewhatis
48 by 
49 .Pa periodic weekly
50 for rw nfs-mounted /usr may kill
51 your NFS server -- all NFS clients start makewhatis at the same time!
52 So use this wrapper for 
53 .Xr cron 8
54 instead of calling makewhatis directly.
55 .Nm catman.local
56 is using for same purposes as
57 .Nm
58 but for
59 .Xr catman 1 .
60 .Sh FILES
61 .Bl -tag -width /etc/periodic/weekly/320.whatis.XXX -compact
62 .It Pa /etc/periodic/weekly/320.whatis
63 run
64 .Nm
65 every week
66 .It Pa /etc/periodic/weekly/330.catman
67 run
68 .Nm catman.local
69 every week
70 .El
71 .Sh SEE ALSO
72 .Xr catman 1 ,
73 .Xr find 1 ,
74 .Xr makewhatis 1 ,
75 .Xr cron 8 ,
76 .Xr periodic 8
77 .Sh HISTORY
78 The
79 .Nm
80 command appeared in
81 .Fx 2.2 .