shell |
Type | function |
Dictionary | LCS |
Library | LiveCode Script |
Syntax | the shell of <commandLine>
shell(<commandLine>)
|
Summary | Runs a shell command and returns its output.
|
Introduced | 1.0 |
Changes | Support for using the shell command on OS X systems was added in version
2.0.
|
OS | mac, windows, linux |
Platforms | desktop, server |
Parameters | Name | Type | Description |
---|
commandLine | | |
|
Example | local tMyList
put shell("ls -l *.txt") into tMyList
get shell(field "Command")
get shell("attrib main.rev +R")
get shell("say" && "hello world")
|
Values | Name | Type | Description |
---|
It | | The result of the commandLine, including any error messages the
commandLine generates. (On Unix systems, the stdout and
stderr are combined to create the return value.) The current
handler pauses until the shell function returns its result. If the command
was successful but did not return anything, the shell function
returns empty.
|
The result | | The shell function's exit code. If the exit code is 0 then empty is returned.
|
|
Related | Keyword: string, stderr, stdout
Property: hideConsoleWindows, defaultFolder, shellCommand
Command: launch
Function: screenName, shell
Control Structure: function
Glossary: property, error message, return value, handler, execute, OS X, return, file path, debug, Unix, command line
|
Description | Use the shell function to execute a command line.
The commandLine must be a valid shell command on the current
operating system. Use the shellCommand property to set the shell
you want to use. The command is executed in the current defaultFolder.
Note: If you use a file path in the shell command on a Windows
system, the file path must be in Windows form, not the Unix-style
file paths that LiveCode uses internally.
To prevent a console window from appearing when the shell command is
executed, set the hideConsoleWindows property to true.
Tip: If you are having problems with the shell function, try
executing the commandLine at your operating system's
shell prompt. (For example, on an OS X system, try executing
the commandLine in the Terminal window.) If a commandLine does not
work at the shell prompt, it won't work with the shell function
either, so trying this can be useful when debugging.
|