torrus/doc/manpages/torrus_buildsearchdb.pod.in

   1 #  Copyright (C) 2007  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: torrus_buildsearchdb.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 buildsearchdb - Build the search database
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus buildsearchdb> I<options...>
  29
  30 =head1 DESCRIPTION
  31
  32 This command indexes the Torrus configuration objects and builds the
  33 search index database. One of the three options B<--tree>, B<--all> or
  34 B<--global> is required.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<--tree>=I<TREE>
  41
  42 Build the indexes for a given tree.
  43
  44 =item B<--all>
  45
  46 Builds the tree indexes for all trees.
  47
  48 =item B<--global>
  49
  50 Builds the global index for all trees and also the tree indexes for every
  51 tree. In order to use the global search database, the web user
  52 should have the permission to display all trees and also it should have
  53 the permission for GlobalSearch for all trees, for example:
  54
  55    torrus acledit --addgroup=staff --permit=GlobalSearch --for='*'
  56
  57
  58 =item B<--verbose>
  59
  60 Prints extra information
  61
  62 =item B<--help>
  63
  64 Displays a help message.
  65
  66 =back
  67
  68 =head1 SEE ALSO
  69
  70 L<torrus(@mansec_usercmd@)>
  71
  72 =head1 NOTES
  73
  74 See more documentation at Torrus home page: http://torrus.org
  75
  76 =head1 AUTHOR
  77
  78 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>
  79