summaryrefslogtreecommitdiffstats
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authorbruvzg <7645683+bruvzg@users.noreply.github.com>2022-01-17 14:53:28 +0200
committerbruvzg <7645683+bruvzg@users.noreply.github.com>2022-01-17 15:10:04 +0200
commit9faf1e027a26cb1207d635a45ab153502722ae54 (patch)
treefbdd6e2d99ffae32d68d131f1512c2781e8dc6c4 /doc/classes/OS.xml
parentd9a4ff7583c137b661c7347179a9b0f54696eef7 (diff)
downloadredot-engine-9faf1e027a26cb1207d635a45ab153502722ae54.tar.gz
[Documentation] Add instruction how to execute built-in commands of various shells.
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 42fa8f56a6..1c44967aba 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -140,6 +140,9 @@
[/csharp]
[/codeblocks]
[b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows.
+ [b]Note:[/b] To execute a Windows command interpreter built-in command, specify [code]cmd.exe[/code] in [code]path[/code], [code]/c[/code] as the first argument, and the desired command as the second argument.
+ [b]Note:[/b] To execute a PowerShell built-in command, specify [code]powershell.exe[/code] in [code]path[/code], [code]-Command[/code] as the first argument, and the desired command as the second argument.
+ [b]Note:[/b] To execute a Unix shell built-in command, specify shell executable name in [code]path[/code], [code]-c[/code] as the first argument, and the desired command as the second argument.
[b]Note:[/b] On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export.
</description>
</method>