usr.bin/locate/locate/locate.updatedb.8

   1 .\" Copyright (c) 1996
   2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Mike Pritchard.
  15 .\" 4. Neither the name of the author nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd February 11, 1996
  34 .Dt LOCATE.UPDATEDB 8
  35 .Os
  36 .Sh NAME
  37 .Nm locate.updatedb
  38 .Nd update locate database
  39 .Sh SYNOPSIS
  40 .Nm /usr/libexec/locate.updatedb
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility updates the database used by
  45 .Xr locate 1 .
  46 It is typically run once a week by the
  47 .Pa /etc/periodic/weekly/310.locate
  48 script.
  49 .Pp
  50 The contents of the newly built database can be controlled by the
  51 .Pa /etc/locate.rc
  52 file.
  53 .Sh ENVIRONMENT
  54 .Bl -tag -width /var/db/locate.database -compact
  55 .It Pa LOCATE_CONFIG
  56 path to the configuration file
  57 .El
  58 .Sh FILES
  59 .Bl -tag -width /var/db/locate.database -compact
  60 .It Pa /var/db/locate.database
  61 the default database
  62 .It Pa /etc/locate.rc
  63 the configuration file
  64 .El
  65 .Sh SEE ALSO
  66 .Xr locate 1 ,
  67 .Xr periodic 8
  68 .Rs
  69 .%A Woods, James A.
  70 .%D 1983
  71 .%T "Finding Files Fast"
  72 .%J ";login"
  73 .%V 8:1
  74 .%P pp. 8-10
  75 .Re