diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:27:30 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:27:30 +0200 |
| commit | e3e1aac99ff15ef99ac6d3fd8539492a2c4801be (patch) | |
| tree | 58cb81587c68c02e54d90eb8d3851134c75c16ed /docs/man/lesana.rst | |
| parent | 92fdc8343afaafea0e705078ed7f0933cf475715 (diff) | |
Start building manpages with sphinx
Diffstat (limited to 'docs/man/lesana.rst')
| -rw-r--r-- | docs/man/lesana.rst | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/docs/man/lesana.rst b/docs/man/lesana.rst deleted file mode 100644 index 0d60e4f..0000000 --- a/docs/man/lesana.rst +++ /dev/null @@ -1,76 +0,0 @@ -====== -lesana -====== - ------------------------------- -manages collection inventories ------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana [--help] <command> - -DESCRIPTION -=========== - -lesana is a tool to organize collections of various kinds. It is -designed to have a data storage / serialization format that is friendly -to git and other VCSs, but decent performances. - -To reach this aim it uses yaml_ as its serialization format, which is -easy to store in a VCS, share between people and syncronize between -different computers, but it also keeps an index of this data in a local -xapian_ database in order to allow for fast searches. - -.. _yaml: http://yaml.org/ -.. _xapian: https://xapian.org/ - -lesana supports collections of any kind, as long as their entries can be -described with a mostly flat dictionary of fields of the types described -in the documentation file ``field_types``. - -Some example collection schemas are provided, but one big strenght of -lesana is the ability to customize your collection with custom fields -either by simply writing a personalized ``settings.yaml``. - -OPTIONS -======= - --h, --help - Prints an help message and exits. - -COMMANDS -======== - -new(1) - Creates a new entry. -edit(1) - Edits an existing entry. -show(1) - Shows an existing entry. -index(1) - Index some entries in the xapian cache. -search(1) - Searches for entries in the xapian cache. -export(1) - Exports entries from one lesana collection to another -init(1) - Initialize a new lesana collection -rm(1) - Removes an entry. - -TEXT EDITOR -=========== - -Many lesana subcommands will try to open files in a text editor choosen -as follows: - -* first, the value of $EDITOR is tried -* then the command ``sensible-editor``, as available under e.g. Debian - and its derivatives -* lastly, it will try to fallback to ``vi``, which should be available - under any posix system. |