diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-03-25 19:51:02 +0100 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-03-25 19:51:02 +0100 |
| commit | b1eb9ffd97827b46cdd904763796758c2e091834 (patch) | |
| tree | 075eec38bf751ae2620f7d756d9c3a2bef6648ff /docs | |
| parent | e74398cda112543aa6f19ed615001976ee89536f (diff) | |
Document lesana get-values
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/man/index.rst | 1 | ||||
| -rw-r--r-- | docs/source/man/lesana-get-values.rst | 33 |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/man/index.rst b/docs/source/man/index.rst index 65d92a1..4f1b723 100644 --- a/docs/source/man/index.rst +++ b/docs/source/man/index.rst @@ -14,4 +14,5 @@ Man Pages lesana-rm lesana lesana-search + lesana-get-values lesana-show 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. |