[systemd-devel] [PATCH 3/3] man: remove timezone(5) and add localtime(5)

[Shawn Landden]

---
 Makefile.am                         |    2 +-
 man/{timezone.xml => localtime.xml} |   49 +++++++++++++++++++----------------
 units/systemd-timedated.service.in  |    2 +-
 3 files changed, 28 insertions(+), 25 deletions(-)
 rename man/{timezone.xml => localtime.xml} (59%)

diff --git a/Makefile.am b/Makefile.am
index 9062dd6..3422a75 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -468,7 +468,7 @@ MANPAGES = \
 	man/systemd.conf.5 \
 	man/tmpfiles.d.5 \
 	man/hostname.5 \
-	man/timezone.5 \
+	man/localtime.5 \
 	man/machine-id.5 \
 	man/locale.conf.5 \
 	man/os-release.5 \
diff --git a/man/timezone.xml b/man/localtime.xml
similarity index 59%
rename from man/timezone.xml
rename to man/localtime.xml
index dedb7d9..09df161 100644
--- a/man/timezone.xml
+++ b/man/localtime.xml
@@ -7,6 +7,7 @@
   This file is part of systemd.
 
   Copyright 2010 Lennart Poettering
+  Copyright 2012 Shawn Landden
 
   systemd is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as published by
@@ -22,9 +23,9 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="timezone">
+<refentry id="localtime">
         <refentryinfo>
-                <title>/etc/timezone</title>
+                <title>/etc/localtime</title>
                 <productname>systemd</productname>
 
                 <authorgroup>
@@ -34,38 +35,46 @@
                                 <surname>Poettering</surname>
                                 <email>lennart at poettering.net</email>
                         </author>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Shawn</firstname>
+                                <surname>Landden</surname>
+                                <email>shawnlandden at gmail.com</email>
+                        </author>
                 </authorgroup>
         </refentryinfo>
 
         <refmeta>
-                <refentrytitle>timezone</refentrytitle>
+                <refentrytitle>localtime</refentrytitle>
                 <manvolnum>5</manvolnum>
         </refmeta>
 
         <refnamediv>
-                <refname>timezone</refname>
+                <refname>localtime</refname>
                 <refpurpose>Local time zone configuration file</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>/etc/timezone</filename></para>
+                <para><filename>/etc/localtime</filename> -> <filename>/usr/share/zoneinfo/…</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
-                <para>The <filename>/etc/timezone</filename> file
+                <para>The <filename>/etc/localtime</filename> file
                 configures the system-wide time zone of the local
                 system that is used by applications for presentation
-                to the user. It should contain a single
-                newline-terminated line consisting of a time zone
-                identifier such as
-                <literal>Europe/Berlin</literal>. The file
-                <filename>/etc/localtime</filename> corresponds with
-                <filename>/etc/timezone</filename> and contains the
-                binary time zone data for the time zone. These files
-                should always be changed simultaneously and kept in
-                sync.</para>
+                to the user. It should be an absolute symbolic link
+                with a destination of <filename>/usr/share/zoneinfo/</filename>,
+                fallowed by a time zone identifier such as
+                <literal>Europe/Berlin</literal> or <literal>Etc/UTC</literal>.
+                The resulting link should point to the corresponding binary
+                <citerefentry><refentrytitle>tzfile</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                time zone data for the configured time zone.</para>
+
+                <para>As the time zone identifier is extracted from the name of
+                the target of <filename>/etc/localtime</filename> this file may
+                not be a normal file or hardlink.</para>
 
                 <para>The time zone may be overridden for individual
                 programs by using the TZ environment variable. See
@@ -73,16 +82,10 @@
         </refsect1>
 
         <refsect1>
-                <title>History</title>
-
-                <para>The simple configuration file format of
-                <filename>/etc/timezone</filename> originates from
-                Debian GNU/Linux.</para>
-        </refsect1>
-
-        <refsect1>
                   <title>See Also</title>
                   <para>
+                          <citerefentry><refentrytitle>tzset</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                   </para>
         </refsect1>
diff --git a/units/systemd-timedated.service.in b/units/systemd-timedated.service.in
index 1944a71..dd3eb1b 100644
--- a/units/systemd-timedated.service.in
+++ b/units/systemd-timedated.service.in
@@ -7,7 +7,7 @@
 
 [Unit]
 Description=Time & Date Service
-Documentation=man:systemd-timedated.service(8) man:timezone(5)
+Documentation=man:systemd-timedated.service(8) man:localtime(5)
 Documentation=http://www.freedesktop.org/wiki/Software/systemd/timedated
 
 [Service]
-- 
1.7.9.5