Bug 11081: Port Koha::Contrib::Tamil indexer into Koha code base
[koha.git] / misc / bin / koha-index
1 #!/usr/bin/perl
2
3 package Main;
4
5 use Modern::Perl;
6 use utf8;
7 use Koha::Indexer::Indexing;
8 use Pod::Usage;
9
10 my $indexer = Koha::Indexer::Indexing->new_with_options();
11 if ( $indexer->help ) {
12     pod2usage( -verbose => 99 );
13     exit;
14 }
15 $indexer->run();
16
17
18 __END__
19
20 =pod
21
22 =head1 SYNOPSIS
23
24  koha-index
25
26  koha-index --verbose
27
28  koha-index --source biblio --select queue
29
30  koha-index --source authority --select all
31
32  koha-index --select queue --directory /tmp/koha-index-mylib --keep
33
34 =head1 DESCRIPTION
35
36 Index queued biblio/autority record, or reindex the whole DB. Koha standard
37 environment variables must ne set appropriately: KOHA_CONF and PERL5LIB.
38
39 =head1 OPTIONS
40
41 =over
42
43 =item --source
44
45 Select records to be indexed: C<biblio> or C<authority>. If not specified,
46 biblio by default.
47
48 =item --select
49
50 Select record to be indexed: C<all> or C<queue>. If not specified, C<all> is
51 selected. If C<all> is selected, zebra database is reset before indexing.
52
53 =item --directory
54
55 Directory where records to be indexed by Zebra are exported. If not specified,
56 a direcory named C<koha-index> is used, and if necessary created, in the
57 current directory. In this directory, sub-directories are created containing
58 records to be updated or deleted by Zebra. If those subdirectories already
59 exist, they are first emptied. The export directory tree is kept after zebra
60 indexing.
61
62 =item --keep
63
64 Keep the directory, and its content, where biblio/authority records have been
65 exported.
66
67 =item --verbose
68
69 Increase the amount of logging. Normally only warnings and errors from the
70 indexing are shown.
71
72 =back
73
74 =head1 SEE ALSO
75
76 =for :list
77 * L<koha-index-daemon>
78
79 =cut