locate command in Linux is used to find the files by name. There is two most widely used file searching utilities accessible to users are called find and locate. The locate utility works better and faster than find command counterpart because instead of searching the file system when a file search is initiated, it would look through a database. This database contains bits and parts of files and their corresponding paths on your system. By default, locate command does not check whether the files found in the database still exist and it never reports files created after the most recent update of the relevant database.
locate [OPTION]... PATTERN...
Exit Status: This command will exit with status 0 if any specified match found. If no match founds or a fatal error encountered, then it will exit with status 1.
- -b, –basename : Match only the base name against the specified patterns, which is the opposite of –wholename.
- -c, –count : Instead of writing file names on standard output, write the number of matching entries only.
- -d, –database DBPATH : Replace the default database with DBPATH. DBPATH is a
: (colon)separated list of database file names. If more than one –database option is specified, the resulting path is a concatenation of the separate paths. An empty database file name is replaced by the default database. A database file name – refers to the standard input. Note that a database can be read from the standard input only once.
- -e, –existing : Print only entries that refer to files existing at the time locate is run.
- -L, –follow : When checking whether files exist (if the –existing option is specified), follow trailing symbolic links. This causes bro ken symbolic links to be omitted from the output. This option is the default behavior. The opposite can be specified using –nofollow.
- -h, –help : Write a summary of the available options to standard output and exit successfully.
- -i, –ignore-case : Ignore case distinctions when matching patterns.
- -l, –limit, -n LIMIT : Exit successfully after finding LIMIT entries. If the –count option is specified, the resulting count is also limited to LIMIT.
- -m, –mmap : Ignored, but included for compatibility with BSD and GNU locate.
- -P, –nofollow, -H : When checking whether files exist (if the –existing option is specified), do not follow trailing symbolic links. This causes broken symbolic links to be reported like other files.
This option is the opposite of –follow.
- -0, –null : Separate the entries on output using the ASCII NUL character instead of writing each entry on a separate line. This option is designed for interoperability with the –null option of GNU xargs.
- -S, –statistics : Write statistics about each read database to standard output instead of searching for files and exit successfully.
- -q, –quiet : Write no messages about errors encountered while reading and processing databases.
- -r, –regexp REGEXP : Search for a basic regexp REGEXP. No PATTERNs are allowed if this option is used, but this option can be specified multiple times.
- –regex : Interpret all PATTERNs as extended regexps.
- -s, –stdio : Ignored, for compatibility with BSD and GNU locate.
- -V, –version : Write information about the version and license of locate on standard output and exit successfully.
- -w, –wholename : Match only the whole path name against the specified patterns. This option is the default behavior. The opposite can be specified using –basename.
Example 1: Search a file with specific name.
$ locate sample.txt
It will search for sample.txt in particular directory.
Example 2: Limit Search Queries to a Specific Number.
$ locate "*.html" -n 20
It will show 20 results for the searching of file ending with .html.
Example 3. Display The Number of Matching Entries.
$ locate -c [.txt]*
It will count files ending with .txt.
Example 4: Ignore Case Sensitive Locate Outputs. This command is configured to process queries in a case sensitive manner. It means SAMPLE.TXT will show a different result than sample.txt.
$ locate -i *SAMPLE.txt*
Example 5: Separate Output Entries Without New Line.
$ locate -i -0 *sample.txt*
Default separator for locate command is the newline (\\n) character. But if someone want to use a different separator like the ASCII NUL, the he/she can do so using the -0 command line option.