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/runblock.html | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 doc/runblock.html (limited to 'doc/runblock.html') diff --git a/doc/runblock.html b/doc/runblock.html new file mode 100644 index 0000000..6f5386e --- /dev/null +++ b/doc/runblock.html @@ -0,0 +1,75 @@ + + + + + execline: the runblock program + + + + + + +

+ +

The `runblock` program

+ +

+runblock's purpose is to help you write execline commands +in the execline language. It can only be used inside an execline +script. If the script has been given blocks as arguments, runblock +allows you to execute one of the blocks individually. +

+ +

Interface

+ +

+     runblock [ -P ] [ -n argshift ] [ -r ] n
+

+ +

runblock skips the first argshift positional +parameters. It does that to allow you to design commands that take simple +arguments and blocks.
Then runblock looks for and parses +blocks in the positional parameters.
If the -r option is present: runblock skips +n blocks and execs into the remaining arguments.
Else it skips n-1 blocks and execs into the nth +one.
Normally runblock pops +its environment frame before executing. If the -P option has +been given, it does not pop.
Of course, if the block structure doesn't match, runblock +exits 100 with an error message.

+ +

Example: implementing the ifelse command

+ +

+ Suppose that we want to implement the ifelse command as +an execline script, using the ifte command. +runblock allows us to do it in a simple way: +

+ +

+ #!/command/execlineb
+ ifte { runblock 2 } { runblock -r 2 } runblock 1
+

+ +

+ That's it. +

+ +

Credits

+ +

+ The runblock idea, as well as the ifelse idea, comes +from Paul Jarc. +

+ + + -- cgit v1.3.1

The runblock program

Interface

Example: implementing the ifelse command

Credits

The `runblock` program