Difference between revisions of "UM:Cli Index"
From DigitalVision
m (Text replacement - "|Platform:" to "|UM:") |
m (Text replacement - "Platform:" to "UM:") |
||
| Line 9: | Line 9: | ||
<p class="p_DVBodyText"><span class="f_DVBodyText">The CLI supports many of the operations that can be performed interactively using the GUI interface:</span></p> | <p class="p_DVBodyText"><span class="f_DVBodyText">The CLI supports many of the operations that can be performed interactively using the GUI interface:</span></p> | ||
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p> | <p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p> | ||
| − | <div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_ListItemIndented">[[ | + | <div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_ListItemIndented">[[UM:Cli_Cli_Project|Project Definition ]]</span><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Project|and Creation]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Composition|Composition Definition and Creation]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Clip_Import|Importing Clips to the Library]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Version|Adding a Version]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Clip_Splice_Overwrite|Splicing or Overwriting Clips to a Composition]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Edl_Import_And_Conform|EDL Import and Conform]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Capture_Conform|Capturing and Conforming Material]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Generate_Proxies|Generating Local Proxies]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Export|Rendering a Composition via Export]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Render_Output|Rendering a Composition Cache]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Opsfile|Running Multiple Operations from a File]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Information|Listing Project and Composition Information]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Count_And_Add|Counting and Adding Tracks to Existing Compositions]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Lock|Testing for a GUI Lock]]</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">[[UM:Cli_Cli_Format_Spec_Definition|Project Format Specification]]</span></td></tr></table></div><p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p> |
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #d50000; border-spacing:10px;"> | <div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #d50000; border-spacing:10px;"> | ||
<tr style="text-align:left;vertical-align:middle;"> | <tr style="text-align:left;vertical-align:middle;"> | ||
Revision as of 12:10, 15 October 2014
Command Line
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
