#  Copyright (C) 2007  Stanislav Sinyagin
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

# $Id: torrus_buildsearchdb.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
# Stanislav Sinyagin <ssinyagin@yahoo.com>
#
#

=head1 NAME

buildsearchdb - Build the search database

=head1 SYNOPSIS

B<torrus buildsearchdb> I<options...>

=head1 DESCRIPTION

This command indexes the Torrus configuration objects and builds the
search index database. One of the three options B<--tree>, B<--all> or
B<--global> is required.

=head1 OPTIONS

=over 4

=item B<--tree>=I<TREE>

Build the indexes for a given tree.

=item B<--all>

Builds the tree indexes for all trees.

=item B<--global>

Builds the global index for all trees and also the tree indexes for every
tree. In order to use the global search database, the web user
should have the permission to display all trees and also it should have
the permission for GlobalSearch for all trees, for example:

   torrus acledit --addgroup=staff --permit=GlobalSearch --for='*'


=item B<--verbose>

Prints extra information

=item B<--help>

Displays a help message.

=back

=head1 SEE ALSO

L<torrus(@mansec_usercmd@)>

=head1 NOTES

See more documentation at Torrus home page: http://torrus.org

=head1 AUTHOR

Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>