Merge remote-tracking branch 'origin/master' into 2.0

[dcpomatic.git] / doc / manual / dcpomatic.xml

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index cd27bef726f816e4e104ce2d7dfca74308ea9527..489f0ba041dd55c069578069bb20daff207d70af 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -1376,7 +1376,7 @@ methods to understand it.
 
 <para>
 We suppose that we are trying to distribute a DCP to
-Alice's cinema, without a troublemaker called Mallory being able to
+Alice's cinema without a troublemaker called Mallory being able to
 watch it himself.
 </para>
 
@@ -1533,6 +1533,9 @@ generate the KDMs.
 
 
 <!-- ============================================================== -->
+<!-- PREFERENCES                                                    -->
+<!-- ============================================================== -->
+
 <chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 <title>Preferences</title>
 
@@ -1549,7 +1552,7 @@ behaviour.  This chapter explains those options.
 <para>
 The preferences dialogue is opened by choosing
 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
-menu.  The dialogue is split into seven tabs.
+menu.  The dialogue is split into eight tabs.
 </para>
 
 <!-- ============================================================== -->
@@ -1619,7 +1622,7 @@ available
 <para>
 The <guilabel>Check for testing updates as well as stable
 ones</guilabel> option will also check for test updates as well as
-those that are formally &lsquo;released&rsquo; This is useful if you
+those that are formally &lsquo;released&rsquo;. This is useful if you
 like to live on the bleeding edge!
 </para>
 </section>
@@ -1688,6 +1691,61 @@ converting from common input colour spaces to XYZ.
 </section>
 
 
+<!-- ============================================================== -->
+<section>
+<title>Keys</title>
+
+<para>
+The Keys tab (shown in <xref linkend="fig-prefs-keys"/>) holds options
+related to the keys and certificates used in some parts of DCP
+creation.
+</para>
+
+<figure id="fig-prefs-keys"> 
+  <title>Keys preferences</title> 
+  <mediaobject>
+    <imageobject> 
+      <imagedata fileref="screenshots/prefs-keys&scs;"/>
+    </imageobject> 
+  </mediaobject>
+</figure>
+
+<para>
+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, so if you are happy to use a randomly-generated chain
+you can ignore the preferences.  Otherwise, you can add or remove
+certificates from the chain using the <guilabel>Add...</guilabel> and
+<guilabel>Remove</guilabel> buttons.
+</para>
+
+<para>
+If you want DCP-o-matic to re-create the certificate chain (using new,
+random certificates) click <guilabel>Re-make
+certificates...</guilabel> and specify your organisation and common
+names in the dialogue box that opens.
+</para>
+
+<para>
+Underneath the certificate chain is the private key that corresponds
+to the leaf certificate in the chain.  You can specify your own
+private key by clicking <guilabel>Load...</guilabel>.  You must do
+this if you change the leaf certificate, so that the leaf private key
+corresponds to the public key held in the leaf certificate.
+</para>
+
+<para>
+The bottom of the tab specifies the certificate and private key that
+is used to decrypt DCPs if they are imported as sources to
+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 generate a DKDM for you.  As with the certificate chain,
+DCP-o-matic will create a certificate and private key for you.  You
+can also choose to load your own certificate and key.
+</para>
+
+</section>
+
 <!-- ============================================================== -->
 <section xml:id="sec-prefs-tms">
 <title>TMS</title>
@@ -1889,12 +1947,12 @@ with minimal loss in quality.
 </para>
 
 <para>
-Video rate conversion is harder.  DCP-o-matic's basic strategy to deal
+Video rate conversion is harder.  DCP-o-matic's strategy to deal
 with a non-supported content rate is to run it at the wrong speed, and
 to adjust the audio to keep it in sync.
 </para>
 
-<para>Let us consider the example of a 25fps source for which you want
+<para>Consider the example of a 25fps source for which you want
 to create a 24fps DCP.  DCP-o-matic will put the frames from the
 source directly into the DCP without modification, but will tell the
 projector to play them back at 24fps.  This means that the DCP's video
@@ -1926,7 +1984,7 @@ For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
 The <guilabel>Frame Rate</guilabel> control in the
 <guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
 will use.  Clicking <guilabel>Use best</guilabel> sets the rate to
-what DVD-o-matic thinks is the best for your content.  With this
+what DCP-o-matic thinks is the best for your content.  With this
 button, DCP-o-matic assumes that the whole range of frame rates (24,
 25, 30 and 48fps) are allowable.
 </para>