X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=docs%2FGoalfile.pod;h=93ca2255bab0b2d8e800d812bb821dcbcc95c648;hb=dc1c16833922b20e6949058a3813a595bb89194b;hp=5355fe0aa85870b6d0d5b19b473405eab838937f;hpb=a1b5f8cc0dae6adfdb306d701fc6fd579504ffe6;p=goals.git diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod index 5355fe0..93ca225 100644 --- a/docs/Goalfile.pod +++ b/docs/Goalfile.pod @@ -14,6 +14,11 @@ Goalfile - introduction, tutorial, and reference for writing goal files =head2 Standard Variables +=head3 %stdlib + +The path to the standard library directory. This path is also +searched by default for C directives. + =head3 %tmpdir The location of a temporary directory which is created by goals when @@ -194,6 +199,24 @@ There are two common uses for this: either to add explicit predicates (such as C) to a plain list of strings as in the example above; or to turn a list of strings into a list of goal or function calls. +=head2 Standard Shell Functions + +=head3 quoted_string + +Quote a string which will be consumed as a goal expression. This is +typically used from within goal functions which return expressions +(ie. ones which do I have an explicit C declaration). +You must not use this shell function with functions that are marked as +C or C. + +=head3 print_green + +Echo a string in green. Useful for success/OK messages. + +=head3 print_red + +Echo a string in red. Useful for error messages. + =head1 SEE ALSO L.