'\" t
.\"     Title: localsearch-3
.\"    Author: The LocalSearch developers
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/01/2026
.\"    Manual: LocalSearch manual
.\"    Source: \ \& 3.11.2
.\"  Language: English
.\"
.TH "LOCALSEARCH\-3" "1" "09/01/2026" "\ \& 3\&.11\&.2" "LocalSearch manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
localsearch-3 \- Filesystem indexer\&.
.SH "SYNOPSIS"
.sp
\fBlocalsearch\-3\fR [\fIOPTION\fR\&...]
.SH "DESCRIPTION"
.sp
\fBlocalsearch\-3\fR is not supposed to be run by the user since it is started by systemd when the user logs in\&. Of course, it can also be started manually for debugging purposes\&. You can not run more than one instance of this at the same time\&.
.sp
\fBlocalsearch\-3\fR mines information about applications and files only\&.
.SH "OPTIONS"
.PP
\fB\-?, \-\-help\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Returns the version of this binary\&.
.RE
.PP
\fB\-n, \-\-no\-daemon\fR
.RS 4
Tells the indexer to exit once all indexing has finished and the database is up to date\&. This is not the default mode of operation for the indexer, usually it stays around acting like a daemon to monitor file updates which may occur over time\&. This option renders the
\fB\-\-initial\-sleep\fR
option moot\&.
.RE
.PP
\fB\-e, \-\-eligible=FILE\fR
.RS 4
Checks if
\fBFILE\fR
is eligible for being mined based on the current configuration rules\&. In addition to this, it will check if
\fBFILE\fR
would be monitored for changes\&. This works with non\-existing
\fBFILE\fR
arguments as well as existing
\fBFILE\fR
arguments\&.
.RE
.SH "DESKTOP INTEGRATION"
.sp
Desktop environments that make use of localsearch\-3 should start the \fBlocalsearch\-3\&.service\fR user unit on startup\&. For instance, sessions managed by gnome\-session can add this service as a \fBWants=\fR dependency in their \fBgnome\-session@name\&.target\&.d/session\&.conf\fR drop\-in\&.
.sp
This allows sessions to disable background filesystem indexing (by simply not starting \fBlocalsearch\-3\&.service\fR) in situations where it\(cqs not necessary (i\&.e\&. special kiosk sessions)
.SH "SEE ALSO"
.sp
\fBlocalsearch\-info\fR(1)\&.