Fix manual build.
authorCarl Hetherington <cth@carlh.net>
Tue, 7 May 2019 10:35:07 +0000 (11:35 +0100)
committerCarl Hetherington <cth@carlh.net>
Tue, 7 May 2019 10:35:46 +0000 (11:35 +0100)
doc/manual/.gitignore
doc/manual/Makefile
doc/manual/dcpomatic_cli.xml [new file with mode: 0644]
doc/manual/dcpomatic_create.xml [new file with mode: 0644]
doc/manual/dcpomatic_kdm_cli.xml [new file with mode: 0644]
run/dcpomatic_kdm_cli

index 8b8714f..e69de29 100644 (file)
@@ -1,3 +0,0 @@
-dcpomatic_create.xml
-dcpomatic_kdm_cli.xml
-dcpomatic_cli.xml
\ No newline at end of file
index 8e19040..f712049 100644 (file)
@@ -68,6 +68,9 @@ diagrams/%.pdf:       diagrams/%.svg
 config.xml:    ../../src/lib/config.cc config.py
        python3 config.py ../../src/lib/config.cc > config.xml
 
+# These require the tools to be runnable, so make needs to be run
+# in a built tree to update them.  The .xml files are committed
+# to git to avoid this always being necessary.
 dcpomatic_create.xml:  ../../src/tools/dcpomatic_create.cc cli.py
        python3 cli.py dcpomatic_create > dcpomatic_create.xml
 
diff --git a/doc/manual/dcpomatic_cli.xml b/doc/manual/dcpomatic_cli.xml
new file mode 100644 (file)
index 0000000..531ca81
--- /dev/null
@@ -0,0 +1,17 @@
+<para>
+<itemizedlist>
+<listitem><code>-v</code>, <code>--version</code> &#8212; show DCP-o-matic version</listitem>
+<listitem><code>-h</code>, <code>--help</code> &#8212; show this help</listitem>
+<listitem><code>-f</code>, <code>--flags</code> &#8212; show flags passed to C++ compiler on build</listitem>
+<listitem><code>-n</code>, <code>--no-progress</code> &#8212; do not print progress to stdout</listitem>
+<listitem><code>-r</code>, <code>--no-remote</code> &#8212; do not use any remote servers</listitem>
+<listitem><code>-t</code>, <code>--threads</code> &#8212; specify number of local encoding threads (overriding configuration)</listitem>
+<listitem><code>-j</code>, <code>--json &lt;port&gt;</code> &#8212; run a JSON server on the specified port</listitem>
+<listitem><code>-k</code>, <code>--keep-going</code> &#8212; keep running even when the job is complete</listitem>
+<listitem><code>-s</code>, <code>--servers &lt;file&gt;</code> &#8212; specify servers to use in a text file</listitem>
+<listitem><code>-l</code>, <code>--list-servers</code> &#8212; just display a list of encoding servers that DCP-o-matic is configured to use; 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>
+</itemizedlist>
+</para>
\ No newline at end of file
diff --git a/doc/manual/dcpomatic_create.xml b/doc/manual/dcpomatic_create.xml
new file mode 100644 (file)
index 0000000..215a131
--- /dev/null
@@ -0,0 +1,24 @@
+<para>
+<itemizedlist>
+<listitem><code>-v</code>, <code>--version</code> &#8212; show DCP-o-matic version</listitem>
+<listitem><code>-h</code>, <code>--help</code> &#8212; show this help</listitem>
+<listitem><code>-n</code>, <code>--name &lt;name&gt;</code> &#8212; film name</listitem>
+<listitem><code>-t</code>, <code>--template &lt;name&gt;</code> &#8212; template name</listitem>
+<listitem><code>-e</code>, <code>--encrypt</code> &#8212; make an encrypted DCP</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>--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>--fourk</code> &#8212; make a 4K DCP rather than a 2K one</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>
+</itemizedlist>
+</para>
\ No newline at end of file
diff --git a/doc/manual/dcpomatic_kdm_cli.xml b/doc/manual/dcpomatic_kdm_cli.xml
new file mode 100644 (file)
index 0000000..283763a
--- /dev/null
@@ -0,0 +1,22 @@
+<para>
+<itemizedlist>
+<listitem><code>-h</code>, <code>--help</code> &#8212; show this help</listitem>
+<listitem><code>-o</code>, <code>--output</code> &#8212; output file or directory</listitem>
+<listitem><code>-K</code>, <code>--filename-format</code> &#8212; filename format for KDMs</listitem>
+<listitem><code>-Z</code>, <code>--container-name-format</code> &#8212; filename format for ZIP containers</listitem>
+<listitem><code>-f</code>, <code>--valid-from</code> &#8212; valid from time (in local time zone of the cinema) (e.g. &#8220;2013-09-28 01:41:51&#8221;) or &#8220;now&#8221;</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>-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>-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>--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>--list-dkdm-cpls</code> &#8212; list CPLs for which DCP-o-matic has DKDMs</listitem>
+</itemizedlist>
+</para>
\ No newline at end of file
index ce32ef5..0f75232 100755 (executable)
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"/..
+
 export LD_LIBRARY_PATH=build/src/lib:/home/c.hetherington/lib:$LD_LIBRARY_PATH:build/src
 if [ "$1" == "--debug" ]; then
     shift