From: Carl Hetherington Date: Sat, 6 Jan 2018 00:51:49 +0000 (+0000) Subject: Some manual updates. X-Git-Tag: v2.11.37~3 X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=01bb80e78c1b238e12485429931d9df702faa57b Some manual updates. --- diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index bd42747de..bc368f91d 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -116,24 +116,22 @@ Windows version. DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and -higher. To install it, download the .dmg from http://dcpomatic.com/ and double -click to open it. Then drag the DCP-o-matics icon to your -Applications folder or wherever else you would -like to install it. +higher. DCP-o-matic is split into four separate applications, each of +which can be installed by downloading the .dmg, +double-clicking to open and then dragging the icon to your +Applications folder. -You do not have to install all the applications, but you must always -install DCP-o-matic 2.app as the other applications -depend on it. +If you are not sure which parts of DCP-o-matic to install, start +with the first (main) part.
-Debian or Ubuntu Linux +Debian, Ubuntu or Mint Linux You can install DCP-o-matic on: @@ -143,9 +141,12 @@ depend on it. Debian 7 (‘wheezy’) Debian 8 (‘jessie’) Debian unstable (‘sid’) - Ubuntu 12.04 (‘Precise Pangolin’) Ubuntu 14.04 (‘Trusty Tahr’) Ubuntu 16.04 (‘Xenial Xerus’) + Ubuntu 17.04 (‘Zesty Zapus’) + Ubuntu 17.10 (‘Artful Aardvark’) + Mint 17 + Mint 18 @@ -160,25 +161,14 @@ pieces and set DCP-o-matic up for you.
- Fedora Linux + Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 22 and 23 on + There are .rpm packages for Fedora 25, 26 and 27, Centos 6 and 7 and Mageia 6 on http://dcpomatic.com/
- - -
- Centos Linux - There are .rpm packages for Centos 5, 6.5 and 7 on - http://dcpomatic.com/ - -
- - -
Arch Linux @@ -272,7 +262,7 @@ DCP-o-matic. We will gloss over the details and look at the basics. Let's make a very simple DCP to see how DCP-o-matic works. First, we need some content. Download the low-resolution trailer for the open movie Sintel from their +url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their website. Generally one would want to use the highest-resolution material available, but for this test we will use the low-resolution version to save everyone's bandwidth bills. @@ -378,15 +368,7 @@ the right of the window, as shown in . Dragging the slider will move through your video. You can also click -the Play button to play the content back. Note -that there will be no sound, and playback might not be entirely -accurate (it may be slightly slower or faster than it should be, for -example). This player is really only intended for brief inspection of -content; if you need to check it more thoroughly, use another player -such as Totem, mplayer or -VLC. +the Play button to play the content back.
@@ -529,7 +511,7 @@ to take existing DCPs and modify them in various ways. If you want to do something to an existing DCP the first step is to -import it. Click Add folder... and select your +import it. Click Add DCP... and select your DCP's folder. It will be added to the DCP-o-matic project. If the DCP is unencrypted you can preview it in the normal way, though playback will be very slow as decoding of DCPs is almost as @@ -542,7 +524,7 @@ another DCP's assets, you should import it as follows: -Use Add folder... to import the VF DCP. +Use Add DCP... to import the VF DCP. The VF DCP will be added to the content list and marked “NEEDS OV”. Right-click on the VF DCP in the content list and choose Add OV... from the menu. @@ -580,8 +562,8 @@ and they can create a KDM to allow DCP-o-matic to decrypt their DCP. Once you have your KDM, right-click the DCP's name in DCP-o-matic and -choose Add KDM.... Specify your KDM and (all -being well) the DCP will be decrypted and become available for preview. +choose Add KDM.... Specify your KDM and the DCP +will be decrypted and become available for preview.
@@ -747,11 +729,15 @@ To add one or more movie, sound, still-image or subtitle files, select -To add a directory (folder) of images or a DCP, choose Add -folder... and choose the directory from the selector. If -you select a folder of images DCP-o-matic will open a small dialogue -box where you can enter the frame rate that the image sequence should -be run at. +To add a directory (folder) of images, choose Add +folder... and choose the directory from the selector. +DCP-o-matic will open a small dialogue box where you can enter the +frame rate that the image sequence should be run at. + + + +To add a DCP, choose Add DCP... and choose the +DCP's directory from the selector. @@ -1176,7 +1162,7 @@ shows the mapping of a 5.1 source into a 5.1 DCP. Other controls -The Refer to existing DCP checkbox isonly +The Refer to existing DCP checkbox is only applicable if the selected content is an existing DCP. It allows you to get the audio content from the existing DCP by referencing it (rather than copying). See . @@ -1264,7 +1250,7 @@ DCP-o-matic can either: Extract subtitles that are embedded in video files, or Use subtitles from SubRip (.srt), SubStation - Alpha (.ssa) or DCP XML files. You may find the great + Alpha (.ssa or .ass) or DCP XML files. You may find the great free program Subtitle Edit useful for creating such files. @@ -1577,8 +1563,27 @@ linkend="fig-pipeline3"/>. + +
+ Copy and paste settings + + +Once you have set up a piece of content it is possible to copy the +settings you have applied to another piece of content. To do this, +select the content to copy from and choose Copy +from the Edit menu. Then select the content to +copy to and choose Paste. A dialogue box will +open to allow you to choose which settings you want to copy. Clicking +OK will apply the copied settings. + + +
+ + + + DCP settings @@ -2287,6 +2292,30 @@ tab. +
+Encryption keys + + + You must be careful when using encryption not to lose important keys. + + + +If you are making KDMs from a DCP-o-matic film you +must ensure that you have a backup of the +metadata.xml file from the project, as well as the DCP +itself. + + + +If you are using a DKDM you must ensure that you +have a backup of DCP-o-matic's config.xml file, since it +contains the only key which can decrypt the DKDM. The +config.xml file location depends on your operating +system; possible locations are listed in + + +
+
Encryption overview @@ -3021,11 +3050,12 @@ to the cinema which is showing your DCP. - There are two command-line tools in DCP-o-matic. + There are three 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. + film directories. Finally, dcpomatic2_kdm_cli can be + used to create KDMs. @@ -3129,6 +3159,35 @@ to the cinema which is showing your DCP. dcpomatic2_cli my_film
+ +
+ <code>dcpomatic2_kdm_cli</code> + + + The syntax for dcpomatic2_kdm_cli is: + + + + dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID> + + + + + -o, --output — output file or directory + -f, --valid-from — valid from time (in local time zone of the cinema) (e.g. "2013-09-28 01:41:51") or "now" + -t, --valid-to — valid to time (in local time zone of the cinema) (e.g. "2014-09-28 01:41:51") + -d, --valid-duration — valid duration (e.g. "1 day", "4 hours", "2 weeks") + --formulation — modified-transitional-1, dci-any or dci-specific [default modified-transitional-1] + -z, --zip — ZIP each cinema's KDMs into its own file + -v, --verbose — be verbose + -c, --cinema — specify a cinema, either by name or email address + --certificate — file containing projector certificate + --cinemas — list known cinemas from the DCP-o-matic settings + --dkdm-cpls — list CPLs for which DCP-o-matic has DKDMs + + + +
@@ -3318,7 +3377,7 @@ The full details of OV and VF files are discussed in - + Configuration files Most of DCP-o-matic's configuration is stored in an XML file called config.xml. This is stored in different places depending on your operating system: diff --git a/doc/manual/screenshots/add-file.png b/doc/manual/screenshots/add-file.png index 467c35303..d61305dcb 100644 Binary files a/doc/manual/screenshots/add-file.png and b/doc/manual/screenshots/add-file.png differ diff --git a/doc/manual/screenshots/examine-content.png b/doc/manual/screenshots/examine-content.png index a03de7d8c..68a4f6389 100644 Binary files a/doc/manual/screenshots/examine-content.png and b/doc/manual/screenshots/examine-content.png differ