Indicate that "cd /; find tmp -wholename /tmp" will never match anything.
[findutils.git] / locate / updatedb.1
blobea6ca30b23ecb0f70e788b5f1b66ade46a6f7936
1 .TH UPDATEDB 1 \" -*- nroff -*-
2 .SH NAME
3 updatedb \- update a file name database
4 .SH SYNOPSIS
5 .B updatedb [\fIoptions\fP]
6 .SH DESCRIPTION
7 This manual page
8 documents the GNU version of
9 .BR updatedb ,
10 which updates file name databases used by GNU
11 .BR locate .
12 The file name databases contain lists of files that were in
13 particular directory trees when the databases were last updated.
14 The file name of the default database is determined when \fBlocate\fP
15 and \fBupdatedb\fP are configured and installed.  The frequency with
16 which the databases are updated and the directories for which they
17 contain entries depend on how often \fBupdatedb\fP is run, and with
18 which arguments.
20 In networked environments, it often makes sense to build a database at
21 the root of each filesystem, containing the entries for that filesystem.
22 .B updatedb
23 is then run for each filesystem on the fileserver where that
24 filesystem is on a local disk, to prevent thrashing the network.
25 Users can select which databases \fBlocate\fP searches using an
26 environment variable or command line option; see \fBlocate\fP(1).
27 Databases can not be concatenated together.
29 The file name database format changed starting with GNU
30 .B find
31 and
32 .B locate
33 version 4.0 to allow machines with diffent byte orderings to share
34 the databases.  The new GNU
35 .B locate
36 can read both the old and new database formats.
37 However, old versions of
38 .B locate
39 and
40 .B find
41 produce incorrect results if given a new-format database.
42 .SH OPTIONS
43 .TP
44 .B \-\-findoptions='\fI\-option1 \-option2...\fP'
45 Global options to pass on to \fBfind\fP.
46 The environment variable \fBFINDOPTIONS\fP also sets this value.
47 Default is none.
48 .TP
49 .B \-\-localpaths='\fIpath1 path2...\fP'
50 Non-network directories to put in the database.
51 Default is /.
52 .TP
53 .B \-\-netpaths='\fIpath1 path2...\fP'
54 Network (NFS, AFS, RFS, etc.) directories to put in the database.
55 The environment variable \fBNETPATHS\fP also sets this value.
56 Default is none.
57 .TP
58 .B \-\-prunepaths='\fIpath1 path2...\fP'
59 Directories to not put in the database, which would otherwise be.
60 The environment variable \fBPRUNEPATHS\fP also sets this value.
61 Default is /tmp /usr/tmp /var/tmp /afs.
62 .TP
63 .B \-\-prunefs='\fIpath...\fP'
64 File systems to not put in the database, which would otherwise be.
65 Note that files are pruned when a file system is reached;
66 Any file system mounted under an undesired file system will be
67 ignored.
68 The environment variable
69 \fBPRUNEFS\fP also sets this value.
70 Default is \fInfs NFS proc\fP.
71 .TP
72 .B \-\-output=\fIdbfile\fP
73 The database file to build.
74 Default is system-dependent.  In Debian GNU/Linux, the default
75 is /var/cache/locate/locatedb.
76 .TP
77 .B \-\-localuser=\fIuser\fP
78 The user to search non-network directories as, using \fBsu\fP(1).
79 Default is to search the non-network directories as the current user.
80 You can also use the environment variable \fBLOCALUSER\fP to set this user.
81 .TP
82 .B \-\-netuser=\fIuser\fP
83 The user to search network directories as, using \fBsu\fP(1).
84 Default is \fBdaemon\fP.
85 You can also use the environment variable \fBNETUSER\fP to set this user.
86 .TP
87 .B \-\-old\-format
88 Create the database in the old format instead of the new one.
89 .TP
90 .B \-\-version
91 Print the version number of
92 .B updatedb
93 and exit.
94 .TP
95 .I "\-\-help"
96 Print a summary of the options to
97 .B updatedb
98 and exit.
99 .SH "SEE ALSO"
100 \fBfind\fP(1), \fBlocate\fP(1), \fBlocatedb\fP(5), \fBxargs\fP(1)
101 \fBFinding Files\fP (on-line in Info, or printed)
102 .SH "BUGS"
104 The 
105 .B updatedb
106 program correctly handles filenames containing newlines,
107 but only if the system's sort command has a working
108 .I \-z
109 option.  If you suspect that 
110 .B locate
111 may need to return filenames containing newlines, consider using its
112 .I \-\-null 
113 option.
115 The best way to report a bug is to use the form at
116 http://savannah.gnu.org/bugs/?group=findutils.  
117 The reason for this is that you will then be able to track progress in
118 fixing the problem.   Other comments about \fBupdatedb\fP(1) and about
119 the findutils package in general can be sent to the 
120 .I bug-findutils
121 mailing list.  To join the list, send email to 
122 .IR bug-findutils-request@gnu.org .