aboutsummaryrefslogtreecommitdiff
path: root/docs/man/lesana-show.rst
blob: 516f9de50228b666b00a8ee3a87ae0388705cacd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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>]``.