more on documentation

3 files changed, 68 insertions, 3 deletions

diff --git a/docs/fapi.1 b/docs/fapi.1
index d6b6ce3..63436ab 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "FAPI 1"
-.TH FAPI 1 "2014-04-16" "fapi 0.0.6" "User Commands"
+.TH FAPI 1 "2014-04-17" "fapi 0.0.6" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -277,6 +277,40 @@ And everything can be deleted as folows:
 .Vb 1
 \&  (Docu to be written)
 .Ve
+.SS "About the \s-1NAME\s0 argument"
+.IX Subsection "About the NAME argument"
+In most cases \s-1NAME\s0 can be a hostname, \s-1FQDN\s0 or an \s-1IP\s0 address. Optionally folled
+by a port:
+.PP
+.Vb 1
+\&  NAME := fqdn|hostname|ip[:ip2[:port]]
+.Ve
+.PP
+Examples:
+.PP
+.Vb 2
+\&  # Auto resolving of the virtual address (IP) and auto port 80
+\&  f vserver fqdn.example.com create
+\&
+\&  # Auto resolving of the virtual address (IP)
+\&  f vserver fqdn.example.com:443 create
+\&
+\&  # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
+\&  # and auto port 80
+\&  f vserver hostname create
+\&
+\&  # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
+\&  f vserver hostname:443 create
+\&
+\&  # vserver name and its virtual address will be 1.2.3.4 and auto port 80
+\&  f vserver 1.2.3.4 create
+\&
+\&  # vserver name and its virtual address will be 1.2.3.4 
+\&  f vserver 1.2.3.4:443 create
+\&
+\&  # vserver name is foo, its virtual address 1.2.3.4 and port is 80
+\&  f vserver foo:1.2.3.4:80 create
+.Ve
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Paul C. Buetow \- <paul@buetow.org>
diff --git a/docs/fapi.pod b/docs/fapi.pod
index 4af24cb..5e14983 100644
--- a/docs/fapi.pod
+++ b/docs/fapi.pod
@@ -152,10 +152,11 @@ Examples:
   # Auto resolving of the virtual address (IP)
   f vserver fqdn.example.com:443 create
 
-  # Auto resolving of the FQDN and the virtual address (IP) and auto port 80
+  # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
+  # and auto port 80
   f vserver hostname create
 
-  # Auto resolving of the FQDN and the virtual address (IP) 
+  # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
   f vserver hostname:443 create
 
   # vserver name and its virtual address will be 1.2.3.4 and auto port 80
diff --git a/docs/fapi.txt b/docs/fapi.txt
index cccee88..bcbf496 100644
--- a/docs/fapi.txt
+++ b/docs/fapi.txt
@@ -122,6 +122,36 @@ EXAMPLES
   Setting up simple SNAT Services
       (Docu to be written)
 
+  About the NAME argument
+    In most cases NAME can be a hostname, FQDN or an IP address. Optionally
+    folled by a port:
+
+      NAME := fqdn|hostname|ip[:ip2[:port]]
+
+    Examples:
+
+      # Auto resolving of the virtual address (IP) and auto port 80
+      f vserver fqdn.example.com create
+
+      # Auto resolving of the virtual address (IP)
+      f vserver fqdn.example.com:443 create
+
+      # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
+      # and auto port 80
+      f vserver hostname create
+
+      # Auto resolving of the FQDN (vserver name) and the virtual address (IP) 
+      f vserver hostname:443 create
+
+      # vserver name and its virtual address will be 1.2.3.4 and auto port 80
+      f vserver 1.2.3.4 create
+
+      # vserver name and its virtual address will be 1.2.3.4 
+      f vserver 1.2.3.4:443 create
+
+      # vserver name is foo, its virtual address 1.2.3.4 and port is 80
+      f vserver foo:1.2.3.4:80 create
+
 AUTHOR
     Paul C. Buetow - <paul@buetow.org>