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