From bd1e1d2068a6610cf3ebbb85177c227656edebf2 Mon Sep 17 00:00:00 2001 From: Phyks Date: Wed, 14 Jun 2017 10:46:38 +0200 Subject: [PATCH] Update documentation Add a section about common arguments for all subcommands. Closes #56. --- doc/0.getting_started.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/0.getting_started.md b/doc/0.getting_started.md index 3f3b98f..cb329f4 100644 --- a/doc/0.getting_started.md +++ b/doc/0.getting_started.md @@ -42,6 +42,19 @@ The available commands are: in production. +### Common arguments + +You can pass some command-line arguments to Flatisfy commands, common to all the available commands. These are + +* `--help`/`-h` to get some help message about the current command. +* `--data-dir DIR` to overload the `data_directory` value from config. +* `--config CONFIG` to use the config file located at `CONFIG`. +* `--passes [0, 1, 2, 3]` to overload the `passes` value from config. +* `--max-entries N` to overload the `max_entries` value from config. +* `-v` to enable verbose output. +* `-vv` to enable debug output. + + ## Configuration List of configuration options: