summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-24 19:33:32 +0200
committerPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-24 19:33:32 +0200
commitd84cac309c758031906e3fee84d428f8555eb413 (patch)
treed78502f8e00501267458886983a5f0c2292a211a
parentd6820ebb04f1bdf8c6ee5e56473c85ab2c810871 (diff)
New release0.9.3
-rw-r--r--.version2
-rw-r--r--Makefile1
-rw-r--r--debian/changelog6
-rw-r--r--debian/files2
-rw-r--r--docs/extended-synopsis.txt156
-rw-r--r--docs/fapi.12
6 files changed, 166 insertions, 3 deletions
diff --git a/.version b/.version
index f374f66..2003b63 100644
--- a/.version
+++ b/.version
@@ -1 +1 @@
-0.9.1
+0.9.2
diff --git a/Makefile b/Makefile
index 6e8e6c6..5b42f43 100644
--- a/Makefile
+++ b/Makefile
@@ -29,6 +29,7 @@ documentation:
pod2text ./docs/$(NAME).pod > ./docs/$(NAME).txt
cp ./docs/$(NAME).pod README.pod
./bin/fapi -h -n > ./docs/synopsis.txt
+ ./bin/fapi -h -n -E >> ./docs/extended-synopsis.txt
# Build a debian package
deb: all
dpkg-buildpackage # -us -uc
diff --git a/debian/changelog b/debian/changelog
index 1e35672..1bb8cb6 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+fapi (0.9.2) stable; urgency=low
+
+ * fapi.buetow.org now also shows the extended synopsis
+
+ -- Paul Buetow <paul@buetow.org> Tue, 24 Jun 2014 19:31:08 +0200
+
fapi (0.9.1) stable; urgency=low
* Add -E argument, which shows the extended synopsis
diff --git a/debian/files b/debian/files
index 3bc932f..ef0d0b1 100644
--- a/debian/files
+++ b/debian/files
@@ -1 +1 @@
-fapi_0.9.1_all.deb utils optional
+fapi_0.9.2_all.deb utils optional
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
diff --git a/docs/fapi.1 b/docs/fapi.1
index bc10296..378f674 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "FAPI 1"
-.TH FAPI 1 "2014-05-27" "fapi 0.9.1" "User Commands"
+.TH FAPI 1 "2014-05-27" "fapi 0.9.2" "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l