aboutsummaryrefslogtreecommitdiff
path: root/doc/Usage/CommandLine.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-09-19 23:35:43 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-09-19 23:35:43 +0200
commit2c20acb1981fc8fbd884dbece2a1115ca37732d2 (patch)
treecafd753960b509f1c572448aaf7591a4ddb2dce8 /doc/Usage/CommandLine.md
parentclang-format pass (diff)
downloadsmolbote-2c20acb1981fc8fbd884dbece2a1115ca37732d2.tar.xz
Update documentation
Diffstat (limited to 'doc/Usage/CommandLine.md')
-rw-r--r--doc/Usage/CommandLine.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/Usage/CommandLine.md b/doc/Usage/CommandLine.md
new file mode 100644
index 0000000..1c532ce
--- /dev/null
+++ b/doc/Usage/CommandLine.md
@@ -0,0 +1,12 @@
+## Command-line options
+
+### General
+* `-h`, `--help`: Display this help.
+* `-v`, `--version`: Display version information.
+* `--build`: Display build branch and commit.
+* `-c`, `--config`: Set configuration file.
+* `--no-remote`: Don't check for other instances when starting.
+
+### Tweaking configuration
+You can overwrite options at runtime using the option path as a command line
+parameter.