From 77da11b5e09820f8f5babac6d17ff35c0098c96e Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Thu, 23 Mar 2017 11:29:59 +0000 Subject: [PATCH] Add brief docs for command-line tools. --- doc/manual/dcpomatic.xml | 120 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index c35d35d4a..093de1792 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -2844,6 +2844,7 @@ purposes. + Encoding servers @@ -3009,6 +3010,124 @@ to the cinema which is showing your DCP. + + + Command-line tools + + + DCP-o-matic includes some tools which allow DCP creation from the + command line or from scripting languages. This chapter covers the + use of those tools. + + + + There are two command-line tools in DCP-o-matic. + dcpomatic2_create creates film directories, with the + associated metadata, from a list of content files. Then + dcpomatic2_cli runs the transcode process on these + film directories. + + + + Some applications will benefit from setting up the films using the + main DCP-o-matic GUI and then using dcpomatic2_cli to + do the encode. This allows, for example, setup on a relatively + low-powered machine before running the encode on a higher-powered + headless server. + + +
+ <code>dcpomatic2_create</code> + + + The syntax for dcpomatic2_create is: + + + + dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...] + + + + [CONTENT] are the files that you want to use in the + DCP (e.g. MP4 or MOV files). + + + + The options are: + + + + -v, --version — show DCP-o-matic version + -h, --help — show this help + -n, --name — <name> film name + -t, --template <name> — template name + -c, --dcp-content-type <type> — FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV + --container-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239 + --content-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239 + -s, --still-length <n> — number of seconds that still content should last + --standard <standard> — SMPTE or interop (default SMPTE) + --no-use-isdcf-name> — do not use an ISDCF name; use the specified name unmodified + --no-sign— do not sign the DCP + -o, --output <dir> — output directory + + + + For example, to setup a film using a MP4 file you might do: + + + + dcpomatic2_cli -o my_film --container-ratio 185 --content-ratio 185 -c FTR -n "My Film" Stuff.mp4 + + + + This will create a folder called my_film which is ready for a DCP to be made by dcpomatic2_cli. + + + + dcpomatic2_create will use any default settings that you have configured in the main DCP-o-matic preferences. + +
+ +
+ <code>dcpomatic2_cli</code> + + + The syntax for dcpomatic2_cli is: + + + + dcpomatic2_cli [OPTION] [FILM] + + + + + -v, --version — show DCP-o-matic version + -h, --help — show this help + -f, --flags — show flags passed to C++ compiler on build + -n, --no-progress — do not print progress to stdout + -r, --no-remote — do not use any remote servers + -t, --threads — specify number of local encoding threads (overriding configuration) + -j, --json <port> — run a JSON server on the specified port + -k, --keep-going — keep running even when the job is complete + -s, --servers — just display a list of encoding servers that DCP-o-matic is configured to use; don't encode + -d, --dcp-path — echo DCP's path to stdout on successful completion (implies -n) + --dump — just dump a summary of the film's settings; don't encode + + + + + For example, to encode a film called my_film you might do: + + + + dcpomatic2_cli my_film + +
+ + + + + Loose ends @@ -3043,6 +3162,7 @@ hashes. + Common tasks -- 2.30.2