Update manual for new CLI options.
authorCarl Hetherington <cth@carlh.net>
Fri, 10 Mar 2023 21:19:30 +0000 (22:19 +0100)
committerCarl Hetherington <cth@carlh.net>
Fri, 10 Mar 2023 21:19:30 +0000 (22:19 +0100)
doc/manual/dcpomatic_cli.xml
doc/manual/dcpomatic_create.xml
doc/manual/dcpomatic_kdm_cli.xml

index 531ca813b3f4173c3fba8641d44117d74a0393b0..debf6259f2ee0758cd2057bcde1cb5b000bd1178 100644 (file)
@@ -13,5 +13,9 @@
 <listitem><code>-d</code>, <code>--dcp-path</code> &#8212; echo DCP's path to stdout on successful completion (implies -n)</listitem>
 <listitem><code>-c</code>, <code>--config &lt;dir&gt;</code> &#8212; directory containing config.xml and cinemas.xml</listitem>
 <listitem><code>--dump</code> &#8212; just dump a summary of the film's settings; don't encode</listitem>
 <listitem><code>-d</code>, <code>--dcp-path</code> &#8212; echo DCP's path to stdout on successful completion (implies -n)</listitem>
 <listitem><code>-c</code>, <code>--config &lt;dir&gt;</code> &#8212; directory containing config.xml and cinemas.xml</listitem>
 <listitem><code>--dump</code> &#8212; just dump a summary of the film's settings; don't encode</listitem>
+<listitem><code>--no-check</code> &#8212; don't check project's content files for changes before making the DCP</listitem>
+<listitem><code>--export-format &lt;format&gt;</code> &#8212; export project to a file, rather than making a DCP: specify mov or mp4</listitem>
+<listitem><code>--export-filename &lt;filename&gt;</code> &#8212; filename to export to with --export-format</listitem>
+<listitem><code>--hints</code> &#8212; analyze film for hints before encoding and abort if any are found</listitem>
 </itemizedlist>
 </para>
\ No newline at end of file
 </itemizedlist>
 </para>
\ No newline at end of file
index 215a131d939c0e9fd32f6fabb09d9fe3a3696a44..0aa8b4f48e572af124696745870488080d44c353 100644 (file)
@@ -8,17 +8,20 @@
 <listitem><code>-c</code>, <code>--dcp-content-type &lt;type&gt;</code> &#8212; FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV</listitem>
 <listitem><code>-f</code>, <code>--dcp-frame-rate &lt;rate&gt;</code> &#8212; set DCP video frame rate (otherwise guessed from content)</listitem>
 <listitem><code>--container-ratio &lt;ratio&gt;</code> &#8212; 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
 <listitem><code>-c</code>, <code>--dcp-content-type &lt;type&gt;</code> &#8212; FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV</listitem>
 <listitem><code>-f</code>, <code>--dcp-frame-rate &lt;rate&gt;</code> &#8212; set DCP video frame rate (otherwise guessed from content)</listitem>
 <listitem><code>--container-ratio &lt;ratio&gt;</code> &#8212; 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
-<listitem><code>--content-ratio &lt;ratio&gt;</code> &#8212; 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
 <listitem><code>-s</code>, <code>--still-length &lt;n&gt;</code> &#8212; number of seconds that still content should last</listitem>
 <listitem><code>--standard &lt;standard&gt;</code> &#8212; SMPTE or interop (default SMPTE)</listitem>
 <listitem><code>--no-use-isdcf-name</code> &#8212; do not use an ISDCF name; use the specified name unmodified</listitem>
 <listitem><code>-s</code>, <code>--still-length &lt;n&gt;</code> &#8212; number of seconds that still content should last</listitem>
 <listitem><code>--standard &lt;standard&gt;</code> &#8212; SMPTE or interop (default SMPTE)</listitem>
 <listitem><code>--no-use-isdcf-name</code> &#8212; do not use an ISDCF name; use the specified name unmodified</listitem>
-<listitem><code>--no-sign</code> &#8212; do not sign the DCP</listitem>
 <listitem><code>--config &lt;dir&gt;</code> &#8212; directory containing config.xml and cinemas.xml</listitem>
 <listitem><code>--config &lt;dir&gt;</code> &#8212; directory containing config.xml and cinemas.xml</listitem>
-<listitem><code>--fourk</code> &#8212; make a 4K DCP rather than a 2K one</listitem>
+<listitem><code>--twok</code> &#8212; make a 2K DCP instead of choosing a resolution based on the content</listitem>
+<listitem><code>--fourk</code> &#8212; make a 4K DCP instead of choosing a resolution based on the content</listitem>
 <listitem><code>-o</code>, <code>--output &lt;dir&gt;</code> &#8212; output directory</listitem>
 <listitem><code>--threed</code> &#8212; make a 3D DCP</listitem>
 <listitem><code>--j2k-bandwidth &lt;Mbit/s&gt;</code> &#8212; J2K bandwidth in Mbit/s</listitem>
 <listitem><code>--left-eye</code> &#8212; next piece of content is for the left eye</listitem>
 <listitem><code>--right-eye</code> &#8212; next piece of content is for the right eye</listitem>
 <listitem><code>-o</code>, <code>--output &lt;dir&gt;</code> &#8212; output directory</listitem>
 <listitem><code>--threed</code> &#8212; make a 3D DCP</listitem>
 <listitem><code>--j2k-bandwidth &lt;Mbit/s&gt;</code> &#8212; J2K bandwidth in Mbit/s</listitem>
 <listitem><code>--left-eye</code> &#8212; next piece of content is for the left eye</listitem>
 <listitem><code>--right-eye</code> &#8212; next piece of content is for the right eye</listitem>
+<listitem><code>--channel &lt;channel&gt;</code> &#8212; next piece of content should be mapped to audio channel L, R, C, Lfe, Ls or Rs</listitem>
+<listitem><code>--gain</code> &#8212; next piece of content should have the given audio gain (in dB)</listitem>
+<listitem><code>--cpl &lt;id&gt;</code> &#8212; CPL ID to use from the next piece of content (which is a DCP)</listitem>
+<listitem><code>--kdm &lt;file&gt;</code> &#8212; KDM for next piece of content</listitem>
 </itemizedlist>
 </para>
\ No newline at end of file
 </itemizedlist>
 </para>
\ No newline at end of file
index 283763a34eaaedd9497a4ae8f49d4f55021e9e3b..fc5635959ca78a4d2f9a7b5044199fbb0e91abcc 100644 (file)
@@ -8,12 +8,13 @@
 <listitem><code>-t</code>, <code>--valid-to</code> &#8212; valid to time (in local time zone of the cinema) (e.g. &#8220;2014-09-28 01:41:51&#8221;)</listitem>
 <listitem><code>-d</code>, <code>--valid-duration</code> &#8212; valid duration (e.g. &#8220;1 day&#8221;, &#8220;4 hours&#8221;, &#8220;2 weeks&#8221;)</listitem>
 <listitem><code>-F</code>, <code>--formulation</code> &#8212; modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]</listitem>
 <listitem><code>-t</code>, <code>--valid-to</code> &#8212; valid to time (in local time zone of the cinema) (e.g. &#8220;2014-09-28 01:41:51&#8221;)</listitem>
 <listitem><code>-d</code>, <code>--valid-duration</code> &#8212; valid duration (e.g. &#8220;1 day&#8221;, &#8220;4 hours&#8221;, &#8220;2 weeks&#8221;)</listitem>
 <listitem><code>-F</code>, <code>--formulation</code> &#8212; modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]</listitem>
-<listitem><code>-a</code>, <code>--disable-forensic-marking-picture</code> &#8212; disable forensic marking of pictures essences</listitem>
+<listitem><code>-p</code>, <code>--disable-forensic-marking-picture</code> &#8212; disable forensic marking of pictures essences</listitem>
 <listitem><code>-a</code>, <code>--disable-forensic-marking-audio</code> &#8212; disable forensic marking of audio essences (optionally above a given channel, e.g 12)</listitem>
 <listitem><code>-a</code>, <code>--disable-forensic-marking-audio</code> &#8212; disable forensic marking of audio essences (optionally above a given channel, e.g 12)</listitem>
+<listitem><code>-e</code>, <code>--email</code> &#8212; email KDMs to cinemas</listitem>
 <listitem><code>-z</code>, <code>--zip</code> &#8212; ZIP each cinema's KDMs into its own file</listitem>
 <listitem><code>-v</code>, <code>--verbose</code> &#8212; be verbose</listitem>
 <listitem><code>-z</code>, <code>--zip</code> &#8212; ZIP each cinema's KDMs into its own file</listitem>
 <listitem><code>-v</code>, <code>--verbose</code> &#8212; be verbose</listitem>
-<listitem><code>-c</code>, <code>--cinema</code> &#8212; specify a cinema, either by name or email address</listitem>
-<listitem><code>-S</code>, <code>--screen</code> &#8212; screen description</listitem>
+<listitem><code>-c</code>, <code>--cinema</code> &#8212; cinema name (when using -C) or name/email (to filter cinemas)</listitem>
+<listitem><code>-S</code>, <code>--screen</code> &#8212; screen name (when using -C) or screen name (to filter screens when using -c)</listitem>
 <listitem><code>-C</code>, <code>--certificate</code> &#8212; file containing projector certificate</listitem>
 <listitem><code>-T</code>, <code>--trusted-device</code> &#8212; file containing a trusted device's certificate</listitem>
 <listitem><code>--list-cinemas</code> &#8212; list known cinemas from the DCP-o-matic settings</listitem>
 <listitem><code>-C</code>, <code>--certificate</code> &#8212; file containing projector certificate</listitem>
 <listitem><code>-T</code>, <code>--trusted-device</code> &#8212; file containing a trusted device's certificate</listitem>
 <listitem><code>--list-cinemas</code> &#8212; list known cinemas from the DCP-o-matic settings</listitem>