Difference between revisions of "Shell.aliases"

Latest revision as of 00:11, 8 July 2013

Function shell.aliases
Returns a table containing the default aliases and any user-specified aliases. The key of each entry is the 'alias name', and the value the physical program.
Syntax	shell.aliases()
Returns	A table containing default and user-specified program aliases.
Part of	ComputerCraft
API	Shell

Example
This code will return all set aliases and the programs they refer to.
Code	for alias, programName in pairs(shell.aliases()) do print(alias .. " => " .. programName) end
Output	mv => move dir => list cp => copy rm => delete ls => list

@@ Line 2: / Line 2: @@
 {{Function
 |name=shell.aliases
-|args=[[string]] path
 |api=Shell
-|returns=A table containing default and set aliases. If a path is specified, it will return a table in which all the contents are part of that specific api/path
+|returns=A table containing default and user-specified program aliases.
 |addon=ComputerCraft
-|desc=Returns a table containing the default aliases and user specified aliases
+|desc=Returns a table containing the default aliases and any user-specified aliases. The key of each entry is the 'alias name', and the value the physical program.
 |examples=
 {{Example
-|desc=This code will define a path, 'fs', for shell.aliases to use. This wll return all functions relating to the 'fs' api
+|desc=This code will return all set aliases and the programs they refer to.
-|code= for k,v in pairs(shell.aliases("fs")) do<br/>   print(v)<br/>end
+|code= for alias, programName in pairs(shell.aliases()) do<br/>   print(alias .. " => " .. programName)<br/>end
-}}
+|output=<pre>mv => move
+dir => list
+cp => copy
+rm => delete
+ls => list</pre>}}
 }}
 [[Category:API_Functions]]