summaryrefslogtreecommitdiff
path: root/docs/source/man/lesana-get-values.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/man/lesana-get-values.rst')
-rw-r--r--docs/source/man/lesana-get-values.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/source/man/lesana-get-values.rst b/docs/source/man/lesana-get-values.rst
new file mode 100644
index 0000000..095d242
--- /dev/null
+++ b/docs/source/man/lesana-get-values.rst
@@ -0,0 +1,33 @@
+=================
+lesana-get-values
+=================
+
+SYNOPSIS
+========
+
+lesana search [--help] [--collection COLLECTION] [--template TEMPLATE] \
+ --field FIELD [query [query ...]]
+
+DESCRIPTION
+===========
+
+Lesana get-values will list all values found in a field and the number
+of entries where that value has been found.
+
+A template can be specified to format the results.
+
+Extracting the values from a sortable field is significantly more
+efficient than doing so from a non-sortable field, but adding too many
+sortable fields can make general searches and indexing slower.
+
+OPTIONS
+=======
+
+-h, --help
+ Prints an help message and exits.
+--collection COLLECTION, -c COLLECTION
+ The collection to work on. Default is ``.``
+--template TEMPLATE, -t TEMPLATE
+ Template to use when displaying results
+--field
+ Name of the desired field.