libexec/makewhatis.local/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/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.4 2005/08/05 22:35:10 swildner Exp $
  27 .Dd April 26, 1996
  28 .Dt MAKEWHATIS.LOCAL 8
  29 .Os
  30 .Sh NAME
  31 .Nm makewhatis.local ,
  32 .Nm catman.local
  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 ...
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility starts
  45 .Xr makewhatis 8
  46 only for file systems physically mounted on the system
  47 where the
  48 .Nm
  49 is being executed. Running makewhatis
  50 by
  51 .Pa periodic weekly
  52 for rw nfs-mounted /usr may kill
  53 your NFS server -- all NFS clients start makewhatis at the same time!
  54 So use this wrapper for
  55 .Xr cron 8
  56 instead of calling makewhatis directly.
  57 The
  58 .Nm catman.local
  59 utility is using for same purposes as
  60 .Nm
  61 but 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
  66 run
  67 .Nm
  68 every week
  69 .It Pa /etc/periodic/weekly/330.catman
  70 run
  71 .Nm catman.local
  72 every week
  73 .El
  74 .Sh SEE ALSO
  75 .Xr catman 1 ,
  76 .Xr find 1 ,
  77 .Xr cron 8 ,
  78 .Xr makewhatis 8 ,
  79 .Xr periodic 8
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 utility appeared in
  84 .Fx 2.2 .