From: Carl Hetherington Date: Mon, 12 Feb 2018 21:42:08 +0000 (+0000) Subject: Manual updates. X-Git-Tag: v2.11.56~10 X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=0b33fb112e8ec1eac1d19388422a7194ecd7937c Manual updates. --- diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 18b2eafa3..66231090c 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -521,7 +521,7 @@ computationally intensive as encoding them. -If your DCP is a Version File (VF) (i.e.\ it refers to +If your DCP is a Version File (VF) (i.e. it refers to another DCP's assets) you should import it as follows: @@ -1725,7 +1725,7 @@ The JPEG2000 bandwidth; setting changes how big the final image files used within the DCP will be. Larger numbers will give better quality, but correspondingly larger DCPs. The bandwidth can be between 50 and 250 megabits per second (Mbit/s). -Most commercial DCPs use bit rates between 75 and 125 MBit/s. +Most commercial DCPs use bit rates between 75 and 125 Mbit/s. @@ -2231,7 +2231,7 @@ create KDMs for its film. Perhaps you want to archive the project to save space, or create KDMs on a different machine. In such situations it is easier to use a DKDM. This is a normal KDM, but instead of being targeted at a projection system (to allow it to decrypt the -content) it is targeted at a particular users's certificate. This +content) it is targeted at a particular user's certificate. This means that the certificate owner can create new KDMs for other users. The DKDM holds everything that is required to create further KDMs. @@ -2390,7 +2390,7 @@ read about how to contribute a translation.
-Threads +Number of threads DCP-o-matic should use When DCP-o-matic is encoding DCPs it can use multiple parallel threads @@ -2402,6 +2402,31 @@ to set this up correctly when you run it for the first time.
+ + +
+Number of threads DCP-o-matic encode server should use + + +This is the number of threads that the encode server should use when +it is running and helping another copy of DCP-o-matic to speed up its +encode. + + +
+ + + +
+Configuration file + + +This is the location of DCP-o-matic's configuration file on disk. You +can use this to share configuration between several copies of +DCP-o-matic, across a network share, for instance. + +
+
Cinema and screen database file @@ -2410,9 +2435,22 @@ to set this up correctly when you run it for the first time. This option allows you to change the file that DCP-o-matic uses to store details of the cinemas and screens used to make KDMs. +
+ + +
+Play sound via + + +The checkbox to the left of Play sound enables or +disables DCP-o-matic use of sound. On some machines there will be +multiple options in the drop-down menu to decide how the sound should +be played. +
+
Integrated loudness @@ -2426,6 +2464,15 @@ faster.
+ +
+Automatically analyse content audio + + +If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound. + +
+
Updates @@ -2520,7 +2567,7 @@ name or IP address of the server to use. Keys -The Keys tab (shown in ) holds options +The Keys tab (shown in ) has controls related to the keys and certificates used in some parts of DCP creation. @@ -2535,9 +2582,43 @@ creation. -At the top of the tab is the chain of certificates that will be used -to sign DCPs and KDMs. DCP-o-matic creates a random chain when you -first run it and if you are happy to use this chain you can ignore the +Export KDM decryption certificate... allows you +to save the certificate that DCP-o-matic uses when decrypting KDMs +that you give it. Use this option if somebody wants to make a KDM for +you and asks for your certificate. + + + +Export KDM decryption chain... exports the whole +KDM decryption chain rather than just its certificate. This may also +be requested by KDM creators. + + + +Export all KDM decryption settings... exports a +file which contains all the DCP-o-matic settings related to the use of +KDMs supplied by other people. Use this button and Import +all KDM decryption settings... to transfer settings between +different copies of DCP-o-matic so that they can both use the same +KDMs. + + + +The two Advanced... buttons open advanced +dialogue boxes for detailed manipulation of DCP-o-matic's certificate +chains. + + +
+ +
+Advanced keys settings + + +At the top of the Advanced dialogue for signing +DCPs and KDMs is the chain of certificates that will be used to sign +DCPs and KDMs. DCP-o-matic creates a random chain when you first run +it and if you are happy to use this chain you can ignore the preferences. Otherwise, you can add or remove certificates from the chain using the Add... and Remove buttons. @@ -2559,13 +2640,13 @@ corresponds to the public key held in the leaf certificate. -Underneath the details of the certificate chain and private key for -signing of DCPs and KDMs is a second chain and key which is used by +At the top of the Advanced dialogue for decrypting DCPs is the chain and key which is used by DCP-o-matic when you import an encrypted DCP as a piece of content. The leaf certificate of this chain contains the public key that should be used when targeting a KDM at DCP-o-matic. + If you want to import an encrypted DCP you will need to give the decryption certificate to the distributor of the DCP so that they can @@ -2687,6 +2768,68 @@ The Reset to default text will replace the current KDM emai
+ +
+Cover sheet + + +The DCP cover sheet configuration is shown in . + + +
+ DCP cover sheet preferences + + + + + +
+ + +This is a template for the cover sheet that is written next to every DCP that DCP-o-matic creates. You can change it to say whatever you like. A few +‘magic’ strings will be replaced by information from the +DCP that has been made: + + + +‘Magic’ Cover sheet strings + + + +$CPL_NAMEDCP title + + +$TYPEDCP content type (e.g. feature, trailer...) + + +$CONTAINERThe container ratio (e.g. flat, scope...) + + +$AUDIODetails of the audio channels + + +$AUDIO_LANGUAGEAudio language + + +$SUBTITLE_LANGUAGESubtitle language + + +$LENGTHDCP length in hours, minutes and seconds + + +$SIZEDCP size in gigabytes + + + +
+ + +The Reset to default text will replace the current cover sheet with DCP-o-matic's default. + + +
+ +
Advanced @@ -2722,7 +2865,7 @@ this unticked for normal use. Only servers encode makes DCP-o-matic encode JPEG2000 data only on encoding servers and not on the host. We -suggest you leave this un-ticked unless you have a good reason to do otherwise. +suggest you leave this unticked unless you have a good reason to do otherwise. @@ -2743,7 +2886,7 @@ as this makes the log files useful for tracking down bugs. The Timing checkbox will enable extra log entries -to allow developers to investigate and optimize the speed of +to allow developers to investigate and optimise the speed of DCP-o-matic. It will significantly increase the size of the log files that are generated, so in normal use it is best to leave this unticked. diff --git a/doc/manual/screenshots/audio-tab.png b/doc/manual/screenshots/audio-tab.png index 798d91e7c..07e1dfd67 100644 Binary files a/doc/manual/screenshots/audio-tab.png and b/doc/manual/screenshots/audio-tab.png differ diff --git a/doc/manual/screenshots/prefs-cover-sheet.png b/doc/manual/screenshots/prefs-cover-sheet.png new file mode 100644 index 000000000..70337d6b3 Binary files /dev/null and b/doc/manual/screenshots/prefs-cover-sheet.png differ diff --git a/doc/manual/screenshots/prefs-defaults.png b/doc/manual/screenshots/prefs-defaults.png index 969d44833..2b89ad8ef 100644 Binary files a/doc/manual/screenshots/prefs-defaults.png and b/doc/manual/screenshots/prefs-defaults.png differ diff --git a/doc/manual/screenshots/prefs-general.png b/doc/manual/screenshots/prefs-general.png index 148d0d2a3..19ce2419f 100644 Binary files a/doc/manual/screenshots/prefs-general.png and b/doc/manual/screenshots/prefs-general.png differ diff --git a/doc/manual/screenshots/prefs-keys.png b/doc/manual/screenshots/prefs-keys.png index 9be07e71f..0f21a16aa 100644 Binary files a/doc/manual/screenshots/prefs-keys.png and b/doc/manual/screenshots/prefs-keys.png differ diff --git a/doc/manual/screenshots/subtitles-tab.png b/doc/manual/screenshots/subtitles-tab.png index 00643c3d8..1ff80c525 100644 Binary files a/doc/manual/screenshots/subtitles-tab.png and b/doc/manual/screenshots/subtitles-tab.png differ diff --git a/doc/manual/screenshots/video-tab.png b/doc/manual/screenshots/video-tab.png index fb6030708..f732e84d8 100644 Binary files a/doc/manual/screenshots/video-tab.png and b/doc/manual/screenshots/video-tab.png differ