From: Andre Noll <maan@tuebingen.mpg.de>
Date: Fri, 29 Aug 2014 18:13:13 +0000 (+0200)
Subject: gsu: Document gsu().
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=1098785778a242838668df8c45f4a07d1690b06c;p=gsu.git

gsu: Document gsu().

To get started, gsu application writers need to know how the gsu()
function works. So let's provide a small introduction here and a
minimal example.
---

diff --git a/misc/gsu/subcommand b/misc/gsu/subcommand
index a04b8de..6b5df0a 100644
--- a/misc/gsu/subcommand
+++ b/misc/gsu/subcommand
@@ -513,6 +513,21 @@ gsu_get_unnamed_arg_num()
 	result="$(($n - 1))"
 }
 
+# Entry point for all gsu-based scripts.
+#
+# The startup part of the application script should source this file to load
+# the functions defined here, and then call gsu(). Functions starting with com_
+# are automatically recognized as subcommands.
+#
+# Minimal example:
+#
+#	com_hello()
+#	{
+#		echo 'hello world'
+#	}
+#	gsu_dir=${gsu_dir:-/system/location/where/gsu/is/installed}
+#	. $gsu_dir/subcommand || exit 1
+#	gsu "$@"
 gsu()
 {
 	local i