1.\" $NetBSD: locate.conf.5,v 1.9 2011/07/10 13:42:49 apb 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 July 10, 2011 31.Dt LOCATE.CONF 5 32.Os 33.Sh NAME 34.Nm locate.conf 35.Nd locate database configuration file 36.Sh DESCRIPTION 37The 38.Nm locate.conf 39file specifies the behavior of 40.Xr locate.updatedb 8 , 41which creates the 42.Xr locate 1 43database. 44.Pp 45The 46.Nm 47file contains a list of newline separated records, 48each of which is composed of a keyword and arguments, 49which are separated by white space. 50Arguments with embedded shell metacharacters must be quoted in 51.Xr sh 1 52style. 53Lines beginning with 54.Dq # 55are treated as comments and ignored. 56However, a 57.Dq # 58in the middle of a line does not start a comment. 59.Pp 60The configuration options are as follows: 61.Bl -tag -width XXXXXX 62.It Sy ignore Ar pattern ... 63Ignore files or directories. 64When building the database, 65do not descend into files or directories 66which match one of the specified patterns. 67The matched files or directories are not stored to the database. 68.Pp 69Default: Not specified. 70.It Sy ignorecontents Ar pattern ... 71Ignore contents of directories. 72When building the database, 73do not descend into files or directories 74which match one of the specified patterns. 75The matched files or directories themselves are stored to the database. 76.Pp 77Default: Not specified. 78.It Sy ignorefs Ar type ... 79Ignore file system by type, 80adding 81.Ar type 82to the default list. 83When building the database, 84do not descend into file systems which are of the specified 85.Ar type . 86The mount points are not stored to the database. 87If a 88.Dq \&! 89is prepended to 90.Ar type , 91the meaning is negated, 92that is, ignore file systems which do not have the type. 93As a special case, if 94.Dq none 95is specified for 96.Ar type , 97the 98.Sy ignorefs 99list is cleared and all file systems are traversed. 100.Pp 101.Ar type 102is used as an argument to 103.Xr find 1 104.Fl fstype . 105The 106.Xr sysctl 8 107command can be used to find out the types of file systems 108that are available on the system: 109.Bd -literal -offset indent 110sysctl vfs.generic.fstypes 111.Ed 112.Pp 113Default: !local cd9660 fdesc kernfs procfs 114.It Sy searchpath Ar directory ... 115Specify base directories to be put in the database. 116.Pp 117Default: / 118.It Sy workdir Ar directory 119Specify the working directory of locate.updatedb, 120in which a temporary file is placed. 121The temporary file is a list of all files, 122and you should specify a directory that has enough space to hold it. 123.Pp 124Default: /tmp 125.El 126.Pp 127Refer to 128.Xr find 1 129for the details of 130.Ar pattern 131(see 132.Fl path 133expression) 134and 135.Ar type 136(see 137.Fl fstype 138expression). 139.Sh FILES 140.Bl -tag -width /usr/libexec/locate.updatedb -compact 141.It Pa /etc/locate.conf 142The file 143.Nm 144resides in 145.Pa /etc . 146.El 147.Sh SEE ALSO 148.Xr find 1 , 149.Xr locate 1 , 150.Xr locate.updatedb 8 , 151.Xr sysctl 8 152.Sh HISTORY 153The 154.Nm 155file format first appeared in 156.Nx 2.0 . 157.Sh AUTHORS 158.An ITOH Yasufumi 159