man: Add rpm-ostreed-automatic page

Let's be nice to sysadmins and document our systemd units like systemd
itself does.

Closes: #1291
Approved by: cgwalters

Makefile-man.am

@@ -17,6 +17,7 @@
 
 man1_MANS = rpm-ostree.1
 man5_MANS = rpm-ostreed.conf.5
+man8_MANS = rpm-ostreed-automatic.service.8 rpm-ostreed-automatic.timer.8
 
 XSLTPROC_FLAGS = \
         --nonet \
@@ -35,4 +36,7 @@ rpm-ostree.1: man/rpm-ostree.xml Makefile
 rpm-ostreed.conf.5: man/rpm-ostreed.conf.xml Makefile
 	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS_MAN) $<
 
-CLEANFILES += $(man1_MANS) $(man5_MANS)
+rpm-ostreed-automatic.service.8 rpm-ostreed-automatic.timer.8: man/rpm-ostreed-automatic.xml Makefile
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS_MAN) $<
+
+CLEANFILES += $(man1_MANS) $(man5_MANS) $(man8_MANS)

man/rpm-ostree.xml

@@ -629,6 +629,7 @@ Boston, MA 02111-1307, USA.
     <title>See Also</title>
 
     <para>
+      <citerefentry><refentrytitle>rpm-ostreed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       <citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>rpm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     </para>

man/rpm-ostreed-automatic.xml

@@ -0,0 +1,83 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+Copyright (C) 2018 Red Hat, Inc.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the
+Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.
+-->
+
+<refentry id="rpm-ostreed-automatic">
+
+  <refentryinfo>
+    <title>rpm-ostreed-automatic</title>
+    <productname>rpm-ostree</productname>
+
+    <authorgroup>
+      <author>
+        <contrib>Developer</contrib>
+        <firstname>Jonathan</firstname>
+        <surname>Lebon</surname>
+        <email>jlebon@redhat.com</email>
+      </author>
+    </authorgroup>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>rpm-ostreed-automatic</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>rpm-ostreed-automatic.service</refname>
+    <refname>rpm-ostreed-automatic.timer</refname>
+    <refpurpose>Runs automatic updates policy</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>rpm-ostreed-automatic.service</filename></para>
+    <para><filename>rpm-ostreed-automatic.timer</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      The service unit enacts the <literal>AutomaticUpdatePolicy</literal> setting in
+      <citerefentry><refentrytitle>rpm-ostreed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+      For example, if the current policy is "check", the service will check for updates.
+    </para>
+
+    <para>
+      The timer unit determines the frequency at which the service unit is run. Disabling or
+      masking this unit effectively disables automatic updates, regardless of the setting in
+      <citerefentry><refentrytitle>rpm-ostreed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+      See <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+      for more information on how to control systemd timers.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <para>
+      <citerefentry><refentrytitle>rpm-ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>rpm-ostreed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>

man/rpm-ostreed.conf.xml

@@ -74,12 +74,8 @@ Boston, MA 02111-1307, USA.
         <para>Controls the automatic update policy. Currently "none" or "check".
         "none" disables automatic updates. "check" downloads just enough metadata to check
         for updates and display them in <command>rpm-ostree status</command>. Defaults to
-        "none".</para>
-
-        <para>Automatic updates enablement and frequency are controlled by the
-        <command>rpm-ostreed-automatic.timer</command> unit. <!-- XXX: needs man page -->
-        See <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-        for more information on how to control systemd timers.</para>
+        "none". The <citerefentry><refentrytitle>rpm-ostreed-automatic.timer</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        unit determines the actual frequency of updates.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -128,6 +124,7 @@ Boston, MA 02111-1307, USA.
 
     <para>
       <citerefentry><refentrytitle>rpm-ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>rpm-ostreed-automatic</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     </para>
   </refsect1>