Difference between revisions of "Shell (API)"
From ComputerCraft Wiki
m (clarify shell.run parameters.) |
Bomb Bloke (Talk | contribs) (Wiki table.) |
||
| Line 1: | Line 1: | ||
The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell]. | The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell]. | ||
| − | + | ==API== | |
| − | + | {| class="wikitable" | |
| − | [[ | + | ! width="100px" | Returns |
| − | + | ! width="200px" | Method name | |
| − | < | + | ! Description |
| + | |- | ||
| + | | | ||
| + | |[[shell.exit]]() | ||
| + | |Exits the current shell. | ||
| + | |- | ||
| + | |{{type|string}} directory | ||
| + | |[[shell.dir]]() | ||
| + | |Returns the directory. | ||
| + | |- | ||
| + | | | ||
| + | |[[shell.setDir]]({{type|string}} path) | ||
| + | |Sets the directory. | ||
| + | |- | ||
| + | |{{type|string}} path | ||
| + | |[[shell.path]]() | ||
| + | |Returns the path. | ||
| + | |- | ||
| + | | | ||
| + | |[[shell.setPath]]({{type|string}} path) | ||
| + | |Sets the path. | ||
| + | |- | ||
| + | |{{type|string}} path | ||
| + | |[[shell.resolve]]({{type|string}} localpath) | ||
| + | |Resolves a local path to an absolute path. | ||
| + | |- | ||
| + | |{{type|string}} path | ||
| + | |[[shell.resolveProgram]]({{type|string}} name) | ||
| + | |Resolves the absolute path to the program whose name you provided. | ||
| + | |- | ||
| + | |{{type|table}} aliases | ||
| + | |[[shell.aliases]]() | ||
| + | |Returns aliases. | ||
| + | |- | ||
| + | | | ||
| + | |[[shell.setAlias]]({{type|string}} alias, {{type|string}} program) | ||
| + | |Sets an alias. | ||
| + | |- | ||
| + | | | ||
| + | |[[shell.clearAlias]]({{type|string}} alias) | ||
| + | |Clears an alias. | ||
| + | |- | ||
| + | |{{type|table}} programs | ||
| + | |[[shell.programs]]([<nowiki></nowiki>{{type|boolean}} hidden]) | ||
| + | |Returns a {{type|table}} of programs. | ||
| + | |- | ||
| + | |{{type|boolean}} success | ||
| + | |[[shell.run]]({{type|string}} command [, {{type|string}} args1, {{type|string}} args2, ...]) | ||
| + | |Runs a program. | ||
| + | |- | ||
| + | |{{type|string}} path | ||
| + | |[[shell.getRunningProgram]]() | ||
| + | |Returns the absolute path to the currently-executing program. | ||
| + | |- | ||
| + | |{{type|number}} newTabID | ||
| + | |[[shell.openTab]]({{type|string}} command [, {{type|string}} args1, {{type|string}} args2, ...]) | ||
| + | |Runs a program in another [[multishell]] tab. ''Requires version 1.6 or newer and an advanced system.'' | ||
| + | |- | ||
| + | | | ||
| + | |[[shell.switchTab]]({{type|number}} tabID) | ||
| + | |Switches the [[multishell]] tab to tab with the given ID. ''Requires version 1.6 or newer and an advanced system.'' | ||
| + | |} | ||
| − | + | Note that [[shell.run]] and [[shell.openTab]] concatenate any arguments they are given (with single space separator characters) before parsing the command, and as of ComputerCraft version ''???'', now also support a single string containing ''all'' parameters. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | Note that [[shell.run]] and [[shell.openTab]] concatenate any arguments they are given with single space separator characters before parsing the command | + | |
[[Category:APIs]] | [[Category:APIs]] | ||
Revision as of 07:30, 4 April 2014
The shell API allows you to interface with the shell.
API
| Returns | Method name | Description |
|---|---|---|
| shell.exit() | Exits the current shell. | |
| string directory | shell.dir() | Returns the directory. |
| shell.setDir(string path) | Sets the directory. | |
| string path | shell.path() | Returns the path. |
| shell.setPath(string path) | Sets the path. | |
| string path | shell.resolve(string localpath) | Resolves a local path to an absolute path. |
| string path | shell.resolveProgram(string name) | Resolves the absolute path to the program whose name you provided. |
| table aliases | shell.aliases() | Returns aliases. |
| shell.setAlias(string alias, string program) | Sets an alias. | |
| shell.clearAlias(string alias) | Clears an alias. | |
| table programs | shell.programs([boolean hidden]) | Returns a table of programs. |
| boolean success | shell.run(string command [, string args1, string args2, ...]) | Runs a program. |
| string path | shell.getRunningProgram() | Returns the absolute path to the currently-executing program. |
| number newTabID | shell.openTab(string command [, string args1, string args2, ...]) | Runs a program in another multishell tab. Requires version 1.6 or newer and an advanced system. |
| shell.switchTab(number tabID) | Switches the multishell tab to tab with the given ID. Requires version 1.6 or newer and an advanced system. |
Note that shell.run and shell.openTab concatenate any arguments they are given (with single space separator characters) before parsing the command, and as of ComputerCraft version ???, now also support a single string containing all parameters.
