X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=docs%2FGoalfile.pod;h=93ca2255bab0b2d8e800d812bb821dcbcc95c648;hb=dc1c16833922b20e6949058a3813a595bb89194b;hp=abe9f502e61605a749c1efa26a1bd4e38e30eeaa;hpb=17dc1d6e0ec8f194df3dd74a7033303ad9ff739c;p=goals.git diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod index abe9f50..93ca225 100644 --- a/docs/Goalfile.pod +++ b/docs/Goalfile.pod @@ -12,6 +12,20 @@ Goalfile - introduction, tutorial, and reference for writing goal files =head1 REFERENCE +=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 +it starts and is deleted when it exits (either on success or failure). +You can use this to store any temporary files that you want +automatically cleaned up. + =head2 Standard Functions =head3 basename (path) @@ -178,13 +192,31 @@ files using ordinary globbing rules. For example: - wrap ("*file", ["bar.c", "foo.c"]) ⇒ [*file("bar.c"), *file("foo.c")] + wrap ("is-file", ["bar.c", "foo.c"]) ⇒ [is-file("bar.c"), is-file("foo.c")] Each element in C is wrapped into a call to C. -There are two common uses for this: either to add explicit tactics -(such as C<*file>) to a plain list of strings as in the example above; +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.