diff options
author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:30:04 +0200 |
---|---|---|
committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:30:04 +0200 |
commit | ea9af6f5521c86a8529d75db91455e8982e1d77f (patch) | |
tree | cb21c405b0ca6d425a966660be5b02a0c3c97469 /docs/source/man/lesana-init.rst | |
parent | 5e045d665f5057d3111939c1fa13133e53d7fb8d (diff) | |
parent | e3e1aac99ff15ef99ac6d3fd8539492a2c4801be (diff) |
Merge branch 'master' into types
Diffstat (limited to 'docs/source/man/lesana-init.rst')
-rw-r--r-- | docs/source/man/lesana-init.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/source/man/lesana-init.rst b/docs/source/man/lesana-init.rst new file mode 100644 index 0000000..92527c0 --- /dev/null +++ b/docs/source/man/lesana-init.rst @@ -0,0 +1,40 @@ +=========== +lesana-init +=========== + +------------------------------ +initialize a lesana collection +------------------------------ + +:Author: valhalla@trueelena.org +:Manual section: 1 + +SYNOPSIS +======== + +lesana init [--help] [--collection <collection>] [--no-git] + +DESCRIPTION +=========== + +lesana init initializes a new lesana collection. + +It will create the directory (if it does not exist) and, unless +``--no-git`` is specified it will initialize it as a git repository and +create a ``.gitignore`` file with some relevant contents. + +It will then create a skeleton ``settings.yaml`` file and open it in an +editor to start configuring the collection. + +When leaving the editor, again unless ``--no-git`` is used, it will add +this file to the git staging area, but not commit it. + +OPTIONS +======= + +--help, -h + Prints an help message and exits. +--collection COLLECTION, -c COLLECTION + The directory where the collection will be initialized. Default is . +--no-git + Do not use git in the current collection. |