From 4d3c53a1d14229940de04f7392548de666b4c2c3 Mon Sep 17 00:00:00 2001
From: "Paul C. Buetow" <paul@buetow.org>
Date: Tue, 15 Apr 2014 09:17:21 +0200
Subject: add initial docs

---
 docs/fapi.pod | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/fapi.pod

(limited to 'docs/fapi.pod')

diff --git a/docs/fapi.pod b/docs/fapi.pod
new file mode 100644
index 0000000..9138771
--- /dev/null
+++ b/docs/fapi.pod
@@ -0,0 +1,42 @@
+=head1 NAME
+
+fapi - A humble command line tool to manage F5 BigIP loadbalancers
+
+This is a simple command line client to do basic stuff with the iControl F5 API 
+such as:
+
+  Managing Nodes
+  Managing Monitors
+  Managing Pools
+  Managing Virtual Servers
+
+=head1 Synopsis
+
+Just run
+
+  fapi -h
+
+or
+
+  f -h
+
+because it's shorter to type.
+
+=head1 Requirement of bigsuds
+
+This tool depends on bigsuds. Please install this library from F5 dev central
+manually. Otherwise this script will not work.
+
+=head1 iControl reference
+
+L<https://devcentral.f5.com/wiki/icontrol.apireference.ashx>
+
+=head1 Project Homepage
+
+See L<http://japi.buetow.org>
+
+=head1 AUTHOR
+
+Paul C. Buetow - <paul@buetow.org>
+
+=cut
-- 
cgit v1.2.3