diff options
Diffstat (limited to 'docs/build.7')
-rw-r--r-- | docs/build.7 | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/build.7 b/docs/build.7 new file mode 100644 index 0000000..5d6ab34 --- /dev/null +++ b/docs/build.7 | |||
@@ -0,0 +1,84 @@ | |||
1 | .TH build 1 "October 30, 2009" "Xagasoft" "Geekgene" | ||
2 | .SH NAME | ||
3 | .P | ||
4 | build.conf configuration files. | ||
5 | .SH SYNOPSIS | ||
6 | .P | ||
7 | These files describe how to build something, generally software from source | ||
8 | code, but it can really be anything. | ||
9 | .SH DESCRIPTION | ||
10 | .P | ||
11 | For now, I'm just going to list some things here, here are the functions | ||
12 | available to you for general use at the moment: | ||
13 | .TP | ||
14 | .B | ||
15 | dirs() | ||
16 | Takes any number of string parameters, matches the file system based on glob | ||
17 | patterns and returns all directories that match the given patterns. | ||
18 | .TP | ||
19 | .B | ||
20 | files() | ||
21 | Takes any number of string parameters, matches the file system based on glob | ||
22 | patterns and returns all files that match the given patterns. | ||
23 | .TP | ||
24 | .B | ||
25 | execute() | ||
26 | Takes one string parameter, and executes it as a command using your shell. | ||
27 | .TP | ||
28 | .B | ||
29 | exists() | ||
30 | Checks to see if the given file/directory/etc exists on the file system, if it | ||
31 | does, true is returned, otherwise, false. | ||
32 | .TP | ||
33 | .B | ||
34 | matches() | ||
35 | Checks the input of the function to see if it matches a given wildcard pattern, | ||
36 | the pattern may include any number of * (meaning match any number of any | ||
37 | character) or ? (meaning match one of any character) symbols. If the input is | ||
38 | a string, then true or false is returned. If the input is a list, a filtered | ||
39 | version of the list is returned, containing only the elements that matched the | ||
40 | pattern. | ||
41 | .TP | ||
42 | .B | ||
43 | replace() | ||
44 | Takes two string parameters and replaces all occurances of the first with the | ||
45 | second in the input string or list of strings. | ||
46 | .TP | ||
47 | .B | ||
48 | targets() | ||
49 | Returns a list of target outputs, this will return every output for any target | ||
50 | that it finds seperately, so targets with multiple outputs will be in the list | ||
51 | more than once. With no parametrs it returns a list of all explicitly defined | ||
52 | targets, with a string parameter it returns all targets that have the given | ||
53 | tag. | ||
54 | .TP | ||
55 | .B | ||
56 | toString() | ||
57 | Takes the input and converts it to a string, with no parameters it uses default | ||
58 | formatting, this means that for lists it puts a space between each element. | ||
59 | .TP | ||
60 | .B | ||
61 | unlink() | ||
62 | Unlinks (deletes) the given file or files from the filesystem. It can take any | ||
63 | number of string or string list parameters. | ||
64 | .TP | ||
65 | .B | ||
66 | getMakeDeps() | ||
67 | Returns a list of files ready for use in a requires statement from the stdout of the command provided in the only string parameter. The command should output the dependancies in makefile format. | ||
68 | .TP | ||
69 | .B | ||
70 | fileName() | ||
71 | Returns the file portion of the string provided as input. That is, it returns everything after the last '/' character. This may not always be a file, it could be a directory, or even just an arbitrary part of a string that may or may not have '/' in it. If the input ends with a slash this will return an empty string. | ||
72 | .TP | ||
73 | .B | ||
74 | dirName() | ||
75 | Returns the directory portion of the string provided as input. That is, it returns everything before the last '/' character. Read the caveat for fileName about what this really means. If the input ends with a slash this will return the entire string, except the trailing slash. | ||
76 | .P | ||
77 | Here, lets list functions we wish we had... | ||
78 | .SH ENVIRONMENT | ||
79 | .SH FILES | ||
80 | .SH CONFORMING TO | ||
81 | .SH NOTES | ||
82 | .SH BUGS | ||
83 | .SH EXAMPLE | ||
84 | .SH SEE ALSO | ||