share/man/man5/locate.conf.5

   1 .\"     $NetBSD: locate.conf.5,v 1.6 2005/10/05 06:29:03 hubertf Exp $
   2 .\"
   3 .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by ITOH Yasufumi.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd October 1, 2005
  31 .Dt LOCATE.CONF 5
  32 .Os
  33 .Sh NAME
  34 .Nm locate.conf
  35 .Nd locate database configuration file
  36 .Sh DESCRIPTION
  37 The
  38 .Nm locate.conf
  39 file specifies the behavior of
  40 .Xr locate.updatedb 8 ,
  41 which creates the
  42 .Xr locate 1
  43 database.
  44 .Pp
  45 The
  46 .Nm
  47 file contains a list of newline separated records,
  48 each of which is composed of a keyword and arguments,
  49 which are separated by white space.
  50 Lines beginning with
  51 .Dq #
  52 are treated as comments and ignored.
  53 However, a
  54 .Dq #
  55 in the middle of a line does not start comment.
  56 .Pp
  57 The configuration options are as follows:
  58 .Bl -tag -width XXXXXX
  59 .It Sy ignore Ar pattern ...
  60 Ignore files or directories.
  61 When building the database,
  62 do not descend into files or directories
  63 which match one of the specified patterns.
  64 The matched files or directories are not stored to the database.
  65 .Pp
  66 Default: Not specified.
  67 .It Sy ignorecontents Ar pattern ...
  68 Ignore contents of directories.
  69 When building the database,
  70 do not descend into files or directories
  71 which match one of the specified patterns.
  72 The matched files or directories themselves are stored to the database.
  73 .Pp
  74 Default: Not specified.
  75 .It Sy ignorefs Ar type ...
  76 Ignore file system by type,
  77 adding
  78 .Ar type
  79 to the default list.
  80 When building the database,
  81 do not descend into file systems which are of the specified
  82 .Ar type .
  83 The mount points are not stored to the database.
  84 If a
  85 .Dq \&!
  86 is prepended to
  87 .Ar type ,
  88 the meaning is negated,
  89 that is, ignore file systems which do not have the type.
  90 As a special case, if
  91 .Dq none
  92 is specified for
  93 .Ar type ,
  94 the
  95 .Sy ignorefs
  96 list is cleared and all file systems are traversed.
  97 .Pp
  98 .Ar type
  99 is used as an argument to
 100 .Xr find 1
 101 .Fl fstype .
 102 The
 103 .Xr sysctl 8
 104 command can be used to find out the types of file systems
 105 that are available on the system:
 106 .Bd -literal -offset indent
 107 sysctl vfs.generic.fstypes
 108 .Ed
 109 .Pp
 110 Default: !local cd9660 fdesc kernfs procfs
 111 .It Sy searchpath Ar directory ...
 112 Specify base directories to be put in the database.
 113 .Pp
 114 Default: /
 115 .It Sy workdir Ar directory
 116 Specify the working directory of locate.updatedb,
 117 in which a temporary file is placed.
 118 The temporary file is a list of all files,
 119 and you should specify a directory that has enough space to hold it.
 120 .Pp
 121 Default: /tmp
 122 .El
 123 .Pp
 124 Refer to
 125 .Xr find 1
 126 for the details of
 127 .Ar pattern
 128 (see
 129 .Fl path
 130 expression)
 131 and
 132 .Ar type
 133 (see
 134 .Fl fstype
 135 expression).
 136 .Sh FILES
 137 .Bl -tag -width /usr/libexec/locate.updatedb -compact
 138 .It Pa /etc/locate.conf
 139 The file
 140 .Nm
 141 resides in
 142 .Pa /etc .
 143 .El
 144 .Sh SEE ALSO
 145 .Xr find 1 ,
 146 .Xr locate 1 ,
 147 .Xr locate.updatedb 8 ,
 148 .Xr sysctl 8
 149 .Sh HISTORY
 150 The
 151 .Nm
 152 file format first appeared in
 153 .Nx 2.0 .
 154 .Sh AUTHORS
 155 .An ITOH Yasufumi Aq itohy@NetBSD.org