View source for Shell (API)

The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
Shell (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.exit]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Exits the current shell</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.dir]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the directory</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setDir]]({{type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the directory</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.path]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the path</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setPath]]({{type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the path</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.resolve]]({{type|string}} localpath)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Resolves a local path to an absolute path.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.resolveProgram]]({{type|string}} name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Resolves the absolute path to the program whose name you provided.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.aliases]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns aliases.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setAlias]]({{type|string}} alias, {{type|string}} program)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets an alias.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.clearAlias]]({{type|string}} alias)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Clears an alias.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.programs]]([<nowiki></nowiki>{{type|boolean}} hidden])</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a {{type|table}} of programs.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.run]]({{type|string}} program, {{type|string}} arguments)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs a program.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.getRunningProgram]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the absolute path to the currently-executing program.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.openTab]]({{type|string}} program, {{type|string}} arguments)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs a program in another [[multishell]] tab. ''Requires version 1.6 or newer and an advanced computer.''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.switchTab]]({{type|number}} tab ID)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Switches the [[multishell]] tab to tab with the given ID.  ''Requires version 1.6 or newer and an advanced computer.''</td></tr>
</table>


[[Category:APIs]]