1 .\" A man page for updatedb(8). -*- nroff -*-
3 .\" Copyright (C) 2005, 2007, 2008 Red Hat, Inc. All rights reserved.
5 .\" This copyrighted material is made available to anyone wishing to use,
6 .\" modify, copy, or redistribute it subject to the terms and conditions of the
7 .\" GNU General Public License v.2.
9 .\" This program is distributed in the hope that it will be useful, but WITHOUT
10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 .\" You should have received a copy of the GNU General Public License along
15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
16 .\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 .\" Author: Miloslav Trmac <mitr@redhat.com>
19 .TH updatedb 8 "Dec 2020" plocate
22 updatedb \- update a database for plocate
26 \fBupdatedb\fR [\fIOPTION\fR]...
30 creates or updates a database used by
32 If the database already exists,
34 to avoid rereading directories that have not changed.
37 is usually run daily from a
39 to update the default database.
43 returns with exit status 0 on success, 1 on error.
46 The \fBPRUNE_BIND_MOUNTS\fR, \fBPRUNEFS\fR,
50 variables, which are modified by some of the options, are documented in detail
52 .BR updatedb.conf (5).
55 \fB\-f\fR, \fB\-\-add-prunefs\fB \fIFS\fR
56 Add entries in white-space-separated list \fIFS\fR to \fBPRUNEFS\fR.
59 \fB\-n\fR, \fB\-\-add-prunenames\fB \fINAMES\fR
60 Add entries in white-space-separated list \fINAMES\fR to \fBPRUNENAMES\fR.
63 \fB\-e\fR, \fB\-\-add-prunepaths\fB \fIPATHS\fR
64 Add entries in white-space-separated list \fIPATHS\fR to \fBPRUNEPATHS\fR.
67 \fB\-\-add-single-prunepath\fB \fIPATH\fR
68 Add \fIPATH\fR to \fBPRUNEPATHS\fR. Note that this is currently the only way
69 to add a path with a space in it.
72 \fB\-U\fR, \fB\-\-database\-root\fR \fIPATH\fR
73 Store only results of scanning the file system subtree rooted at \fIPATH\fR to
74 the generated database.
75 The whole file system is scanned by default.
78 outputs entries as absolute path names which don't contain symbolic links,
79 regardless of the form of \fIPATH\fR.
82 \fB\-\-debug\-pruning\fR
83 Write debugging information about pruning decisions to standard error output.
86 \fB\-h\fR, \fB\-\-help\fR
87 Write a summary of the available options to standard output
88 and exit successfully.
91 \fB\-o\fR, \fB\-\-output\fR \fIFILE\fR
94 instead of using the default database.
97 \fB\-\-prune\-bind\-mounts\fR \fIFLAG\fR
100 to \fIFLAG\fR, overriding the configuration file.
103 \fB\-\-prunefs\fR \fIFS\fR
104 Set \fBPRUNEFS\fR to \fIFS\fR, overriding the configuration file.
107 \fB\-\-prunenames\fR \fINAMES\fR
108 Set \fBPRUNENAMES\fR to \fINAMES\fR, overriding the configuration file.
111 \fB\-\-prunepaths\fR \fIPATHS\fR
112 Set \fBPRUNEPATHS\fR to \fIPATHS\fR, overriding the configuration file.
115 \fB\-l\fR, \fB\-\-require\-visibility\fR \fIFLAG\fR
116 Set the \*(lqrequire file visibility before reporting it\*(rq flag in the
117 generated database to \fIFLAG\fR.
124 or if the database file is readable by "others"
125 or it is not owned by \fB@groupname@\fR,
127 outputs the database entries even if the user running
129 could not have read the directory necessary to find out the file described
130 by the database entry.
140 checks the permissions of parent directories of each entry
141 before reporting it to the invoking user.
142 To make the file existence truly hidden from other users, the database
145 and the database permissions prohibit reading the database by users using
148 which is set-gid \fB@groupname@\fR.
150 Note that the visibility flag is checked only if the database is owned by
152 and it is not readable by "others".
155 \fB\-v\fR, \fB\-\-verbose\fR
156 Output path names of files to standard output, as soon as they are found.
159 \fB\-V\fR, \fB\-\-version\fR
160 Write information about the version and license of
162 on standard output and exit successfully.
165 To create a private plocate database as a user other than \fBroot\fR,
173 Note that all users that can read
175 can get the complete list of files in the subtree of \fIsource_directory\fR.
179 \fB@updatedb_conf@\fR
180 A configuration file. See
181 .BR updatedb.conf (5).
182 Uses exactly the same format as the one used by
184 updatedb, so they can be shared.
188 The database updated by default.
192 .B \-\-require\-visibility no
193 allow users to find names of files and directories of other users,
194 which they would not otherwise be able to do.
197 Miloslav Trmac <mitr@redhat.com>
199 Steinar H. Gunderson <steinar+plocate@gunderson.no>
203 .BR updatedb.conf (5)