diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 522a00385af..89b33b3c1cf 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -87,7 +87,18 @@ - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + Execute the file at the given path, optionally blocking until it returns. + Platform path resolution will take place. The resolved file must exist and be executable. + Returns a process id. + For example: + [codeblock] + var output = [] + var pid = OS.execute('ls', [], true, output) + [/codeblock] + If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked. For example: + [codeblock] + var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + [/codeblock]