Difference between revisions of "Shell.aliases"

From ComputerCraft Wiki
Jump to: navigation, search
m (Actually explained what this function does.)
 
Line 3: Line 3:
 
|name=shell.aliases
 
|name=shell.aliases
 
|api=Shell
 
|api=Shell
|returns=A table containing default and set aliases.
+
|returns=A table containing default and user-specified program aliases.
 
|addon=ComputerCraft
 
|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=
 
|examples=
 
{{Example
 
{{Example
 
|desc=This code will return all set aliases and the programs they refer to.
 
|desc=This code will return all set aliases and the programs they refer to.
|code= for k,v in pairs(shell.aliases()) do<br/>  print(k.." : "..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]]
 
[[Category:API_Functions]]

Latest revision as of 00:11, 8 July 2013


Grid Redstone.png  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

Examples

Grid paper.png  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