Some label copy-editing and more manual work.

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

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 1519562fdc4aedc20dae6ae65085e3f6185c2169..1ee817b5d6171ad75c8870657c0fc33e1dc05fdd 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -32,7 +32,7 @@ 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>
+  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.
@@ -142,7 +142,7 @@ with the first (main) part.
 
 <itemizedlist>
   <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;) and 18.04 (&lsquo;Bionic Beaver&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>
 
@@ -281,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>
@@ -397,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>
@@ -2767,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">
@@ -2821,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>