<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="resource-type" content="document"> <link rel="stylesheet" href="../style.css" type="text/css" media="all"> <title> LOCATE.CONF(5)</title> </head> <body> <div class="mandoc"> <table summary="Document Header" class="head" width="100%"> <col width="30%"> <col width="30%"> <col width="30%"> <tbody> <tr> <td class="head-ltitle"> LOCATE.CONF(5)</td> <td class="head-vol" align="center"> File Formats Manual</td> <td class="head-rtitle" align="right"> LOCATE.CONF(5)</td> </tr> </tbody> </table> <div class="section"> <h1 id="x4e414d45">NAME</h1> <b class="name">locate.conf</b> — <span class="desc">locate database configuration file</span></div> <div class="section"> <h1 id="x4445534352495054494f4e">DESCRIPTION</h1> The <b class="name">locate.conf</b> file specifies the behavior of <a class="link-man" href="../html8/locate.updatedb.html">locate.updatedb(8)</a>, which creates the <a class="link-man" href="../html1/locate.html">locate(1)</a> database.<p> The <b class="name">locate.conf</b> 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 <a class="link-man" href="../html1/sh.html">sh(1)</a> style. Lines beginning with “#” are treated as comments and ignored. However, a “#” in the middle of a line does not start a comment.<p> The configuration options are as follows:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> <dt class="list-tag" style="margin-top: 1.00em;"> <span class="symb">ignore</span> <i class="arg">pattern ...</i></dt> <dd class="list-tag" style="margin-left: 6.00ex;"> 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.<p> Default: Not specified.</dd> <dt class="list-tag" style="margin-top: 1.00em;"> <span class="symb">ignorecontents</span> <i class="arg">pattern ...</i></dt> <dd class="list-tag" style="margin-left: 6.00ex;"> 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.<p> Default: Not specified.</dd> <dt class="list-tag" style="margin-top: 1.00em;"> <span class="symb">ignorefs</span> <i class="arg">type ...</i></dt> <dd class="list-tag" style="margin-left: 6.00ex;"> Ignore file system by type, adding <i class="arg">type</i> to the default list. When building the database, do not descend into file systems which are of the specified <i class="arg">type</i>. The mount points are not stored to the database. If a “!” is prepended to <i class="arg">type</i>, the meaning is negated, that is, ignore file systems which do not have the type. As a special case, if “none” is specified for <i class="arg">type</i>, the <span class="symb">ignorefs</span> list is cleared and all file systems are traversed.<p> <i class="arg">type</i> is used as an argument to <a class="link-man" href="../html1/find.html">find(1)</a> <b class="flag">-fstype</b>. The <a class="link-man" href="../html8/sysctl.html">sysctl(8)</a> command can be used to find out the types of file systems that are available on the system:<p> <pre style="margin-left: 5.00ex;" class="lit display"> sysctl vfs.generic.fstypes</pre> <p> Default: !local cd9660 fdesc kernfs procfs</dd> <dt class="list-tag" style="margin-top: 1.00em;"> <span class="symb">searchpath</span> <i class="arg">directory ...</i></dt> <dd class="list-tag" style="margin-left: 6.00ex;"> Specify base directories to be put in the database.<p> Default: /</dd> <dt class="list-tag" style="margin-top: 1.00em;"> <span class="symb">workdir</span> <i class="arg">directory</i></dt> <dd class="list-tag" style="margin-left: 6.00ex;"> 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.<p> Default: /tmp</dd> </dl> <p> Refer to <a class="link-man" href="../html1/find.html">find(1)</a> for the details of <i class="arg">pattern</i> (see <b class="flag">-path</b> expression) and <i class="arg">type</i> (see <b class="flag">-fstype</b> expression).</div> <div class="section"> <h1 id="x46494c4553">FILES</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> <dt class="list-tag" style="margin-top: 0.00em;"> <i class="file">/etc/locate.conf</i></dt> <dd class="list-tag" style="margin-left: 28.00ex;"> The file <b class="name">locate.conf</b> resides in <i class="file">/etc</i>.</dd> </dl> </div> <div class="section"> <h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man" href="../html1/find.html">find(1)</a>, <a class="link-man" href="../html1/locate.html">locate(1)</a>, <a class="link-man" href="../html8/locate.updatedb.html">locate.updatedb(8)</a>, <a class="link-man" href="../html8/sysctl.html">sysctl(8)</a></div> <div class="section"> <h1 id="x484953544f5259">HISTORY</h1> The <b class="name">locate.conf</b> file format first appeared in <span class="unix">NetBSD 2.0</span>.</div> <div class="section"> <h1 id="x415554484f5253">AUTHORS</h1> <span class="author">ITOH Yasufumi</span></div> <table summary="Document Footer" class="foot" width="100%"> <col width="50%"> <col width="50%"> <tbody> <tr> <td class="foot-date"> July 10, 2011</td> <td class="foot-os" align="right"> NetBSD 6.0</td> </tr> </tbody> </table> </div> </body> </html>