X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;ds=inline;f=docs%2FGoalfile.pod;h=85d19ba8fed6408bb1acc8eab9a4ff639bb064a6;hb=be61a8a416b1bef88a416579cc663f1849ccf1cf;hp=37f3c07c7b2c637f48c426070618c5ca831a5487;hpb=580298444204f92785a7ac78c4529e95e3cba40d;p=goals.git diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod index 37f3c07..85d19ba 100644 --- a/docs/Goalfile.pod +++ b/docs/Goalfile.pod @@ -30,6 +30,14 @@ For example: Returns the directory part of the path. +=head3 error (msg) + +For example: + + error ("this should not happen") + +This prints the error message and causes goals to exit. + =head3 extension (filename) For example: @@ -56,6 +64,23 @@ Concatenate C and C. It's not usually necessary to use this function since goals automatically flattens lists within lists into simple lists in many cases. +=head3 read (filename) + +For example: + + read ("filename") => "this is the content of filename" + +Read the contents of C and return it as a single string. +If there is a trailing C<\n> in the file it is truncated. + +=head3 readlines (filename) + +For example: + + readlines ("filename") => ["line1", "line2", "line3"] + +Read the lines in C returning a list of strings. + =head3 realpath (filename) For example: