From f316a2ed52195135a35e32d7096e876357c48c69 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 18 Sep 2014 20:03:23 +0000 Subject: initial commit: rc for execline-2.0.0.0 --- doc/elgetopt.html | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/elgetopt.html (limited to 'doc/elgetopt.html') diff --git a/doc/elgetopt.html b/doc/elgetopt.html new file mode 100644 index 0000000..a5650f2 --- /dev/null +++ b/doc/elgetopt.html @@ -0,0 +1,60 @@ + + + + + execline: the elgetopt command + + + + + + +

+execline
+Software
+skarnet.org +

+ +

The `elgetopt` program

+ +

+elgetopt performs getopt-style parsing on the +arguments to an execline script. +

+ +

Interface

+ +

+     elgetopt optstring prog...
+

+ +

elgetopt expects to find a valid number n of +arguments in the # environment variable, and n+1 +environment variables 0, 1, ..., n. +It exits 100 if it is not the case.
elgetopt pushes +environment variables starting with ELGETOPT_. To get the +previous values back, use +emptyenv -o.
elgetopt looks into 1, 2... for options, +as specified by optstring, which is a standard getopt +string.
If the -c switch is recognized, elgetopt +sets the ELGETOPT_c environment variable. The value +of that variable is the argument to the -c switch if +it has one, and 1 otherwise.
After setting all recognized options, elgetopt makes +new #, 1, 2... "positional parameters" with +what remains.
elgetopt then execs into prog....

+ +

Notes

+ +

GNU-style options are not supported.

+ + + -- cgit v1.3.1

The elgetopt program

Interface

Notes

The `elgetopt` program