Some label copy-editing and more manual work.
[dcpomatic.git] / doc / manual / dcpomatic.xml
index 9155d6a97fb4716a40e2e2f81c3257ecc9bee21d..1ee817b5d6171ad75c8870657c0fc33e1dc05fdd 100644 (file)
@@ -32,8 +32,8 @@ Hello, and welcome to DCP-o-matic!
   <listitem>Creation of <ulink
   url="http://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
   Cinema Packages</ulink> (DCPs) from video, audio and/or
-  subtitle files.</listitem>
-  <listitem>Playback of DCPs on a PC.</listitem>
+  subtitle and closed caption files.</listitem>
+  <listitem>Playback and verification of DCPs on a PC/Mac.</listitem>
   <listitem>Creation of KDMs for DCPs.</listitem>
 </itemizedlist>
 
@@ -119,7 +119,7 @@ Windows version.
 
 <para>
 DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher.  DCP-o-matic is split into four separate applications, each of
+higher.  DCP-o-matic is split into five separate applications, each of
 which can be installed by downloading the <code>.dmg</code>,
 double-clicking to open and then dragging the icon to your
 <guilabel>Applications</guilabel> folder.
@@ -141,22 +141,15 @@ with the first (main) part.
 </para>
 
 <itemizedlist>
-  <listitem>Debian 7 (&lsquo;wheezy&rsquo;)</listitem>
-  <listitem>Debian 8 (&lsquo;jessie&rsquo;)</listitem>
-  <listitem>Debian 9 (&lsquo;squeeze&rsquo;)</listitem>
-  <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
-  <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>
-  <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
-  <listitem>Ubuntu 18.04 (&lsquo;Bionic Beaver&rsquo;)</listitem>
-  <listitem>Mint 17</listitem>
-  <listitem>Mint 18</listitem>
-  <listitem>Mint 19</listitem>
+  <listitem>Debian 7 (&lsquo;wheezy&rsquo;), 8 (&lsquo;jessie&rsquo;), 9 (&lsquo;squeeze&rsquo;) and unstable (&lsquo;sid&rsquo;)</listitem>
+  <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;), 16.04 (&lsquo;Xenial Xerus&rsquo;), 18.04 (&lsquo;Bionic Beaver&rsquo;) and 18.10 (&lsquo;Cosmic Cuttlefish&rsquo;)</listitem>
+  <listitem>Mint 17, 18 and 19</listitem>
 </itemizedlist>
 
 <para>
 using <code>.deb</code> packages: download the appropriate package
 from <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
-and double-click it.  Debian or Ubuntu will install the necessary bits and
+and double-click it.  Debian, Ubuntu or Mint will install the necessary bits and
 pieces and set DCP-o-matic up for you.
 </para>
 </section>
@@ -167,7 +160,7 @@ pieces and set DCP-o-matic up for you.
 <section>
   <title>Fedora, Centos and Mageia Linux</title>
 
-  <para>There are <code>.rpm</code> packages for Fedora 27 and 28, Centos 6 and 7 and Mageia 6 on
+  <para>There are <code>.rpm</code> packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on
   <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
   </para>
 </section>
@@ -204,7 +197,6 @@ The following dependencies are required:
 <listitem><ulink url="http://www.mega-nerd.com/SRC/">libsamplerate</ulink></listitem>
 <listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
 <listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
-<listitem><ulink url="http://www.imagemagick.org/script/index.php">ImageMagick</ulink></listitem>
 <listitem><ulink url="http://www.boost.org/">Boost</ulink></listitem>
 <listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
 <listitem><ulink url="http://www.gtk.org/">GTK (on Linux)</ulink></listitem>
@@ -213,10 +205,10 @@ The following dependencies are required:
 <listitem><ulink url="http://www.aleksey.com/xmlsec/">xmlsec</ulink></listitem>
 <listitem><ulink url="http://curl.haxx.se/">curl</ulink></listitem>
 <listitem><ulink url="http://www.nih.at/libzip/">libzip</ulink></listitem>
-<listitem><ulink url="http://carlh.net/asdcplib/">asdcplib with some patches</ulink></listitem>
-<listitem><ulink url="http://carlh.net/libdcp/">libdcp</ulink></listitem>
-<listitem><ulink url="http://carlh.net/libsub/">libsub</ulink></listitem>
-<listitem><ulink url="http://carlh.net/libcxml/">libcxml</ulink></listitem>
+<listitem><ulink url="http://carlh.net/asdcplib">asdcplib with some patches</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libdcp">libdcp</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libsub">libsub</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libcxml">libcxml</ulink></listitem>
 <listitem><ulink url="https://carlh.net/locked_sstream">locked_sstream</ulink></listitem>
 <listitem><ulink url="https://www.music.mcgill.ca/~gary/rtaudio/">rtaudio</ulink></listitem>
 <listitem><ulink url="http://site.icu-project.org">libicu</ulink></listitem>
@@ -289,7 +281,7 @@ shown in <xref linkend="fig-file-new"/>.
   <title>Creating a new film</title>
   <mediaobject>
     <imageobject>
-      <imagedata fileref="screenshots/file-new&scs;"/>
+      <imagedata scale="250" fileref="screenshots/file-new&scs;"/>
     </imageobject>
   </mediaobject>
 </figure>
@@ -405,7 +397,7 @@ linkend="fig-making-dcp"/>.
   <title>Making the DCP</title>
   <mediaobject>
     <imageobject>
-      <imagedata scale="50" fileref="screenshots/making-dcp&scs;"/>
+      <imagedata scale="250" fileref="screenshots/making-dcp&scs;"/>
     </imageobject>
   </mediaobject>
 </figure>
@@ -735,6 +727,55 @@ To add one or more movie, sound, still-image or subtitle files, select
 <guilabel>Add file(s)...</guilabel> and choose them from the selector.
 </para>
 
+<para>
+DCP-o-matic will automatically map a set of audio files to the correct channels if you include appropriate &lsquo;tags&rsquo; in your filenames, as shown in <xref linkend="tab-audio-file-naming"/>.
+</para>
+
+<table id="tab-audio-file-naming">
+  <title>Audio file naming</title>
+  <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+    <thead>
+      <row>
+       <entry>Tag</entry>
+       <entry>Examples</entry>
+       <entry>Channel</entry>
+      </row>
+    </thead>
+    <tbody>
+      <row>
+       <entry><code>L</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-L.wav my_movie_L_final.wav</entry>
+       <entry>Left</entry>
+      </row>
+      <row>
+       <entry><code>R</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-R.wav my_movie_R_final.wav</entry>
+       <entry>Right</entry>
+      </row>
+      <row>
+       <entry><code>C</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-C.wav my_movie_C_final.wav</entry>
+       <entry>Centre</entry>
+      </row>
+      <row>
+       <entry><code>Lfe</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-Lfe.wav my_movie_Lfe_final.wav</entry>
+       <entry>LFE (sub)</entry>
+      </row>
+      <row>
+       <entry><code>Ls</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-Ls.wav my_movie_Ls_final.wav</entry>
+       <entry>Left surround</entry>
+      </row>
+      <row>
+       <entry><code>Rs</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
+       <entry>film-Rs.wav my_movie_Rs_final.wav</entry>
+       <entry>Right surround</entry>
+      </row>
+    </tbody>
+  </tgroup>
+</table>
+
 <para>
 To add a directory (folder) of images, choose <guilabel>Add
 folder...</guilabel> and choose the directory from the selector.
@@ -996,11 +1037,11 @@ url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
 <title>Other settings</title>
 
 <para>
-The <guilabel>crop</guilabel> settings can be used to crop your content,
-which can be used to remove black borders from round the edges of DVD
-images, for example.  The specified number of pixels will be trimmed
-from each edge, and the content image in the right of the window will
-be updated to show the effect of the crop.
+The <guilabel>crop</guilabel> settings can be used to crop your
+content, which is often used to remove black borders from the edges of
+the image.  The specified number of pixels will be trimmed from each
+edge, and the content image in the right of the window will be updated
+to show the effect of the crop.
 </para>
 
 <para>
@@ -2353,8 +2394,8 @@ system; possible locations are listed in <xref linkend="ch-config"/>
 <title>Preferences</title>
 
 <para>
-DCP-o-matic provides a few preferences which can be used to modify its
-behaviour.  This chapter explains those options.
+DCP-o-matic provides preferences which can be used to modify its
+behaviour.  They are described in this chapter.
 </para>
 
 <para>
@@ -2726,12 +2767,39 @@ Note that for this to work on Doremi servers you will need to set the
 </section>
 
 
+<!-- ============================================================== -->
+<section>
+<title>Email</title>
+
+<para>
+The Email tab is shown in <xref linkend="fig-prefs-email"/>.
+</para>
+
+<figure id="fig-prefs-email">
+  <title>Email preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-email&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+These settings are used when DCP-o-matic sends emails.
+</para>
+
+<para>
+  <guilabel>Outgoing mail server</guilabel> should be the host name of a mail (SMTP) server that DCP-o-matic can use.  You can also specify the port that DCP-o-matic should use.  <guilabel>User name</guilabel> and <guilabel>Password</guilabel> are the credentials that are required to send email through the server you have specified.
+</para>
+
+</section>
+
 <!-- ============================================================== -->
 <section>
 <title>KDM email</title>
 
 <para>
-The KDM email is shown in <xref linkend="fig-prefs-kdm-email"/>.
+The KDM email tab is shown in <xref linkend="fig-prefs-kdm-email"/>.
 </para>
 
 <figure id="fig-prefs-kdm-email">
@@ -2780,6 +2848,68 @@ The <guilabel>Reset to default text</guilabel> will replace the current KDM emai
 </section>
 
 
+<!-- ============================================================== -->
+<section>
+<title>Accounts</title>
+
+<para>
+The Accounts tab is shown in <xref linkend="fig-prefs-accounts"/>.
+</para>
+
+<figure id="fig-prefs-accounts">
+  <title>Accounts preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-accounts&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+DCP-o-matic can download projector certificates from the Barco and
+Christie websites if you have the appropriate credentials.  Enter your
+usernames and passwords.
+</para>
+
+</section>
+
+
+<!-- ============================================================== -->
+<section>
+<title>Notifications</title>
+
+<para>
+The Notifications tab is shown in <xref linkend="fig-prefs-notifications"/>.
+</para>
+
+<figure id="fig-prefs-notifications">
+  <title>Notifications preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-notifications&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+DCP-o-matic can notify the user when jobs have completed.  These
+notifications can be either or both of a message box on-screen (if
+<guilabel>Message box</guilabel> is ticked) and email (if
+<guilabel>Email</guilabel> is ticked).  If you enable email
+notifications you can fill in the details of the emails you want to
+send.
+</para>
+
+<para>
+The bottom box in the tab is the contents of the email that should
+be sent.  DCP-o-matic will replace the &lsquo;magic&rsquo; strings
+<code>$JOB_NAME</code> and <code>$JOB_STATUS</code> in the with the
+details of the job that has completed.
+</para>
+
+</section>
+
+
 <!-- ============================================================== -->
 <section>
 <title>Cover sheet</title>
@@ -2936,8 +3066,8 @@ even refuse to ingest.
 
 <para>
 The only rates that are (pretty much) guaranteed to work on all DCI
-projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
-for audio.  If you are sending your DCPs to unknown places it wise to
+projectors are 24 frames per second (fps) for video and 48kHz for
+audio.  If you are sending DCPs to unknown places it is wise to
 consider using these rates if at all possible.
 </para>
 
@@ -2949,7 +3079,7 @@ consider using these rates if at all possible.
 <title>Other often-supported rates</title>
 <para>
 Many projectors now in the wild support additional video frame rates:
-25, 30 and 48 fps.
+25, 30, 48, 50 and 60 fps.
 </para>
 </section>