rpm-ostree/man/rpm-ostreed-automatic.xml
Jonathan Lebon 99f111fd3d 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
2018-03-07 22:54:33 +00:00

84 lines
2.8 KiB
XML

<?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>