New release0.9.3

1 files changed, 156 insertions, 0 deletions

diff --git a/docs/extended-synopsis.txt b/docs/extended-synopsis.txt
new file mode 100644
index 0000000..917b3be
--- /dev/null
+++ b/docs/extended-synopsis.txt
@@ -0,0 +1,156 @@
+usage: fapi [-a] [-b B] [-d] [-E] [-e E] [-f F] [-h] [-i] [-l] [-n] [-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:
+  -a    Disables auto port in vserver name
+  -b B  Forces to use the secified loadbalancer (overwrites -e)
+  -d    Disable colorful output
+  -E    Show extended synopsis
+  -e E  Env to use, e.g. dev,qa,live
+  -f F  Overwrite partition/folder from fapi.conf
+  -h    Print this help
+  -i    Interactive shell
+  -l    Use list output
+  -n    No-op (don't do actual stuff)
+  -v    Verbose
+  -V    Print program version
+  -C C  Config file
+
+
+Extended synopsis.
+The following partially needs admininstrator privileges on / and /Common:
+    -f Common -b balancer.example.com selfip
+    -f Common -b balancer.example.com selfip NAME create NETMASK VLANNAME [TGROUP]
+    -f Common -b balancer.example.com selfip NAME delete
+    -f Common -b balancer.example.com selfip NAME get detail|tgroup
+    -f Common -b balancer.example.com selfip NAME set tgroup TGROUP
+    -f Common -b balancer.example.com vlan
+    -f Common -b balancer.example.com vlan NAME create tagged VLANID internal|external|...
+    -f Common -b balancer.example.com vlan NAME delete
+    -f Common -b balancer.example.com vlan NAME get detail
+    -f Common tgroup
+    -f Common tgroup NAME add ha_order DEVICE ORDER
+    -f Common tgroup NAME create
+    -f Common tgroup NAME delete
+    -f Common tgroup NAME get detail
+    -f Common tgroup NAME get ha_order
+    -f Common tgroup NAME remove all_ha_orders
+    -f Common tgroup NAME remove ha_order DEVICE ORDER
+    -f / folder
+    -f / folder NAME create|delete
+    -f / folder NAME get detail|dgroup|tgroup
+    -f / folder NAME set dgroup|tgroup DGROUP|TGROUP
+usage: fapi [-a] [-b B] [-d] [-E] [-e E] [-f F] [-h] [-i] [-l] [-n] [-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:
+  -a    Disables auto port in vserver name
+  -b B  Forces to use the secified loadbalancer (overwrites -e)
+  -d    Disable colorful output
+  -E    Show extended synopsis
+  -e E  Env to use, e.g. dev,qa,live
+  -f F  Overwrite partition/folder from fapi.conf
+  -h    Print this help
+  -i    Interactive shell
+  -l    Use list output
+  -n    No-op (don't do actual stuff)
+  -v    Verbose
+  -V    Print program version
+  -C C  Config file
+
+
+Extended synopsis.
+The following partially needs admininstrator privileges on / and /Common:
+    -f Common -b balancer.example.com selfip
+    -f Common -b balancer.example.com selfip NAME create NETMASK VLANNAME [TGROUP]
+    -f Common -b balancer.example.com selfip NAME delete
+    -f Common -b balancer.example.com selfip NAME get detail|tgroup
+    -f Common -b balancer.example.com selfip NAME set tgroup TGROUP
+    -f Common -b balancer.example.com vlan
+    -f Common -b balancer.example.com vlan NAME create tagged VLANID internal|external|...
+    -f Common -b balancer.example.com vlan NAME delete
+    -f Common -b balancer.example.com vlan NAME get detail
+    -f Common tgroup
+    -f Common tgroup NAME add ha_order DEVICE ORDER
+    -f Common tgroup NAME create
+    -f Common tgroup NAME delete
+    -f Common tgroup NAME get detail
+    -f Common tgroup NAME get ha_order
+    -f Common tgroup NAME remove all_ha_orders
+    -f Common tgroup NAME remove ha_order DEVICE ORDER
+    -f / folder
+    -f / folder NAME create|delete
+    -f / folder NAME get detail|dgroup|tgroup
+    -f / folder NAME set dgroup|tgroup DGROUP|TGROUP
+usage: fapi [-a] [-b B] [-d] [-E] [-e E] [-f F] [-h] [-i] [-l] [-n] [-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:
+  -a    Disables auto port in vserver name
+  -b B  Forces to use the secified loadbalancer (overwrites -e)
+  -d    Disable colorful output
+  -E    Show extended synopsis
+  -e E  Env to use, e.g. dev,qa,live
+  -f F  Overwrite partition/folder from fapi.conf
+  -h    Print this help
+  -i    Interactive shell
+  -l    Use list output
+  -n    No-op (don't do actual stuff)
+  -v    Verbose
+  -V    Print program version
+  -C C  Config file
+
+
+Extended synopsis.
+The following partially needs admininstrator privileges on / and /Common:
+    -f Common -b balancer.example.com selfip
+    -f Common -b balancer.example.com selfip NAME create NETMASK VLANNAME [TGROUP]
+    -f Common -b balancer.example.com selfip NAME delete
+    -f Common -b balancer.example.com selfip NAME get detail|tgroup
+    -f Common -b balancer.example.com selfip NAME set tgroup TGROUP
+    -f Common -b balancer.example.com vlan
+    -f Common -b balancer.example.com vlan NAME create tagged VLANID internal|external|...
+    -f Common -b balancer.example.com vlan NAME delete
+    -f Common -b balancer.example.com vlan NAME get detail
+    -f Common tgroup
+    -f Common tgroup NAME add ha_order DEVICE ORDER
+    -f Common tgroup NAME create
+    -f Common tgroup NAME delete
+    -f Common tgroup NAME get detail
+    -f Common tgroup NAME get ha_order
+    -f Common tgroup NAME remove all_ha_orders
+    -f Common tgroup NAME remove ha_order DEVICE ORDER
+    -f / folder
+    -f / folder NAME create|delete
+    -f / folder NAME get detail|dgroup|tgroup
+    -f / folder NAME set dgroup|tgroup DGROUP|TGROUP