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

Readme fixes

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

9
README.md
View File

@ -941,7 +941,7 @@ var sh = new Filer.FileSystemShell(fs, options);
``` ```
The `FileSystemShell` can take an optional `options` object. The `options` object The `FileSystemShell` can take an optional `options` object. The `options` object
can include `env`, which is a set of environment variables. Currently support variables can include `env`, which is a set of environment variables. Currently supported variables
include `TMP` (the path to the temporary directory), and `PATH` (the list of known paths): include `TMP` (the path to the temporary directory), and `PATH` (the list of known paths):
```javascript ```javascript
@ -994,15 +994,15 @@ var sh = fs.Shell();
* [sh.cd(path, callback)](#cd) * [sh.cd(path, callback)](#cd)
* [sh.ls(dir, [options], callback)](#ls) * [sh.ls(dir, [options], callback)](#ls)
* [sh.exec(path, [options], callback)][#exec) * [sh.exec(path, [options], callback)](#exec)
* [sh.touch(path, [options], callback)[#touch) * [sh.touch(path, [options], callback)](#touch)
* [sh.cat(files, callback)](#cat) * [sh.cat(files, callback)](#cat)
* [sh.rm(path, [options], callback)](#rm) * [sh.rm(path, [options], callback)](#rm)
* [sh.tempDir(callback)](#tempDir) * [sh.tempDir(callback)](#tempDir)
#### sh.cd(path, callback)<a name="cd"></a> #### sh.cd(path, callback)<a name="cd"></a>
Changes the current working directory to directory at `path`. The callback returns Changes the current working directory to the directory at `path`. The callback returns
an error if `path` does not exist, or is not a directory. Once the callback occurs an error if `path` does not exist, or is not a directory. Once the callback occurs
the shell's `cwd` property is updated to the new path (as well as `sh.env.PWD`). the shell's `cwd` property is updated to the new path (as well as `sh.env.PWD`).
@ -1013,6 +1013,7 @@ sh.cd('/dir1', function(err) {
if(err) throw err; if(err) throw err;
// sh.cwd is now '/dir1' // sh.cwd is now '/dir1'
}); });
```
#### sh.ls(dir, [options], callback)<a name="ls"></a> #### sh.ls(dir, [options], callback)<a name="ls"></a>