aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulien Dessaux2019-06-17 00:21:24 +0200
committerJulien Dessaux2019-06-17 00:21:24 +0200
commit9098246cce7dda3002df9b6ea10c0e2bd6324d41 (patch)
treed2f941c80f1c34e403d0ef7ec33e6e0392c2a67a
parentRemoved unused profiling flags that cause failed builds on alpine linux (diff)
downloadbastion-9098246cce7dda3002df9b6ea10c0e2bd6324d41.tar.gz
bastion-9098246cce7dda3002df9b6ea10c0e2bd6324d41.tar.bz2
bastion-9098246cce7dda3002df9b6ea10c0e2bd6324d41.zip
Document the cli arguments in README
Diffstat (limited to '')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5b9caa9..4ddb52b 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,9 @@ This bastion project does work properly with non interactive sessions, which all
- [Manual installation](#manual-installation)
- [Configuration](#configuration)
- [Usage](#usage)
+- [Session recording](#session-recording)
- [Docker](#docker)
+- [Log management](#log-management)
- [Monitoring](#monitoring)
- [Backup](#backup)
- [Scaling](#scaling)
@@ -73,8 +75,22 @@ session_recording:
## Usage
+```
+julien@hurricane ~/git/bastion/build (master *$%) $ bastion -h
+Usage: bastion [-h] [-v] [-t] [-f] [-c STRING]
+ -h : show this help message and exit
+ -v : show version and exit
+ -t : test configuration file and exit
+ -f : stay in foreground (don't fork)
+ -c : specify a path to a configuration file to use instead of the default /home/julien/.local/etc/bastion/bastion.conf
+```
+
+## Session recording
+
## Docker
+## Log management
+
## Monitoring
## Backup