diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-12-07 11:35:10 +0100 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-12-07 11:36:53 +0100 |
| commit | d4ee3a366faed3ba56bb05e45b0883495a61d719 (patch) | |
| tree | 40944280146fb6e142910698606e37a7f4d2cd80 /docs | |
| parent | 51799ddc1ea07223b030fe09170dd3bfff1e9138 (diff) | |
Improved lesana-search manpage
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/man/lesana-search.rst | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/source/man/lesana-search.rst b/docs/source/man/lesana-search.rst index 933431d..7478c6e 100644 --- a/docs/source/man/lesana-search.rst +++ b/docs/source/man/lesana-search.rst @@ -6,11 +6,24 @@ SYNOPSIS ======== lesana search [--help] [--collection COLLECTION] [--template TEMPLATE] \ -[--offset OFFSET] [--pagesize PAGESIZE] [--all] query [query ...] + [--offset OFFSET] [--pagesize PAGESIZE] [--all] \ + [--sort FIELD1 [--sort FIELD2 ...]] query [query ...] DESCRIPTION =========== +Lesana search allows to make searches in the collection and render the +results. + +The section :doc:`/user/search` in the full documentation describes +the query syntax in more detail; it is available online at +https://lesana.trueelena.org/user/search.html or it may be installed on +your system (e.g. in Debian and derivatives it will be at +``/usr/share/doc/lesana/html/user/search.html``). + +By default entries are printed according to the ``entry_label`` from the +``settings.yaml`` file, but they can be rendered according to a jinja2 +template. OPTIONS ======= @@ -27,4 +40,9 @@ OPTIONS . --all Return all available results +--sort + Sort the results by a sortable field. + + This option can be added multiple times; prefix the name of the field + with ``-`` to reverse the results (e.g. ``--sort='-date'``). |