Shell (API) - Revision history

Smiley43210: Changed variable names to maintain consistency

2015-08-14T12:31:19Z

Changed variable names to maintain consistency

Bomb Bloke: New 1.74 functions.

2015-08-02T00:51:30Z

New 1.74 functions.

MKlegoman357: Recreated table using {{API table}} tags

2014-04-08T19:00:32Z

Recreated table using {{API table}} tags

MKlegoman357: Rewrote some descriptions of some functions

2014-04-04T19:44:02Z

Rewrote some descriptions of some functions

MKlegoman357: renamed shell.programs optional argument

2014-04-04T19:25:54Z

renamed shell.programs optional argument

MKlegoman357: Added CC version in the note

2014-04-04T19:17:27Z

Added CC version in the note

Bomb Bloke: Wiki table.

2014-04-04T07:30:54Z

Wiki table.

Lyqyd: clarify shell.run parameters.

2014-04-02T22:54:21Z

clarify shell.run parameters.

Oeed: Removed NeedsWork tag

2014-03-28T11:14:38Z

Removed NeedsWork tag

Oeed: Added shell.switchTab and shell.openTab

2014-03-28T11:13:50Z

Added shell.switchTab and shell.openTab

@@ Line 93: / Line 93: @@
 {{API table/row
 |[[shell.complete]]({{type|string}} prefix)
-|{{type|table}} completion list
+|{{type|table}} completionList
 |Given a partial command line, returns a list of suffixes that could potentially be used to complete it.  ''Requires version 1.74 or newer.''}}
 {{API table/row
 |[[shell.completeProgram]]({{type|string}} prefix)
-|{{type|table}} completion list
+|{{type|table}} completionList
 |Given a partial script / directory path, returns a list of suffixes that could potentially be used to complete it, including [[shell.aliases|alias]] and [[shell.path|path]] matches.  ''Requires version 1.74 or newer.''
 |odd}}
 {{API table/row
-|[[shell.setCompletionFunction]]({{type|string}} path, {{type|function}} completion instructions)
+|[[shell.setCompletionFunction]]({{type|string}} path, {{type|function}} completionFunction)
 |{{type|nil}}
-|Registers a function that determines how [[shell.complete]]() handles completion behaviour for a given script. ''Requires version 1.74 or newer.''}}
+|Registers a function that determines how [[shell.complete]]() handles completion behavior for a given script. ''Requires version 1.74 or newer.''}}
 {{API table/row
 |[[shell.getCompletionInfo]]()
-|{{type|table}} completion functions
+|{{type|table}} completionFunctions
 |Returns a pointer to the table containing functions registered by [[shell.setCompletionFunction]]() for use with [[shell.complete]](). ''Requires version 1.74 or newer.''
 |odd}}

@@ Line 1: / Line 1: @@
 {{lowercase}}
-The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell]. The shell API is only available when programs are ran from the shell or using [[shell.run]]/[[shell.openTab]].
+The shell API allows you to interface with ComputerCraft's [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell] - [[CraftOS]]. The shell API is only available when programs are ran from the shell or using [[shell.run]]/[[shell.openTab]].
 ==API==
@@ Line 87: / Line 89: @@
 |{{type|nil}}
 |Switches the [[multishell]] tab to tab with the given ID.  ''Requires version 1.6 or newer and an advanced system.''
 |odd}}

@@ Line 1: / Line 1: @@
-The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].
+{{lowercase}}
 ==API==
-{| class="wikitable"
-! width="100px" | Returns
+{{API table|shell|image=Grid disk.png|2=
-! width="200px" | Method name
-! Description
+{{API table/row
-|-
-−
 |[[shell.exit]]()
 |Exits the current shell.
-|-
+|odd}}
-|{{type|string}} directory
 |[[shell.dir]]()
-|Returns the path to the working directory.
+|{{type|string}} directory
-|-
+|Returns the path to the working directory.}}
-−
 |[[shell.setDir]]({{type|string}} path)
 |Sets the working directory.
-|-
+|odd}}
-|{{type|string}} path
 |[[shell.path]]()
-|Returns the path.
+|{{type|string}} path
-|-
+|Returns the path.}}
-−
 |[[shell.setPath]]({{type|string}} path)
 |Sets the path.
-|-
+|odd}}
-|{{type|string}} path
-|[[shell.resolve]]({{type|string}} localpath)
+{{API table/row
-|Resolves a local path to an absolute path.
+|[[shell.resolve]]({{type|string}} localPath)
-|-
+|{{type|string}} absolutePath
-|{{type|string}} path
+|Resolves a local path to an absolute path.}}
 |[[shell.resolveProgram]]({{type|string}} name)
 |Resolves the absolute path to the program whose name you provided.
-|-
+|odd}}
-|{{type|table}} aliases
 |[[shell.aliases]]()
-|Returns aliases.
+|{{type|table}} aliases
-|-
+|Returns aliases.}}
-−
 |[[shell.setAlias]]({{type|string}} alias, {{type|string}} program)
-|Sets an alias.
+|{{type|nil}}
-|-
+|Sets an alias for ''program''.
+|odd}}
 |[[shell.clearAlias]]({{type|string}} alias)
-|Clears an alias.
+|{{type|nil}}
-|-
+|Clears an alias.}}
-|{{type|table}} programs
 |[[shell.programs]]([<nowiki/>{{type|boolean}} showHidden])
-|Returns a table of files in the current directory and in rom/programs.
+|{{type|table}} programs
-|-
+|Returns a table of files in the current directory and in all paths in [[shell.path]].
-|{{type|boolean}} success
+|odd}}
-|[[shell.run]]({{type|string}} command [, {{type|string}} args1, {{type|string}} args2, ...])
-|Runs a program.
-|-
+{{API table/row
-|{{type|string}} path
 |[[shell.getRunningProgram]]()
-|Returns the absolute path to the currently-executing program.
+|{{type|string}} path
-|-
+|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.''
+|{{type|number}} tabID
-|-
+|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.''
-|}
+|odd}}
 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 1.45, now also support a single string containing ''all'' parameters.
 [[Category:APIs]]

@@ Line 13: / Line 13: @@
 |{{type|string}} directory
 |[[shell.dir]]()
-|Returns the directory.
+|Returns the path to the working directory.
 |-
+|
 |[[shell.setDir]]({{type|string}} path)
-|Sets the directory.
+|Sets the working directory.
 |-
 |{{type|string}} path
@@ Line 49: / Line 49: @@
 |{{type|table}} programs
 |[[shell.programs]]([<nowiki/>{{type|boolean}} showHidden])
-|Returns a {{type|table}} of programs.
+|Returns a table of files in the current directory and in rom/programs.
 |-
 |{{type|boolean}} success
 |[[shell.run]]({{type|string}} command [, {{type|string}} args1, {{type|string}} args2, ...])
 |Runs a program.
 |-
 |{{type|string}} path

@@ Line 48: / Line 48: @@
 |-
 |{{type|table}} programs
-|[[shell.programs]]([<nowiki></nowiki>{{type|boolean}} hidden])
+|[[shell.programs]]([<nowiki/>{{type|boolean}} showHidden])
 |Returns a {{type|table}} of programs.
 |-

@@ Line 1: / Line 1: @@
 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;">
+==API==
-<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
+{| class="wikitable"
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
+! width="100px" | Returns
-Shell (API)
+! width="200px" | Method name
-</td></tr>
+! Description
-<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>
+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.
-−
-<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}} command)</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}} command)</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>
-−
-Note that [[shell.run]] and [[shell.openTab]] concatenate any arguments they are given with single space separator characters before parsing the command.  This is backwards compatible with scripts written when shell.run required one string argument for the program, and one per argument for that program, but accepts a single string with the entire command as well.
 [[Category:APIs]]

← Older revision		Revision as of 11:14, 28 March 2014
Line 1:		Line 1:
−	~~{{NeedsWork\|New 1.6 functions and changes should be added. - [[User:Oeed\|Oeed]] 06:02, 28 March 2014 (GMT)}}~~
−
	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].