From 42686f1f414fc5552f0fe60a104018d7b940b276 Mon Sep 17 00:00:00 2001 From: clerie Date: Sat, 14 Oct 2023 19:24:05 +0200 Subject: [PATCH] Document command line options --- docs/reference/command-line-options.md | 21 +++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs/reference/command-line-options.md diff --git a/docs/reference/command-line-options.md b/docs/reference/command-line-options.md new file mode 100644 index 0000000..3db5ab4 --- /dev/null +++ b/docs/reference/command-line-options.md @@ -0,0 +1,21 @@ +# Command line options + +## Config file path + +`-c`, `--config ` + +Specifies the path to [FieldPOC configuration file](configuration.md). +Of ommitted it looks for a file called `fieldpoc_config.json` in the current working directory. + +## Init + +`--init` + +Set up database. Run only once. + +## Debug + +`--debug` + +Sets log level to debug. +Logs to stdout. diff --git a/mkdocs.yml b/mkdocs.yml index 74bfdcf..9129dc0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,4 +14,5 @@ nav: - install/rfp.md - install/omm.md - Reference: + - reference/command-line-options.md - reference/configuration.md