LumeWeb
/
filer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More Readme fixes

This commit is contained in:
David Humphrey (:humph) david.humphrey@senecacollege.ca 2014-02-19 15:27:58 -05:00
parent 4308e2d9ca
commit 80300fc92d
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1064,12 +1064,13 @@ sh.ls('/dir', { recursive: true }, function(err, entries) {
#### sh.exec(path, [options], callback)<a name="exec"></a> #### sh.exec(path, [options], callback)<a name="exec"></a>
Attempts to Execute the .js command located at `path`. Such commands Attempts to execute the .js command located at `path`. Such commands
should be written so as to assume the existence of 3 global variables, should be written so as to assume the existence of 3 global variables,
which will be defined at runtime: which will be defined at runtime:
* `options` - <Object> an object containing any arguments, data, etc. * `options` - <Object> an object containing any arguments, data, etc.
* `fs` - <FileSystem> the `FileSystem` object bound to this shell. * `fs` - <FileSystem> the `FileSystem` object bound to this shell.
* `callback` - <Function> a callback function(error, result) to call when done. * `callback` - <Function> a callback function of the form `function callback(error, result)`
to call when done.
The .js command's contents should be the body of a function that The .js command's contents should be the body of a function that
looks like this: looks like this:
@ -1097,6 +1098,7 @@ fs.writeFile('/cmd.js', cmd, callback(err) {
if(err) throw err; if(err) throw err;
}); });
}); });
```
#### sh.touch(path, [options], callback)<a name="touch"></a> #### sh.touch(path, [options], callback)<a name="touch"></a>