Browse Source

ReadMe: show 'batcave.py -h'

Helge Jung 9 years ago
parent
commit
8d7d49523f
1 changed files with 30 additions and 0 deletions
  1. 30 0
      Readme.md

+ 30 - 0
Readme.md

@@ -25,3 +25,33 @@ sudo update-rc.d ffstatus defaults
 sudo update-rc.d ffstatus enable
 ```
 
+## Nutzung
+
+```
+$ ./batcave.py -h
+usage: batcave.py [-h] [--logfile LOGFILE] [--interval INTERVAL] [-d] [-n]
+                  [-A ALFRED_JSON] [-B BATADV_VIS] [-G GRAPHITE_HOST]
+                  [--graphite-port GRAPHITE_PORT] [--dashing-url DASHING_URL]
+                  [--dashing-token DASHING_TOKEN]
+
+Batman/Alfred Transmission Collection, Aggregation & Value Engine
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --logfile LOGFILE     path for log file
+  --interval INTERVAL   data poll interval
+  -d, --no-detach       Don't detach (daemonize) ourself
+  -n, --no-send         Fetch data but don't send it
+  -A ALFRED_JSON, --alfred-json ALFRED_JSON
+                        executable path for alfred-json
+  -B BATADV_VIS, --batadv-vis BATADV_VIS
+                        executable path for batadv-vis
+  -G GRAPHITE_HOST, --graphite-host GRAPHITE_HOST
+                        Graphite host
+  --graphite-port GRAPHITE_PORT
+                        Graphite port
+  --dashing-url DASHING_URL
+                        Dashing URL
+  --dashing-token DASHING_TOKEN
+                        Dashing's secret update token
+```