summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/fapi.137
-rw-r--r--docs/fapi.pod31
-rw-r--r--docs/fapi.txt25
3 files changed, 76 insertions, 17 deletions
diff --git a/docs/fapi.1 b/docs/fapi.1
index c3e64c3..2db3df6 100644
--- a/docs/fapi.1
+++ b/docs/fapi.1
@@ -156,8 +156,10 @@ or
.Ve
.PP
because it's shorter to type.
-.SH "Requirement of bigsuds"
-.IX Header "Requirement of bigsuds"
+.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
manually. Otherwise this script will not work.
.PP
@@ -170,12 +172,33 @@ Unzip it and run
.Vb 1
\& sudo python setyp.py install
.Ve
-.SH "iControl reference"
-.IX Header "iControl reference"
+.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 "Project Homepage"
-.IX Header "Project Homepage"
-See <http://fapi.buetow.org>
+.SH "Quick start"
+.IX Header "Quick start"
+.SS "Installing"
+.IX Subsection "Installing"
+Update your sources list:
+.PP
+.Vb 4
+\& curl http://deb.buetow.org/apt/pubkey.gpg | sudo apt\-key add \-
+\& echo \*(Aqdeb http://deb.buetow.org/apt wheezy main\*(Aq > \e
+\& /etc/apt/sourcees.list.d/buetoworg.list
+\& aptitude update
+.Ve
+.PP
+And run
+.PP
+.Vb 3
+\& aptitude install fapi
+\& cp /usr/share/fapi/fapi.conf.sample ~/.fapi.conf
+\& vim ~/.fapi.conf
+.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul C. Buetow \- <paul@buetow.org>
+.PP
+Also see <http://fapi.buetow.org>
diff --git a/docs/fapi.pod b/docs/fapi.pod
index 844e7cb..68ad2d7 100644
--- a/docs/fapi.pod
+++ b/docs/fapi.pod
@@ -18,11 +18,12 @@ Just run
or
- f -h
-
+ f -h
because it's shorter to type.
-=head1 Requirement of bigsuds
+=head1 bigsuds
+
+=head2 Requirement of bigsuds
This tool depends on bigsuds. Please install this library from F5 dev central
manually. Otherwise this script will not work.
@@ -35,16 +36,34 @@ Unzip it and run
sudo python setyp.py install
-=head1 iControl reference
+=head2 iControl reference
+
+Through bigsuds you can do everything what iControl can do:
L<https://devcentral.f5.com/wiki/icontrol.apireference.ashx>
-=head1 Project Homepage
-See L<http://fapi.buetow.org>
+=head1 Quick start
+
+=head2 Installing
+
+Update your sources list:
+
+ curl http://deb.buetow.org/apt/pubkey.gpg | sudo apt-key add -
+ echo 'deb http://deb.buetow.org/apt wheezy main' > \
+ /etc/apt/sourcees.list.d/buetoworg.list
+ aptitude update
+
+And run
+
+ aptitude install fapi
+ cp /usr/share/fapi/fapi.conf.sample ~/.fapi.conf
+ vim ~/.fapi.conf
=head1 AUTHOR
Paul C. Buetow - <paul@buetow.org>
+Also see L<http://fapi.buetow.org>
+
=cut
diff --git a/docs/fapi.txt b/docs/fapi.txt
index d7c6a4b..b428d34 100644
--- a/docs/fapi.txt
+++ b/docs/fapi.txt
@@ -20,7 +20,8 @@ Synopsis
because it's shorter to type.
-Requirement of bigsuds
+bigsuds
+ Requirement of bigsuds
This tool depends on bigsuds. Please install this library from F5 dev
central manually. Otherwise this script will not work.
@@ -32,12 +33,28 @@ Requirement of bigsuds
sudo python setyp.py install
-iControl reference
+ iControl reference
+ Through bigsuds you can do everything what iControl can do:
+
<https://devcentral.f5.com/wiki/icontrol.apireference.ashx>
-Project Homepage
- See <http://fapi.buetow.org>
+Quick start
+ Installing
+ Update your sources list:
+
+ curl http://deb.buetow.org/apt/pubkey.gpg | sudo apt-key add -
+ echo 'deb http://deb.buetow.org/apt wheezy main' > \
+ /etc/apt/sourcees.list.d/buetoworg.list
+ aptitude update
+
+ And run
+
+ aptitude install fapi
+ cp /usr/share/fapi/fapi.conf.sample ~/.fapi.conf
+ vim ~/.fapi.conf
AUTHOR
Paul C. Buetow - <paul@buetow.org>
+ Also see <http://fapi.buetow.org>
+