add examples to docu

1 files changed, 63 insertions, 18 deletions

diff --git a/docs/fapi.1 b/docs/fapi.1
index 2db3df6..45b65c3 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -131,18 +131,8 @@
 .nh
 .SH "NAME"
 fapi \- A humble command line tool to manage F5 BigIP loadbalancers
-.PP
-This is a simple command line client to do basic stuff with the iControl F5 API 
-such as:
-.PP
-.Vb 4
-\&  Managing Nodes
-\&  Managing Monitors
-\&  Managing Pools
-\&  Managing Virtual Servers
-.Ve
-.SH "Synopsis"
-.IX Header "Synopsis"
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
 Just run
 .PP
 .Vb 1
@@ -156,8 +146,24 @@ or
 .Ve
 .PP
 because it's shorter to type.
-.SH "bigsuds"
-.IX Header "bigsuds"
+.SH "ABOUT"
+.IX Header "ABOUT"
+This is a simple command line client to do basic stuff with the iControl F5 \s-1API\s0 
+such as:
+.PP
+.Vb 4
+\&  Managing Nodes
+\&  Managing Monitors
+\&  Managing Pools
+\&  Managing Virtual Servers
+.Ve
+.PP
+This is a private programming project programmed in my spare time. Therefore I
+didn't bother to put it on a public website and github. Please open bug 
+reports, feature requests and pull requests at
+<https://github.com/rantanplan/fapi>.
+.SH "BIGSUDS"
+.IX Header "BIGSUDS"
 .SS "Requirement of bigsuds"
 .IX Subsection "Requirement of bigsuds"
 This tool depends on bigsuds. Please install this library from F5 dev central
@@ -172,15 +178,15 @@ Unzip it and run
 .Vb 1
 \&  sudo python setyp.py install
 .Ve
+.PP
+You may also install bigsuds from the contrib dir of the fapi source tree.
 .SS "iControl reference"
 .IX Subsection "iControl reference"
 Through bigsuds you can do everything what iControl can do:
 .PP
 <https://devcentral.f5.com/wiki/icontrol.apireference.ashx>
-.SH "Quick start"
-.IX Header "Quick start"
-.SS "Installing"
-.IX Subsection "Installing"
+.SH "QUICK START"
+.IX Header "QUICK START"
 Update your sources list:
 .PP
 .Vb 4
@@ -197,6 +203,45 @@ And run
 \&  cp /usr/share/fapi/fapi.conf.sample ~/.fapi.conf
 \&  vim ~/.fapi.conf
 .Ve
+.SH "EXAMPLES"
+.IX Header "EXAMPLES"
+.SS "Setting up simple \s-1NAT\s0 Services"
+.IX Subsection "Setting up simple NAT Services"
+.Vb 1
+\&  (Docu to be written)
+.Ve
+.SS "Setting up simple \s-1SNAT\s0 Services"
+.IX Subsection "Setting up simple SNAT Services"
+.Vb 1
+\&  (Docu to be written)
+.Ve
+.SS "Setting up a simple nPath Service"
+.IX Subsection "Setting up a simple nPath Service"
+A simple nPath service can be created as follows.
+.PP
+.Vb 3
+\&  # Creating two nodes, auto resolve the IP addresses
+\&  f node fooserver1.example.com create
+\&  f node fooserver2.example.com create
+\&
+\&  # Creating a pool and add the nodes to it
+\&  f pool foopool create
+\&  f pool foopool add member fooserver1.example.com:80
+\&  f pool foopool add member fooserver2.example.com:80
+\&
+\&  # Add a monitor to the pool
+\&  f pool foopool add monitor http_lbtest
+\&
+\&  # Create a nPath HTTP service, \*(AqnPath\*(Aq also auto disables NAT and PAT
+\&  f vserver myservice.example.com:80 create PROTOCOL_TCP nPath
+\&
+\&  # Add the pool to the service
+\&  f vserver myservice.example.com:80 set pool foopool
+\&
+\&  # Add a nPath HTTPS service
+\&  f vserver myservice.example.com:443 create PROTOCOL_TCP nPath
+\&  f vserver myservice.example.com:443 set pool foopool
+.Ve
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Paul C. Buetow \- <paul@buetow.org>