locate/updatedb.1

   1 .TH UPDATEDB 1L \" -*- 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.
  19 .P
  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(1L).
  27 Databases can not be concatenated together.
  28 .P
  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 \-\-localpaths='\fIpath1 path2...\fP'
  45 Non-network directories to put in the database.
  46 Default is /.
  47 .TP
  48 .B \-\-netpaths='\fIpath1 path2...\fP'
  49 Network (NFS, AFS, RFS, etc.) directories to put in the database.
  50 Default is none.
  51 .TP
  52 .B \-\-prunepaths='\fIpath1 path2...\fP'
  53 Directories to not put in the database, which would otherwise be.
  54 Default is /tmp /usr/tmp /var/tmp /afs.
  55 .TP
  56 .B \-\-output=\fIdbfile\fP
  57 The database file to build.
  58 Default is system-dependent.  In Debian GNU/Linux, the default
  59 is /var/lib/locate/locatedb.
  60 .TP
  61 .B \-\-netuser=\fIuser\fP
  62 The user to search network directories as, using \fBsu\fP(1).
  63 Default is \fBdaemon\fP.
  64 .TP
  65 .B \-\-old\-format
  66 Create the database in the old format instead of the new one.
  67 .TP
  68 .B \-\-version
  69 Print the version number of
  70 .B updatedb
  71 and exit.
  72 .TP
  73 .I "\-\-help"
  74 Print a summary of the options to
  75 .B updatedb
  76 and exit.
  77 .SH "SEE ALSO"
  78 \fBfind\fP(1L), \fBlocate\fP(1L), \fBlocatedb\fP(5L), \fBxargs\fP(1L)
  79 \fBFinding Files\fP (on-line in Info, or printed)