Added help text and GPL v3 header

Nothing much to see here. Just wrote the help text and added -h,--help to the
argument parsing loop.

Yay GPLv3

1 files changed, 35 insertions, 2 deletions

diff --git a/forkload b/forkload
index 93f22f3..65365b1 100755
--- a/forkload
+++ b/forkload
@@ -1,7 +1,37 @@
 #!/usr/bin/env bash
+#
+# Forkload performs rudimentary load testing on remote web applications
+# Copyright (C) 2014  Aaron Ball
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 
 function get_help {
-  echo "This needs to be written"
+  echo "
+The forkload script provides rudimentary load testing for web applications
+(anything accessible through curl). This currently tests from a single system,
+so a significant bottleneck will occur due to the fact that a load test is
+running off of a single nic. As such, Forkload is intended for small scale load
+tests (tens to the low hundreds of clients, depending on your nic and the
+infrastructure between the testing agent and the destination).
+
+Arguments:
+ -d,--dest     Destination to test on
+ -o,--output   File to output the load test results to (default: forkload.out)
+ -c,--clients  Number of virtual clients to test with (default: 1)
+ -h,--help     Prints this help text
+ "
 }
 
 function main {
@@ -14,7 +44,10 @@ function main {
   # Parse arguments
   for (( i = 0; i < ${#argv[*]}; i++ )); do
     val=${argv[$i]}
-    if [[ ${val} == "-o" || ${val} == "--output" ]]; then
+    if [[ ${val} == "-h" || ${val} == "--help" ]]; then
+      echo -e "$(get_help)"
+      exit 0
+    elif [[ ${val} == "-o" || ${val} == "--output" ]]; then
       i=$((i+1))
       out=${argv[$i]}
     elif [[ ${val} == "-c" || ${val} == "--clients" ]]; then