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\-U\fR, \fB\-\-database\-root\fR \fIPATH\fR
68 Store only results of scanning the file system subtree rooted at \fIPATH\fR to
69 the generated database.
70 The whole file system is scanned by default.
73 outputs entries as absolute path names which don't contain symbolic links,
74 regardless of the form of \fIPATH\fR.
77 \fB\-\-debug\-pruning\fR
78 Write debugging information about pruning decisions to standard error output.
81 \fB\-h\fR, \fB\-\-help\fR
82 Write a summary of the available options to standard output
83 and exit successfully.
86 \fB\-o\fR, \fB\-\-output\fR \fIFILE\fR
89 instead of using the default database.
92 \fB\-\-prune\-bind\-mounts\fR \fIFLAG\fR
95 to \fIFLAG\fR, overriding the configuration file.
98 \fB\-\-prunefs\fR \fIFS\fR
99 Set \fBPRUNEFS\fR to \fIFS\fR, overriding the configuration file.
102 \fB\-\-prunenames\fR \fINAMES\fR
103 Set \fBPRUNENAMES\fR to \fINAMES\fR, overriding the configuration file.
106 \fB\-\-prunepaths\fR \fIPATHS\fR
107 Set \fBPRUNEPATHS\fR to \fIPATHS\fR, overriding the configuration file.
110 \fB\-l\fR, \fB\-\-require\-visibility\fR \fIFLAG\fR
111 Set the \*(lqrequire file visibility before reporting it\*(rq flag in the
112 generated database to \fIFLAG\fR.
119 or if the database file is readable by "others"
120 or it is not owned by \fB@groupname@\fR,
122 outputs the database entries even if the user running
124 could not have read the directory necessary to find out the file described
125 by the database entry.
135 checks the permissions of parent directories of each entry
136 before reporting it to the invoking user.
137 To make the file existence truly hidden from other users, the database
140 and the database permissions prohibit reading the database by users using
143 which is set-gid \fB@groupname@\fR.
145 Note that the visibility flag is checked only if the database is owned by
147 and it is not readable by "others".
150 \fB\-v\fR, \fB\-\-verbose\fR
151 Output path names of files to standard output, as soon as they are found.
154 \fB\-V\fR, \fB\-\-version\fR
155 Write information about the version and license of
157 on standard output and exit successfully.
160 To create a private plocate database as an user other than \fBroot\fR,
168 Note that all users that can read
170 can get the complete list of files in the subtree of \fIsource_directory\fR.
174 \fB@updatedb_conf@\fR
175 A configuration file. See
176 .BR updatedb.conf (5).
180 The database updated by default. Uses exactly the same format
183 updatedb, so they can be shared.
187 .B \-\-require\-visibility no
188 allow users to find names of files and directories of other users,
189 which they would not otherwise be able to do.
192 Miloslav Trmac <mitr@redhat.com>
194 Steinar H. Gunderson <steinar+plocate@gunderson.no>
198 .BR updatedb.conf (5)