add synopsis.txt to be included via webpage0.0.9

3 files changed, 69 insertions, 2 deletions

diff --git a/Makefile b/Makefile
index fc5f669..17a64d9 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,5 @@
 NAME=fapi
-all: version documentation build
+all: version build documentation 
 build:
 	test ! -d bin && mkdir bin || exit 0
 	cp -p ./src/$(NAME) bin/$(NAME)
@@ -29,6 +29,7 @@ documentation:
 		--center="User Commands" ./docs/$(NAME).pod > ./docs/$(NAME).1
 	pod2text ./docs/$(NAME).pod > ./docs/$(NAME).txt
 	cp ./docs/$(NAME).pod README.pod
+	./bin/fapi -h > ./docs/synopsis.txt
 # Build a debian package (don't sign it, modify the arguments if you want to sign it)
 deb: all
 	dpkg-buildpackage
diff --git a/docs/synopsis.txt b/docs/synopsis.txt
new file mode 100644
index 0000000..16d3745
--- /dev/null
+++ b/docs/synopsis.txt
@@ -0,0 +1,66 @@
+usage: fapi [-b B] [-e E] [-h] [-l] [-p P] [-v] [-V] [-C C]
+            [what] [name] [sub] [sub2] [sub3] [sub4] [sub5]
+
+positional arguments:
+  what  node|pool|monitor|vserver|...
+  name  The object name to operate on
+  sub   First sub command
+  sub2  Second sub command
+  sub3  Third sub command
+  sub4  Fourth sub command
+  sub5  Fith sub command
+
+optional arguments:
+  -b B  Forces to use the secified loadbalancer (overwrites -e)
+  -e E  Env to use, e.g. dev,qa,live
+  -h    Help
+  -l    Use list output
+  -p P  Overwrite partition from fapi.conf
+  -v    Verbose
+  -V    Print version
+  -C C  Config file
+
+This is fapi version 0.0.8
+
+Synopsis:
+ fapi monitor [NAME get desc|state]
+ fapi node
+ fapi node NODENAME create|delete
+ fapi node NODENAME get detail|status
+ fapi pool [NAME add member MEMBER:PORT]
+ fapi pool NAME add monitor MONITOR
+ fapi pool NAME create [LIST,OF,POOL,MEMBERS:PORT]
+ fapi pool NAME delete
+ fapi pool NAME del member MEMBER:PORT
+ fapi pool NAME del monitors
+ fapi pool NAME get detail|lbmethod|members|monitor|status
+ fapi pool NAME set lbmethod LBMETHOD
+ fapi vip [NAME create NETMASK]
+ fapi vip NAME get arp|detail|status|tgroup
+ fapi vip NAME set arp enabled|disabled
+ fapi vip NAME set tgroup TGROUP
+ fapi vserver [NAME create [protocol] [profile] [poolname] [mask]]
+ fapi vserver NAME delete
+ fapi vserver NAME get brief|detail|status
+ fapi vserver NAME set nat|pat disabled|enabled
+ fapi vserver NAME set pool POOLNAME
+ fapi vserver NAME set snat none
+The following partially needs admininstrator privileges on / and /Common
+ fapi -p / folder [NAME create|delete]
+ fapi -p / folder NAME get detail|dgroup|tgroup
+ fapi -p / folder NAME set dgroup|tgroup DGROUP|TGROUP
+ fapi -p Common vlan [NAME get detail]
+ fapi -p Common vlan NAME create tagged VLANID internal|external|...
+ fapi -p Common vlan NAME delete
+ fapi -p Common tgroup [NAME get detail]
+ fapi -p Common tgroup NAME create
+ fapi -p Common tgroup NAME delete
+ fapi -p Common tgroup NAME add ha_order DEVICE ORDER
+ fapi -p Common tgroup NAME get ha_order
+ fapi -p Common tgroup NAME remove ha_order DEVICE ORDER
+ fapi -p Common tgroup NAME remove all_ha_orders
+ fapi -p Common -b balancer.example.com selfip [NAME get detail|tgroup]
+ fapi -p Common -b balancer.example.com selfip NAME set tgroup TGROUP
+ fapi -p Common -b balancer.example.com selfip NAME create NETMASK VLANNAME [TGROUP]
+ fapi -p Common -b balancer.example.com selfip NAME delete
+Please consult the manpage for examples.
diff --git a/src/fapi b/src/fapi
index ddf72b4..93c184e 100755
--- a/src/fapi
+++ b/src/fapi
@@ -16,7 +16,7 @@ from inspect import isfunction
 
 import ConfigParser
 
-__program__ = 'fapi
+__program__ = 'fapi'
 __version__ = 'VERSION_DEVEL' # Replaced by a Makefile target
 __prompt__  = '> ' # Default prompt