summaryrefslogtreecommitdiff
path: root/doc/synopsis.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/synopsis.rst')
-rw-r--r--doc/synopsis.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/synopsis.rst b/doc/synopsis.rst
index 5b93a92..2b28c74 100644
--- a/doc/synopsis.rst
+++ b/doc/synopsis.rst
@@ -1,4 +1,19 @@
Synopsis
========
-biboumi [*config_filename*]
+biboumi [-ht] [*config_filename*]
+
+Command-Line Options
+========
+
+-h, \\-\\-help
+~~~~~~~~
+
+Display a help message and exit.
+
+-t, \\-\\-test-config
+~~~~~~~~
+
+Do not run, just test the configuration file syntax. Exit with a 0
+status if the configuration is valid, exits with a non-zero status
+otherwise.