From ad8e9b6de8cccc09f19d105f3f4d63c6a3ffaab8 Mon Sep 17 00:00:00 2001
From: Micah Abbott <miabbott@redhat.com>
Date: Mon, 26 Feb 2018 18:06:29 +0000
Subject: [PATCH] man: add example usage for automatic update policy

The man page was a little weak on how to configure and enable the
automatic update policy of `rpm-ostreed`.  I've added an `EXAMPLE`
section that shows the necessary steps to get this working.

Closes: #1273
Approved by: jlebon
---
 man/rpm-ostreed.conf.xml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/man/rpm-ostreed.conf.xml b/man/rpm-ostreed.conf.xml
index fd3e6e1a..968ec328 100644
--- a/man/rpm-ostreed.conf.xml
+++ b/man/rpm-ostreed.conf.xml
@@ -103,6 +103,26 @@ Boston, MA 02111-1307, USA.
     </variablelist>
   </refsect1>
 
+  <refsect1>
+    <title>Example</title>
+
+    <para>Enabling the automatic updates "check" policy is a two step process.
+    First, edit <filename>/etc/rpm-ostreed.conf</filename> to include
+    <literal>AutomaticUpdatePolicy=check</literal> and then use
+    <command>rpm-ostree reload</command> to reload the <literal>rpm-ostreed</literal>
+    service.  Next, enable the timer using
+    <command>systemctl enable rpm-ostreed-automatic.timer --now</command></para>
+
+    <para>When successful, the output from <command>rpm-ostree status</command> will
+    display output similar to the following:</para>
+
+    <literallayout>
+    $ rpm-ostree status
+    State: idle; auto updates enabled (check; last run 22min ago)
+    ...
+    </literallayout>
+  </refsect1>
+
   <refsect1>
     <title>See Also</title>