Difference between revisions of "UM:Cli Index"
m (Text replacement - "Platform:" to "UM:") |
|||
Line 1: | Line 1: | ||
<div class="manualcontent"> | <div class="manualcontent"> | ||
− | {{Template:M-Navlinks-top|UM:Manual|UM: | + | {{Template:M-Navlinks-top|UM:Manual|UM:ACES|UM:Cli_User_Login}} |
{{Template:M-Title|Command Line}} | {{Template:M-Title|Command Line}} | ||
Line 48: | Line 48: | ||
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p> | <p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p> | ||
− | {{Template:M-Navlinks-bottom|UM:Manual|UM: | + | {{Template:M-Navlinks-bottom|UM:Manual|UM:ACES|UM:Cli_User_Login}} |
</div> | </div> |
Latest revision as of 16:49, 27 June 2016
The Command Line Interface (CLI) lets you run application commands without starting up the application interface (GUI). The CLI is therefore useful for automating tasks that do not require an operator to be present.
The CLI supports many of the operations that can be performed interactively using the GUI interface:
Be careful to quote any strings or paths you use on the command line. In particular, pay attention to any spaces in strings or paths or you will see syntax errors i.e.
The argument :
--format-spec C:\data files\specs\test.spec
Will give an error due to the space in the "data files" folder. Quote this to prevent the error :
--format-spec "C:\data files\specs\test.spec" |
Conventions
Required parameters are given in angled brackets <> i.e.
--format-spec <path>
Optional parameters are given in square brackets [] i.e.
--timecode-header [1|2]
Possible values are separated with a vertical bar (| as above).
Splitting Long Lines
This document sometimes splits long command lines over multiple lines to make the command easier to read. The split if delimited by a line-continuation character "\" i.e.
--export S:\exp\$o\$c..dpx \
--export-mode single
In reality, you would type the above command on a single line only without the continuation character :
--export S:\exp\$o\$c..dpx --export-mode single