'\" t
.\"     Title: localsearch
.\"    Author: The LocalSearch developers
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 12/10/2025
.\"    Manual: LocalSearch manual
.\"    Source: \ \& 3.10.2
.\"  Language: English
.\"
.TH "LOCALSEARCH" "1" "12/10/2025" "\ \& 3\&.10\&.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 \- Control and query the LocalSearch indexer
.SH "SYNOPSIS"
.sp
.nf
localsearch COMMAND
.fi
.SH "DESCRIPTION"
.sp
The LocalSearch indexer is a background service\&. This command line utility allows controlling it as well as querying its state or searching for specific data\&.
.SH "COMMANDS"
.PP
\fBhelp\fR
.RS 4
Show help on subcommands\&.
.RE
.PP
\fBextract\fR
.RS 4
Extract metadata from a file\&.
.RE
.PP
\fBindex\fR
.RS 4
List and change indexed folders\&.
.RE
.PP
\fBinfo\fR
.RS 4
Retrieve information available for files and resources\&.
.RE
.PP
\fBinhibit\fR
.RS 4
Inhibit indexing temporarily\&.
.RE
.PP
\fBreset\fR
.RS 4
Erase the indexed data\&.
.RE
.PP
\fBsearch\fR
.RS 4
Search for content\&.
.RE
.PP
\fBstatus\fR
.RS 4
Provide status and statistics on the data indexed\&.
.RE
.PP
\fBtag\fR
.RS 4
Add, remove and list tags\&.
.RE
.PP
\fBtest\-sandbox\fR
.RS 4
Sandbox for a testing environment\&.
.RE