aboutsummaryrefslogtreecommitdiff
path: root/docs/source/man/lesana-edit.rst
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:30:04 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:30:04 +0200
commitea9af6f5521c86a8529d75db91455e8982e1d77f (patch)
treecb21c405b0ca6d425a966660be5b02a0c3c97469 /docs/source/man/lesana-edit.rst
parent5e045d665f5057d3111939c1fa13133e53d7fb8d (diff)
parente3e1aac99ff15ef99ac6d3fd8539492a2c4801be (diff)
Merge branch 'master' into types
Diffstat (limited to 'docs/source/man/lesana-edit.rst')
-rw-r--r--docs/source/man/lesana-edit.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/source/man/lesana-edit.rst b/docs/source/man/lesana-edit.rst
new file mode 100644
index 0000000..75bcaeb
--- /dev/null
+++ b/docs/source/man/lesana-edit.rst
@@ -0,0 +1,35 @@
+===========
+lesana-edit
+===========
+
+------------------------------
+edits an existing lesana entry
+------------------------------
+
+:Author: valhalla@trueelena.org
+:Manual section: 1
+
+SYNOPSIS
+========
+
+lesana edit [--help] [--collection <collection>] [--no-git] <entry>
+
+DESCRIPTION
+===========
+
+Lesana edit will open an existing entry (specified by id or partial id)
+in an editor, so that it can be changed.
+
+If the collection is configured to use git, after the editor has been
+closed, it will add the file to the git staging area, unless
+``--no-git`` is given.
+
+OPTIONS
+=======
+
+-h, --help
+ Prints an help message and exits.
+--collection COLLECTION, -c COLLECTION
+ The collection to work on. Default is ``.``
+--no-git
+ Don't add the new entry to git.