diff options
author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2019-09-22 18:24:46 +0200 |
---|---|---|
committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2019-09-22 18:24:46 +0200 |
commit | 84e971f34cd2d1054a38fdd33b8723553a6ad227 (patch) | |
tree | 4815f1e93970fb26aaad72dd96048aa2644db261 /docs/man/lesana-init.rst | |
parent | 4a38a4839890b6cb45ccaee63829b815383c6f20 (diff) |
Start writing manpages for lesana and its subcommands
Diffstat (limited to 'docs/man/lesana-init.rst')
-rw-r--r-- | docs/man/lesana-init.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/man/lesana-init.rst b/docs/man/lesana-init.rst new file mode 100644 index 0000000..92527c0 --- /dev/null +++ b/docs/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. |