aboutsummaryrefslogtreecommitdiff
path: root/docs/man/lesana-show.rst
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2019-09-29 18:11:43 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2019-09-29 18:11:43 +0200
commitda130078b4a654d8d17a2e606be4447cfdad44eb (patch)
tree1c3e7217cfc1d22269d1d1b0370f39c6b53a37eb /docs/man/lesana-show.rst
parent25890ee36217c4c9b152cf3c38603725f65edfac (diff)
Additional manpages
Diffstat (limited to 'docs/man/lesana-show.rst')
-rw-r--r--docs/man/lesana-show.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/man/lesana-show.rst b/docs/man/lesana-show.rst
new file mode 100644
index 0000000..516f9de
--- /dev/null
+++ b/docs/man/lesana-show.rst
@@ -0,0 +1,45 @@
+===========
+lesana-show
+===========
+
+-------------------
+show a lesana entry
+-------------------
+
+:Author: valhalla@trueelena.org
+:Manual section: 1
+
+SYNOPSIS
+========
+
+lesana show [--help] [--collection COLLECTION] [--template TEMPLATE] <entry>
+
+DESCRIPTION
+===========
+
+``lesana show`` will print an entry (specified by id or partial id) to
+stdout.
+
+A template can be specified with ``--template <template>`` to pretty
+print entries.
+
+OPTIONS
+=======
+
+-h, --help
+ Prints an help message and exits.
+--collection COLLECTION, -c COLLECTION
+ The collection to work on. Default is ``.``
+--template TEMPLATE, -t TEMPLATE
+ Use the specified template to display results.
+
+TEMPLATES
+=========
+
+The templates used by ``lesana show`` are jinja2 templates.
+
+The entry fields are available as variables, and the full entry is
+available as the variable ``entry`` and can be used to give access to
+fields with names that aren't valid jinja2 variables e.g. as
+``entry.data[<field-name>]``.
+