From d8291f848d5f96fe6f27957f426609078ae6c310 Mon Sep 17 00:00:00 2001
From: Chris Greenshields <http://cfd.direct>
Date: Mon, 29 May 2017 21:02:16 +0100
Subject: [PATCH] Scripts in bin: added -help to scripts

---
 bin/foamCleanTutorials | 35 +++++++++++++++++++++++++--------
 bin/foamRunTutorials   | 44 ++++++++++++++++++++++++++----------------
 2 files changed, 54 insertions(+), 25 deletions(-)

diff --git a/bin/foamCleanTutorials b/bin/foamCleanTutorials
index 8712bb25f..5777b8ecb 100755
--- a/bin/foamCleanTutorials
+++ b/bin/foamCleanTutorials
@@ -3,7 +3,7 @@
 # =========                 |
 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
 #  \\    /   O peration     |
-#   \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+#   \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
 #    \\/     M anipulation  |
 #------------------------------------------------------------------------------
 # License
@@ -30,15 +30,34 @@
 #     and all its subdirectories.
 #
 #------------------------------------------------------------------------------
+Script=$PWD/${0##*/}
 
 # Source tutorial clean functions
-. $WM_PROJECT_DIR/bin/tools/CleanFunctions
+. "$WM_PROJECT_DIR/bin/tools/CleanFunctions"
 
-thisScript=$0
-if [ "/${thisScript#/}" != "$thisScript" ]
-then
-    thisScript="$PWD/$thisScript"
-fi
+usage() {
+    cat<<USAGE
+
+Usage: ${0##*/} [OPTIONS]
+options:
+  -help      | -h     help
+
+Helper script used by the Allclean scripts in the OpenFOAM tutorials
+USAGE
+}
+
+# Parse options
+while [ "$#" -gt 0 ]
+do
+    case "$1" in
+    -h | -help)
+        usage && exit 0
+        ;;
+    *)
+        break
+        ;;
+    esac
+done
 
 # If an argument is supplied do not execute ./Allwclean or ./Allclean
 # (to avoid recursion)
@@ -62,7 +81,7 @@ else
     # Recurse into subdirectories
     for caseName in *
     do
-        ( cd $caseName 2>/dev/null && $thisScript )
+        ( cd "$caseName" 2>/dev/null && $Script )
     done
 fi
 
diff --git a/bin/foamRunTutorials b/bin/foamRunTutorials
index 7aabb6c48..e58f76c61 100755
--- a/bin/foamRunTutorials
+++ b/bin/foamRunTutorials
@@ -3,7 +3,7 @@
 # =========                 |
 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
 #  \\    /   O peration     |
-#   \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
+#   \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
 #    \\/     M anipulation  |
 #------------------------------------------------------------------------------
 # License
@@ -30,18 +30,26 @@
 #     and all its subdirectories.
 #
 #------------------------------------------------------------------------------
+Script=$PWD/${0##*/}
 
 # Normally use standard "make"
 make="make"
 
 # Source tutorial run functions
-. $WM_PROJECT_DIR/bin/tools/RunFunctions
+. "$WM_PROJECT_DIR/bin/tools/RunFunctions"
 
-thisScript=$0
-if [ "/${thisScript#/}" != "$thisScript" ]
-then
-    thisScript="$PWD/$thisScript"
-fi
+usage() {
+    cat<<USAGE
+
+Usage: ${0##*/} [OPTIONS]
+options:
+  -help      | -h     help
+  -skipFirst | -s     do not execute the first Allrun script
+  -test      | -t     run test loop
+
+Helper script used by the Allrun scripts in the OpenFOAM tutorials
+USAGE
+}
 
 skipFirst=false
 
@@ -49,14 +57,17 @@ skipFirst=false
 while [ "$#" -gt 0 ]
 do
     case "$1" in
-    -t | -test)
-        passArgs="-test"
-        shift
+    -h | -help)
+        usage && exit 0
         ;;
     -s | -skipFirst)
         skipFirst=true
         shift
         ;;
+    -t | -test)
+        passArgs="-test"
+        shift
+        ;;
     *)
         break
         ;;
@@ -71,25 +82,24 @@ then
 elif [ -d system ]
 then
     # Run normal case.
-    parentDir=`dirname $PWD`
-    application=`getApplication`
+    application=$(getApplication)
     runApplication blockMesh
-    runApplication $application
+    runApplication "$application"
 else
     # Loop over sub-directories and compile any applications
     for caseName in *
     do
-        if [ -d $caseName -a -d "$caseName/Make" ]
+        if [ -d "$caseName" -a -d "$caseName/Make" ]
         then
-            ( compileApplication $caseName )
+            ( compileApplication "$caseName" )
         fi
     done
     FOAM_TARGETS=$(for d in *; do [ -d "$d" ] && echo "$d"; done | xargs)
 
     # Run all cases which have not already been run
-    $make -k -f $WM_PROJECT_DIR/bin/tools/MakefileDirs \
+    $make -k -f "$WM_PROJECT_DIR/bin/tools/MakefileDirs" \
           FOAM_TARGETS="$FOAM_TARGETS" \
-          FOAM_APP="$thisScript" FOAM_ARGS="$passArgs"
+          FOAM_APP="$Script" FOAM_ARGS="$passArgs"
 fi
 
 #------------------------------------------------------------------------------