man-pages/man5/updatedb.conf.5.html
2021-03-31 01:06:50 +01:00

180 lines
4.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of updatedb.conf</TITLE>
</HEAD><BODY>
<H1>updatedb.conf</H1>
Section: File Formats (5)<BR>Updated: Jun 2008<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<P>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
/etc/updatedb.conf - a configuration file for <A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A>(8)
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>/etc/updatedb.conf</B>
is a text file.
Blank lines are ignored.
A
<B>#</B>
character outside of a quoted string starts a comment
extending until end of line.
<P>
Other lines must be of the following form:
<DL COMPACT><DT id="1"><DD>
<I>VARIABLE</I>
<B>=</B>
<B>&quot;</B><I>VALUE</I><B>&quot;</B>
</DL>
<P>
White space between tokens is ignored.
<I>VARIABLE</I>
is an alphanumeric string which does not start with a digit.
<I>VALUE</I>
can contain any character except for <B>&quot;</B>.
No escape mechanism is supported within
<I>VALUE</I>
and there is no way to write
<I>VALUE</I>
spanning more than one line.
<P>
Unknown
<I>VARIABLE</I>
values are considered an error.
The defined variables are:
<P>
<DL COMPACT>
<DT id="2"><B>PRUNEFS</B><DD>
A whitespace-separated list of file system types (as used in <B>/etc/mtab</B>)
which should not be scanned by
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8).
The file system type matching is case-insensitive. By default, no file system
types are skipped.
<P>
When scanning a file system is skipped,
all file systems mounted in the subtree are skipped too,
even if their type does not match any entry in <B>PRUNEFS</B>.
<P>
<DT id="3"><B>PRUNENAMES</B><DD>
A whitespace-separated list of directory names (without paths) which should not
be scanned by
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8).
By default, no directory names are skipped.
<P>
Note that only directories can be specified, and no pattern mechanism (e.g.
globbing) is used.
<P>
<DT id="4"><B>PRUNEPATHS</B><DD>
A whitespace-separated list of path names of directories which should not be
scanned by
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8).
Each path name must be exactly in the form
in which the directory would be reported by
<B><A HREF="/cgi-bin/man/man2html?1+locate">locate</A></B>(1).
<P>
By default, no paths are skipped.
<P>
<DT id="5"><B>PRUNE_BIND_MOUNTS</B><DD>
One of the strings <B>0</B>, <B>no</B>, <B>1</B> or <B>yes</B>.
If
<B>PRUNE_BIND_MOUNTS</B>
is <B>1</B> or <B>yes</B>,
bind mounts are not scanned by
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8).
All file systems mounted in the subtree of a bind mount are skipped as well,
even if they are not bind mounts.
As an exception, bind mounts of a directory on itself are not skipped.
<P>
By default, bind mounts are not skipped.
<P>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>NOTES</H2>
When a directory is matched by <B>PRUNEFS</B>, <B>PRUNENAMES</B> or
<B>PRUNEPATHS</B>,
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8)
does not scan the contents of the directory.
The path of the directory itself is, however, entered in the created database.
For example, if
<I>/tmp</I>
is in <B>PRUNEPATHS</B>,
<B><A HREF="/cgi-bin/man/man2html?1+locate">locate</A></B>(1)
will not show any files stored in <I>/tmp</I>,
but it can show the
<I>/tmp</I>
directory.
This behavior differs from traditional
<B>locate</B>
implementations.
<P>
In some
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8)
implementations <B>PRUNEPATHS</B> can be used to exclude non-directory files.
This is not the case in this implementation.
<P>
<B>/etc/updatedb.conf</B>
is a shell script in some implementations,
which allows much more flexibility in defining the variables.
Equivalent functionality can be achieved by using the command-line options
to
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8).
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>AUTHOR</H2>
Miloslav Trmac &lt;<A HREF="mailto:mitr@redhat.com">mitr@redhat.com</A>&gt;
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+locate">locate</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?8+updatedb">updatedb</A></B>(8)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="6"><A HREF="#lbAB">NAME</A><DD>
<DT id="7"><A HREF="#lbAC">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAD">NOTES</A><DD>
<DT id="9"><A HREF="#lbAE">AUTHOR</A><DD>
<DT id="10"><A HREF="#lbAF">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:06 GMT, March 31, 2021
</BODY>
</HTML>