diff options
author | Mike Buland <eichlan@xagasoft.com> | 2011-06-03 15:01:55 +0000 |
---|---|---|
committer | Mike Buland <eichlan@xagasoft.com> | 2011-06-03 15:01:55 +0000 |
commit | 8c61a141f7ee6ca950f700c09bbb58e75c939607 (patch) | |
tree | 73d9d05b57288dbaf74347072f199205700508c4 /docs | |
parent | f16f239688b632fc54684c3e0e1430fd89a67db5 (diff) | |
download | build-8c61a141f7ee6ca950f700c09bbb58e75c939607.tar.gz build-8c61a141f7ee6ca950f700c09bbb58e75c939607.tar.bz2 build-8c61a141f7ee6ca950f700c09bbb58e75c939607.tar.xz build-8c61a141f7ee6ca950f700c09bbb58e75c939607.zip |
Updated the man file to include the new functions.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/build.7 | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/build.7 b/docs/build.7 index 5d6ab34..b9099de 100644 --- a/docs/build.7 +++ b/docs/build.7 | |||
@@ -1,4 +1,4 @@ | |||
1 | .TH build 1 "October 30, 2009" "Xagasoft" "Geekgene" | 1 | .TH build 1 "June 3, 2011" "Xagasoft" "Geekgene" |
2 | .SH NAME | 2 | .SH NAME |
3 | .P | 3 | .P |
4 | build.conf configuration files. | 4 | build.conf configuration files. |
@@ -73,6 +73,26 @@ Returns the file portion of the string provided as input. That is, it returns e | |||
73 | .B | 73 | .B |
74 | dirName() | 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. | 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 | .TP | ||
77 | .B | ||
78 | range() | ||
79 | Returns a list of numbers that fit in the specified range. There are three forms of this function, with one parameter it will produce a list of numbers between one and the number specified, inclusive. With two parameters the first is the starting number, the second is the last number in the range. With a third parameter you also specify the step size. At the moment the only way to make a list that is in decending order is to specify a negative step size. | ||
80 | .TP | ||
81 | .B | ||
82 | open() | ||
83 | Opens a file in the filesystem, creating it if it doesn't exist. This takes two parameters, first is the filename, second is the mode string. The mode is just a plain string that can contain any number of flag characters. The flags available are 'w' for write mode, and 'r' for read mode. You can specify both r and w. Open returns a file handle that needs to be used for all future file operations on that file. | ||
84 | .TP | ||
85 | .B | ||
86 | write() | ||
87 | Takes a file handle as it's input, and takes a string as it's parameter. The string is written to the file as is. If a parameter is specified that isn't a string, it will be converted to a string as best as it can be. | ||
88 | .TP | ||
89 | .B | ||
90 | read() | ||
91 | Takes a file handle as it's input, and takes an integer as it's parameter. The integer specified is how many bytes to read form the file. Up to that many bytes will be returned as a string, fewer if fewer are available. | ||
92 | .TP | ||
93 | .B | ||
94 | close() | ||
95 | Takes a file handle as it's input, and no parameters. Closes the file indicated by the handle provided as input. While it is reccomended to close all files as soon as you are done with them, any files left open will be closed automatically and safely before build exists. | ||
76 | .P | 96 | .P |
77 | Here, lets list functions we wish we had... | 97 | Here, lets list functions we wish we had... |
78 | .SH ENVIRONMENT | 98 | .SH ENVIRONMENT |