From 332ee6db6ca2c8514320c2dd3a5288fa302b0c06 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Fri, 13 Oct 2017 15:16:59 -0300 Subject: [PATCH] Bug 19462: Add koha-elasticsearch documentation Signed-off-by: Tomas Cohen Arazi Signed-off-by: Mark Tompsett Signed-off-by: Nick Clemens --- debian/docs/koha-common.xml | 12 +++++ debian/docs/koha-elasticsearch.xml | 100 +++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 debian/docs/koha-elasticsearch.xml diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml index 2790341..f14f750 100644 --- a/debian/docs/koha-common.xml +++ b/debian/docs/koha-common.xml @@ -155,6 +155,18 @@ + + Elasticsearch-related + + + + + Manage Elasticsearch-related tasks for Koha instances. + + + + + E-mail diff --git a/debian/docs/koha-elasticsearch.xml b/debian/docs/koha-elasticsearch.xml new file mode 100644 index 0000000..8b25087 --- /dev/null +++ b/debian/docs/koha-elasticsearch.xml @@ -0,0 +1,100 @@ +
+koha-elasticsearch + +Koha is the first free software library automation package. + + The Koha Community + http://koha-community.org/ + + + + + + + koha-elasticsearch + 8 + + + + koha-elasticsearch + Manage Elasticsearch-related tasks for Koha instances. + UNIX/Linux + + + Description + Provides Elasticsearch-related tasks for Koha instances. An action needs to + be passed. + + + + + + koha-elasticsearch --rebuild + -b|--biblios + -a|--authorities + -v|--verbose + -c n|--commit n + -v|--verbose + instancename + + + + Actions + + + + + Makes koha-elasticsearch rebuild Elasticsearch indexes based on the parameters. + By default it rebuilds both authority and bibliographic records. This behaviour can be controlled + with the and parameters. + + + + + + + Options + + + + + In conjunction with , it triggers authority record reindexing. + + + + + + In conjunction with it triggers bibliographic record reindexing. + + + + + + Specifies how many records will be batched up before they are added to Elasticsearch (default: 5000). + Higher values lead to better performance, but take more RAM. + + + + + + Be verbose. Useful for debugging indexing problems. + + + + + + Display usage information. + + + + + + See also + + koha-rebuild-zebra(8) + + + + + +
-- 2.1.4