From 8058b27c32024cdf7d003628a3df819ceff42c38 Mon Sep 17 00:00:00 2001 From: "Paul C. Buetow" Date: Tue, 15 Apr 2014 21:41:42 +0200 Subject: more documentation --- docs/fapi.1 | 37 ++++++++++++++++++++++++++++++------- docs/fapi.pod | 31 +++++++++++++++++++++++++------ docs/fapi.txt | 25 +++++++++++++++++++++---- 3 files changed, 76 insertions(+), 17 deletions(-) (limited to 'docs') 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 -.SH "Project Homepage" -.IX Header "Project Homepage" -See +.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 \- +.PP +Also see 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 -=head1 Project Homepage -See L +=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 - +Also see L + =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: + -Project Homepage - See +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 - + Also see + -- cgit v1.2.3