Update to Module-Init-Tools-3.12
[linux_from_scratch.git] / chapter07 / setclock.xml
blob854b889c61a73035e0cdd74cb148c9a2128dbccb
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4   <!ENTITY % general-entities SYSTEM "../general.ent">
5   %general-entities;
6 ]>
8 <sect1 id="ch-scripts-setclock">
9   <?dbhtml filename="setclock.html"?>
11   <title>Configuring the setclock Script</title>
13   <indexterm zone="ch-scripts-setclock">
14     <primary sortas="d-setclock">setclock</primary>
15   <secondary>configuring</secondary></indexterm>
17   <para>The <command>setclock</command> script reads the time from the hardware
18   clock, also known as the BIOS or the Complementary Metal Oxide Semiconductor
19   (CMOS) clock. If the hardware clock is set to UTC, this script will convert the
20   hardware clock's time to the local time using the
21   <filename>/etc/localtime</filename> file (which tells the
22   <command>hwclock</command> program which timezone the user is in). There is no
23   way to detect whether or not the hardware clock is set to UTC, so this
24   needs to be configured manually.</para>
26   <para>The <command>setclock</command> is run via
27   <application>udev</application> when the kernel detects the hardware
28   capability upon boot.  It can also be run manually with the stop parameter to
29   store the system time to the CMOS clock.</para>
31   <para>If you cannot remember whether or not the hardware clock is set to UTC,
32   find out by running the <userinput>hwclock --localtime --show</userinput>
33   command. This will display what the current time is according to the hardware
34   clock. If this time matches whatever your watch says, then the hardware clock is
35   set to local time. If the output from <command>hwclock</command> is not local
36   time, chances are it is set to UTC time. Verify this by adding or subtracting
37   the proper amount of hours for the timezone to the time shown by
38   <command>hwclock</command>. For example, if you are currently in the MST
39   timezone, which is also known as GMT -0700, add seven hours to the local
40   time.</para>
42   <para>Change the value of the <envar>UTC</envar> variable below
43   to a value of <parameter>0</parameter> (zero) if the hardware clock
44   is <emphasis>not</emphasis> set to UTC time.</para>
46   <para>Create a new file <filename>/etc/sysconfig/clock</filename> by running
47   the following:</para>
49 <screen><userinput>cat &gt; /etc/sysconfig/clock &lt;&lt; "EOF"
50 <literal># Begin /etc/sysconfig/clock
52 UTC=1
54 # Set this to any options you might need to give to hwclock, 
55 # such as machine hardware clock type for Alphas.
56 CLOCKPARAMS=
58 # End /etc/sysconfig/clock</literal>
59 EOF</userinput></screen>
61   <para>A good hint explaining how to deal with time on LFS is available
62   at <ulink url="&hints-root;time.txt"/>. It explains issues such as
63   time zones, UTC, and the <envar>TZ</envar> environment variable.</para>
65 </sect1>