1.\" $NetBSD: locate.conf.5,v 1.7 2008/04/30 13:10:57 martin 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 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. 50Lines beginning with 51.Dq # 52are treated as comments and ignored. 53However, a 54.Dq # 55in the middle of a line does not start comment. 56.Pp 57The configuration options are as follows: 58.Bl -tag -width XXXXXX 59.It Sy ignore Ar pattern ... 60Ignore files or directories. 61When building the database, 62do not descend into files or directories 63which match one of the specified patterns. 64The matched files or directories are not stored to the database. 65.Pp 66Default: Not specified. 67.It Sy ignorecontents Ar pattern ... 68Ignore contents of directories. 69When building the database, 70do not descend into files or directories 71which match one of the specified patterns. 72The matched files or directories themselves are stored to the database. 73.Pp 74Default: Not specified. 75.It Sy ignorefs Ar type ... 76Ignore file system by type, 77adding 78.Ar type 79to the default list. 80When building the database, 81do not descend into file systems which are of the specified 82.Ar type . 83The mount points are not stored to the database. 84If a 85.Dq \&! 86is prepended to 87.Ar type , 88the meaning is negated, 89that is, ignore file systems which do not have the type. 90As a special case, if 91.Dq none 92is specified for 93.Ar type , 94the 95.Sy ignorefs 96list is cleared and all file systems are traversed. 97.Pp 98.Ar type 99is used as an argument to 100.Xr find 1 101.Fl fstype . 102The 103.Xr sysctl 8 104command can be used to find out the types of file systems 105that are available on the system: 106.Bd -literal -offset indent 107sysctl vfs.generic.fstypes 108.Ed 109.Pp 110Default: !local cd9660 fdesc kernfs procfs 111.It Sy searchpath Ar directory ... 112Specify base directories to be put in the database. 113.Pp 114Default: / 115.It Sy workdir Ar directory 116Specify the working directory of locate.updatedb, 117in which a temporary file is placed. 118The temporary file is a list of all files, 119and you should specify a directory that has enough space to hold it. 120.Pp 121Default: /tmp 122.El 123.Pp 124Refer to 125.Xr find 1 126for the details of 127.Ar pattern 128(see 129.Fl path 130expression) 131and 132.Ar type 133(see 134.Fl fstype 135expression). 136.Sh FILES 137.Bl -tag -width /usr/libexec/locate.updatedb -compact 138.It Pa /etc/locate.conf 139The file 140.Nm 141resides 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 150The 151.Nm 152file format first appeared in 153.Nx 2.0 . 154.Sh AUTHORS 155.An ITOH Yasufumi Aq itohy@NetBSD.org 156