head 1.12; access; symbols netbsd-8-3-RELEASE:1.9 netbsd-9-4-RELEASE:1.9 netbsd-10-0-RELEASE:1.12 netbsd-10-0-RC6:1.12 netbsd-10-0-RC5:1.12 netbsd-10-0-RC4:1.12 netbsd-10-0-RC3:1.12 netbsd-10-0-RC2:1.12 netbsd-10-0-RC1:1.12 netbsd-10:1.12.0.6 netbsd-10-base:1.12 netbsd-9-3-RELEASE:1.9 cjep_sun2x-base1:1.12 cjep_sun2x:1.12.0.4 cjep_sun2x-base:1.12 cjep_staticlib_x-base1:1.12 netbsd-9-2-RELEASE:1.9 cjep_staticlib_x:1.12.0.2 cjep_staticlib_x-base:1.12 netbsd-9-1-RELEASE:1.9 phil-wifi-20200421:1.9 phil-wifi-20200411:1.9 is-mlppp:1.9.0.46 is-mlppp-base:1.9 phil-wifi-20200406:1.9 netbsd-8-2-RELEASE:1.9 netbsd-9-0-RELEASE:1.9 netbsd-9-0-RC2:1.9 netbsd-9-0-RC1:1.9 phil-wifi-20191119:1.9 netbsd-9:1.9.0.44 netbsd-9-base:1.9 phil-wifi-20190609:1.9 netbsd-8-1-RELEASE:1.9 netbsd-8-1-RC1:1.9 pgoyette-compat-merge-20190127:1.9 pgoyette-compat-20190127:1.9 pgoyette-compat-20190118:1.9 pgoyette-compat-1226:1.9 pgoyette-compat-1126:1.9 pgoyette-compat-1020:1.9 pgoyette-compat-0930:1.9 pgoyette-compat-0906:1.9 netbsd-7-2-RELEASE:1.9 pgoyette-compat-0728:1.9 netbsd-8-0-RELEASE:1.9 phil-wifi:1.9.0.42 phil-wifi-base:1.9 pgoyette-compat-0625:1.9 netbsd-8-0-RC2:1.9 pgoyette-compat-0521:1.9 pgoyette-compat-0502:1.9 pgoyette-compat-0422:1.9 netbsd-8-0-RC1:1.9 pgoyette-compat-0415:1.9 pgoyette-compat-0407:1.9 pgoyette-compat-0330:1.9 pgoyette-compat-0322:1.9 pgoyette-compat-0315:1.9 netbsd-7-1-2-RELEASE:1.9 pgoyette-compat:1.9.0.40 pgoyette-compat-base:1.9 netbsd-7-1-1-RELEASE:1.9 matt-nb8-mediatek:1.9.0.38 matt-nb8-mediatek-base:1.9 perseant-stdc-iso10646:1.9.0.36 perseant-stdc-iso10646-base:1.9 netbsd-8:1.9.0.34 netbsd-8-base:1.9 prg-localcount2-base3:1.9 prg-localcount2-base2:1.9 prg-localcount2-base1:1.9 prg-localcount2:1.9.0.32 prg-localcount2-base:1.9 pgoyette-localcount-20170426:1.9 bouyer-socketcan-base1:1.9 pgoyette-localcount-20170320:1.9 netbsd-7-1:1.9.0.30 netbsd-7-1-RELEASE:1.9 netbsd-7-1-RC2:1.9 netbsd-7-nhusb-base-20170116:1.9 bouyer-socketcan:1.9.0.28 bouyer-socketcan-base:1.9 pgoyette-localcount-20170107:1.9 netbsd-7-1-RC1:1.9 pgoyette-localcount-20161104:1.9 netbsd-7-0-2-RELEASE:1.9 localcount-20160914:1.9 netbsd-7-nhusb:1.9.0.26 netbsd-7-nhusb-base:1.9 pgoyette-localcount-20160806:1.9 pgoyette-localcount-20160726:1.9 pgoyette-localcount:1.9.0.24 pgoyette-localcount-base:1.9 netbsd-7-0-1-RELEASE:1.9 netbsd-7-0:1.9.0.22 netbsd-7-0-RELEASE:1.9 netbsd-7-0-RC3:1.9 netbsd-7-0-RC2:1.9 netbsd-7-0-RC1:1.9 netbsd-5-2-3-RELEASE:1.7 netbsd-5-1-5-RELEASE:1.7 netbsd-6-0-6-RELEASE:1.9 netbsd-6-1-5-RELEASE:1.9 netbsd-7:1.9.0.20 netbsd-7-base:1.9 yamt-pagecache-base9:1.9 yamt-pagecache-tag8:1.9 netbsd-6-1-4-RELEASE:1.9 netbsd-6-0-5-RELEASE:1.9 tls-earlyentropy:1.9.0.18 tls-earlyentropy-base:1.9 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.9 riastradh-drm2-base3:1.9 netbsd-6-1-3-RELEASE:1.9 netbsd-6-0-4-RELEASE:1.9 netbsd-5-2-2-RELEASE:1.7 netbsd-5-1-4-RELEASE:1.7 netbsd-6-1-2-RELEASE:1.9 netbsd-6-0-3-RELEASE:1.9 netbsd-5-2-1-RELEASE:1.7 netbsd-5-1-3-RELEASE:1.7 netbsd-6-1-1-RELEASE:1.9 riastradh-drm2-base2:1.9 riastradh-drm2-base1:1.9 riastradh-drm2:1.9.0.12 riastradh-drm2-base:1.9 netbsd-6-1:1.9.0.16 netbsd-6-0-2-RELEASE:1.9 netbsd-6-1-RELEASE:1.9 netbsd-6-1-RC4:1.9 netbsd-6-1-RC3:1.9 agc-symver:1.9.0.14 agc-symver-base:1.9 netbsd-6-1-RC2:1.9 netbsd-6-1-RC1:1.9 yamt-pagecache-base8:1.9 netbsd-5-2:1.7.0.18 netbsd-6-0-1-RELEASE:1.9 yamt-pagecache-base7:1.9 netbsd-5-2-RELEASE:1.7 netbsd-5-2-RC1:1.7 matt-nb6-plus-nbase:1.9 yamt-pagecache-base6:1.9 netbsd-6-0:1.9.0.10 netbsd-6-0-RELEASE:1.9 netbsd-6-0-RC2:1.9 tls-maxphys:1.9.0.8 tls-maxphys-base:1.9 matt-nb6-plus:1.9.0.6 matt-nb6-plus-base:1.9 netbsd-6-0-RC1:1.9 yamt-pagecache-base5:1.9 yamt-pagecache-base4:1.9 netbsd-6:1.9.0.4 netbsd-6-base:1.9 netbsd-5-1-2-RELEASE:1.7 netbsd-5-1-1-RELEASE:1.7 yamt-pagecache-base3:1.9 yamt-pagecache-base2:1.9 yamt-pagecache:1.9.0.2 yamt-pagecache-base:1.9 cherry-xenmp:1.8.0.2 cherry-xenmp-base:1.8 bouyer-quota2-nbase:1.8 bouyer-quota2:1.7.0.16 bouyer-quota2-base:1.7 matt-mips64-premerge-20101231:1.7 matt-nb5-mips64-premerge-20101231:1.7 matt-nb5-pq3:1.7.0.14 matt-nb5-pq3-base:1.7 netbsd-5-1:1.7.0.12 netbsd-5-1-RELEASE:1.7 netbsd-5-1-RC4:1.7 matt-nb5-mips64-k15:1.7 netbsd-5-1-RC3:1.7 netbsd-5-1-RC2:1.7 netbsd-5-1-RC1:1.7 netbsd-5-0-2-RELEASE:1.7 matt-nb5-mips64-premerge-20091211:1.7 matt-premerge-20091211:1.7 matt-nb5-mips64-u2-k2-k4-k7-k8-k9:1.7 matt-nb4-mips64-k7-u2a-k9b:1.7 matt-nb5-mips64-u1-k1-k5:1.7 matt-nb5-mips64:1.7.0.10 netbsd-5-0-1-RELEASE:1.7 jym-xensuspend-nbase:1.7 netbsd-5-0:1.7.0.8 netbsd-5-0-RELEASE:1.7 netbsd-5-0-RC4:1.7 netbsd-5-0-RC3:1.7 netbsd-5-0-RC2:1.7 jym-xensuspend:1.7.0.6 jym-xensuspend-base:1.7 netbsd-5-0-RC1:1.7 netbsd-5:1.7.0.4 netbsd-5-base:1.7 matt-mips64-base2:1.7 matt-mips64:1.6.0.24 netbsd-4-0-1-RELEASE:1.6 wrstuden-revivesa-base-3:1.7 wrstuden-revivesa-base-2:1.7 wrstuden-fixsa-newbase:1.6 wrstuden-revivesa-base-1:1.7 yamt-pf42-base4:1.7 yamt-pf42-base3:1.7 hpcarm-cleanup-nbase:1.7 yamt-pf42-baseX:1.6 yamt-pf42-base2:1.7 wrstuden-revivesa:1.7.0.2 wrstuden-revivesa-base:1.7 yamt-pf42:1.6.0.22 yamt-pf42-base:1.6 mjf-devfs2:1.6.0.20 mjf-devfs2-base:1.7 keiichi-mipv6-nbase:1.6 keiichi-mipv6:1.6.0.18 keiichi-mipv6-base:1.6 matt-armv6-nbase:1.6 matt-armv6-prevmlocking:1.6 wrstuden-fixsa-base-1:1.6 netbsd-4-0:1.6.0.16 netbsd-4-0-RELEASE:1.6 cube-autoconf:1.6.0.14 cube-autoconf-base:1.6 netbsd-4-0-RC5:1.6 netbsd-4-0-RC4:1.6 netbsd-4-0-RC3:1.6 netbsd-4-0-RC2:1.6 netbsd-4-0-RC1:1.6 matt-armv6:1.6.0.12 matt-armv6-base:1.6 matt-mips64-base:1.6 hpcarm-cleanup:1.6.0.10 hpcarm-cleanup-base:1.6 netbsd-3-1-1-RELEASE:1.5 netbsd-3-0-3-RELEASE:1.5 wrstuden-fixsa:1.6.0.8 wrstuden-fixsa-base:1.6 abandoned-netbsd-4-base:1.6 abandoned-netbsd-4:1.6.0.4 netbsd-3-1:1.5.0.6 netbsd-3-1-RELEASE:1.5 netbsd-3-0-2-RELEASE:1.5 netbsd-3-1-RC4:1.5 netbsd-3-1-RC3:1.5 netbsd-3-1-RC2:1.5 netbsd-3-1-RC1:1.5 netbsd-4:1.6.0.6 netbsd-4-base:1.6 chap-midi-nbase:1.6 netbsd-3-0-1-RELEASE:1.5 chap-midi:1.6.0.2 chap-midi-base:1.6 netbsd-3-0:1.5.0.4 netbsd-3-0-RELEASE:1.5 netbsd-3-0-RC6:1.5 netbsd-3-0-RC5:1.5 netbsd-3-0-RC4:1.5 netbsd-3-0-RC3:1.5 netbsd-3-0-RC2:1.5 netbsd-3-0-RC1:1.5 netbsd-2-0-3-RELEASE:1.2 netbsd-2-1:1.2.0.6 netbsd-2-1-RELEASE:1.2 netbsd-2-1-RC6:1.2 netbsd-2-1-RC5:1.2 netbsd-2-1-RC4:1.2 netbsd-2-1-RC3:1.2 netbsd-2-1-RC2:1.2 netbsd-2-1-RC1:1.2 netbsd-2-0-2-RELEASE:1.2 netbsd-3:1.5.0.2 netbsd-3-base:1.5 netbsd-2-0-1-RELEASE:1.2 netbsd-2:1.2.0.4 netbsd-2-base:1.2 netbsd-2-0-RELEASE:1.2 netbsd-2-0-RC5:1.2 netbsd-2-0-RC4:1.2 netbsd-2-0-RC3:1.2 netbsd-2-0-RC2:1.2 netbsd-2-0-RC1:1.2 netbsd-2-0:1.2.0.2 netbsd-2-0-base:1.2; locks; strict; comment @.\" @; 1.12 date 2020.04.26.00.40.10; author simonb; state Exp; branches; next 1.11; commitid VoteeegFFLmcuP5C; 1.11 date 2020.04.25.13.51.04; author wiz; state Exp; branches; next 1.10; commitid UrScvA9wvbyATL5C; 1.10 date 2020.04.25.10.56.53; author simonb; state Exp; branches; next 1.9; commitid QjYeTwPrTsFJVK5C; 1.9 date 2011.07.10.13.42.49; author apb; state Exp; branches; next 1.8; 1.8 date 2011.02.21.02.31.57; author itohy; state Exp; branches; next 1.7; 1.7 date 2008.04.30.13.10.57; author martin; state Exp; branches 1.7.16.1; next 1.6; 1.6 date 2005.10.05.06.29.03; author hubertf; state Exp; branches 1.6.20.1 1.6.22.1; next 1.5; 1.5 date 2004.04.19.10.00.16; author wiz; state Exp; branches; next 1.4; 1.4 date 2004.04.19.01.10.48; author lukem; state Exp; branches; next 1.3; 1.3 date 2004.04.19.00.30.42; author lukem; state Exp; branches; next 1.2; 1.2 date 2004.02.07.09.49.28; author wiz; state Exp; branches; next 1.1; 1.1 date 2004.02.07.04.48.31; author itohy; state Exp; branches; next ; 1.7.16.1 date 2011.03.05.15.09.26; author bouyer; state Exp; branches; next ; 1.6.20.1 date 2008.06.02.13.21.40; author mjf; state Exp; branches; next ; 1.6.22.1 date 2008.05.18.12.31.10; author yamt; state Exp; branches; next ; desc @@ 1.12 log @More path markup. Ref wizd(8). @ text @.\" $NetBSD: locate.conf.5,v 1.11 2020/04/25 13:51:04 wiz Exp $ .\" .\" Copyright (c) 2004 The NetBSD Foundation, Inc. .\" All rights reserved. .\" .\" This code is derived from software contributed to The NetBSD Foundation .\" by ITOH Yasufumi. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" .Dd April 25, 2020 .Dt LOCATE.CONF 5 .Os .Sh NAME .Nm locate.conf .Nd locate database configuration file .Sh DESCRIPTION The .Nm locate.conf file specifies the behavior of .Xr locate.updatedb 8 , which creates the .Xr locate 1 database. .Pp The .Nm file contains a list of newline separated records, each of which is composed of a keyword and arguments, which are separated by white space. Arguments with embedded shell metacharacters must be quoted in .Xr sh 1 style. Lines beginning with .Dq # are treated as comments and ignored. However, a .Dq # in the middle of a line does not start a comment. .Pp The configuration options are as follows: .Bl -tag -width XXXXXX .It Sy database Ar filename Specify the location of the .Xr locate 1 database to be created. .Pp Default: .Pa /var/db/locate.database .It Sy ignore Ar pattern ... Ignore files or directories. When building the database, do not descend into files or directories which match one of the specified patterns. The matched files or directories are not stored to the database. .Pp Default: Not specified. .It Sy ignorecontents Ar pattern ... Ignore contents of directories. When building the database, do not descend into files or directories which match one of the specified patterns. The matched files or directories themselves are stored to the database. .Pp Default: Not specified. .It Sy ignorefs Ar type ... Ignore file system by type, adding .Ar type to the default list. When building the database, do not descend into file systems which are of the specified .Ar type . The mount points are not stored to the database. If a .Dq \&! is prepended to .Ar type , the meaning is negated, that is, ignore file systems which do not have the type. As a special case, if .Dq none is specified for .Ar type , the .Sy ignorefs list is cleared and all file systems are traversed. .Pp .Ar type is used as an argument to .Xr find 1 .Fl fstype . The .Xr sysctl 8 command can be used to find out the types of file systems that are available on the system: .Bd -literal -offset indent sysctl vfs.generic.fstypes .Ed .Pp Default: !local cd9660 fdesc kernfs procfs .It Sy searchpath Ar directory ... Specify base directories to be put in the database. .Pp Default: .Pa / .It Sy workdir Ar directory Specify the working directory of locate.updatedb, in which a temporary file is placed. The temporary file is a list of all files, and you should specify a directory that has enough space to hold it. .Pp Default: .Pa /tmp .El .Pp Refer to .Xr find 1 for the details of .Ar pattern (see .Fl path expression) and .Ar type (see .Fl fstype expression). .Sh FILES .Bl -tag -width /usr/libexec/locate.updatedb -compact .It Pa /etc/locate.conf The file .Nm resides in .Pa /etc . .El .Sh SEE ALSO .Xr find 1 , .Xr locate 1 , .Xr locate.updatedb 8 , .Xr sysctl 8 .Sh HISTORY The .Nm file format first appeared in .Nx 2.0 . .Sh AUTHORS .An ITOH Yasufumi @ 1.11 log @Use more markup. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.10 2020/04/25 10:56:53 simonb Exp $ d124 2 a125 1 Default: / d132 2 a133 1 Default: /tmp @ 1.10 log @Document the "database" configuration option. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.9 2011/07/10 13:42:49 apb Exp $ d67 2 a68 1 Default: /var/db/locate.database @ 1.9 log @Allow quoting of embedded shell metacharacters in locate.conf(5). The shell_quote function here is identical to that in postinstall and etcupdate. This should fix PR 45130 from Greg Woods. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.8 2011/02/21 02:31:57 itohy Exp $ d30 1 a30 1 .Dd July 10, 2011 d62 6 @ 1.8 log @Cleanup my copyright notice. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.7 2008/04/30 13:10:57 martin Exp $ d30 1 a30 1 .Dd October 1, 2005 d50 3 d58 1 a58 1 in the middle of a line does not start comment. @ 1.7 log @Convert TNF licenses to new 2 clause variant @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.6 2005/10/05 06:29:03 hubertf Exp $ d155 1 a155 1 .An ITOH Yasufumi Aq itohy@@NetBSD.org @ 1.7.16.1 log @Sync with HEAD @ text @d1 1 a1 1 .\" $NetBSD$ d155 1 a155 1 .An ITOH Yasufumi @ 1.6 log @Add locate.updatedb(8). Discovered missing while sorting things out for BSDcertification.org. Ran through wizd(8). @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.5 2004/04/19 10:00:16 wiz Exp $ a16 7 .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the NetBSD .\" Foundation, Inc. and its contributors. .\" 4. Neither the name of The NetBSD Foundation nor the names of its .\" contributors may be used to endorse or promote products derived .\" from this software without specific prior written permission. @ 1.6.20.1 log @Sync with HEAD. @ text @d1 1 a1 1 .\" $NetBSD$ d17 7 @ 1.6.22.1 log @sync with head. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.6 2005/10/05 06:29:03 hubertf Exp $ d17 7 @ 1.5 log @Use Fl instead of Ic; remove duplicate Pp; filesystem -> file system. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.4 2004/04/19 01:10:48 lukem Exp $ d37 1 a37 1 .Dd April 19, 2004 d47 2 a48 2 .Pa /usr/libexec/locate.updatedb , which creates a149 3 .It Pa /usr/libexec/locate.updatedb Uses settings in .Nm locate.conf . d154 1 @ 1.4 log @"ignorefs type" now _appends_ to the existing (default) list. If the default list isn't wanted, use "ignorefs none" before other "ignorefs ..." entries. This makes "ignorefs ..." much more useful. Tweak the wording. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.3 2004/04/19 00:30:42 lukem Exp $ d83 1 a83 1 Ignore filesystem by type, d88 1 a88 1 do not descend into filesystems which are of the specified d96 1 a96 1 that is, ignore filesystems which do not have the type. d103 1 a103 1 list is cleared and all filesystems are traversed. d108 1 a108 1 .Ic -fstype . d111 1 a111 1 command can be used to find out the types of filesystems a116 1 .Pp @ 1.3 log @Note that 'ignorefs type' is used as an argument to 'find -fstype' and that "sysctl vfs.generic.fstypes" will list the available fstypes. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.2 2004/02/07 09:49:28 wiz Exp $ d68 1 a68 1 On building database, d76 1 a76 1 On building database, d83 6 a88 3 Ignore filesystem by type. On building database, do not descend into filesystems which have one of the specified d101 3 a103 1 the default rule is disabled and all filesystems are traversed. @ 1.2 log @Grammar fixes; uppercase start of sentence. @ text @d1 1 a1 1 .\" $NetBSD: locate.conf.5,v 1.1 2004/02/07 04:48:31 itohy Exp $ d37 1 a37 1 .Dd February 7, 2004 d100 13 d152 2 a153 1 .Xr locate 1 @ 1.1 log @File format description of /etc/locate.conf @ text @d1 1 a1 1 .\" $NetBSD$ d56 1 a56 1 which are separated by white spaces. d70 1 a70 1 which match to one of the specified patterns. d73 1 a73 1 default: Not specified. d78 1 a78 1 which match to one of the specified patterns. d81 1 a81 1 default: Not specified. d88 2 a89 2 If an .Dq ! d100 1 a100 1 default: !local cd9660 fdesc kernfs procfs d104 1 a104 1 default: / d111 1 a111 1 default: /tmp d134 1 a134 1 uses settings in @