xref: /freebsd/usr.sbin/tzsetup/tzsetup.8 (revision 830940567b49bb0c08dfaed40418999e76616909)
1.\" Copyright (c) 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.Dd July 4, 2009
27.Dt TZSETUP 8
28.Os
29.Sh NAME
30.Nm tzsetup
31.Nd set local timezone
32.Sh SYNOPSIS
33.Nm
34.Op Fl ns
35.Op Ar default
36.Sh DESCRIPTION
37The
38.Nm
39utility reads a database of timezone information and presents a menu
40allowing the user to select a specific zone without knowing the details
41of the database layout.
42The selected zone is installed as the system
43default zone.
44The
45.Nm
46utility also determines whether any adjustment is necessary for systems where
47the hardware clock does not keep
48.Tn UTC .
49.Pp
50The following option is available:
51.Bl -tag -offset indent -width Fl
52.It Fl n
53Do not create or copy files.
54.It Fl s
55Skip the initial question about adjusting the clock if not set to
56.Tn UTC .
57.El
58.Pp
59It is possible to short-circuit the menu system by specifying a
60.Ar default
61on the command line; this is intended mainly for pre-configured
62installation scripts.
63.Sh TIMEZONE DATABASE
64The contents of the timezone database are indexed by
65.Pa /usr/share/zoneinfo/zone.tab .
66This file lists, for each timezone data file, the
67.Tn ISO
683166 territory code, approximate geographical coordinates
69(in
70.Tn ISO
716709 format),
72and location within the territory.
73.Pp
74The maintainers of the database maintain the following policies:
75.Bl -enum -offset indent
76.It
77At least one zone for every country or inhabited geographical territory.
78.It
79One zone for every distinct, documented timezone history since the
80beginning of the
81.Ux
82epoch (January 1, 1970,
83.Tn GMT ) .
84.It
85Each zone is named for the most populous city therein.
86(Where possible,
87the database includes pre-1970 history for its city.)
88.El
89The source code to the database
90.Pq Pa /usr/src/share/zoneinfo/[a-z]*
91contains many additional comments and documentation references for the
92historically minded.
93.Sh FILES
94.Bl -tag -width /usr/share/zoneinfo/zone.tab -compact
95.It Pa /etc/localtime
96current time zone file
97.It Pa /etc/wall_cmos_clock
98see
99.Xr adjkerntz 8 .
100.It Pa /usr/share/misc/iso3166
101mapping of
102.Tn ISO
1033166 territory codes to names
104.It Pa /usr/share/zoneinfo
105directory for zoneinfo files
106.It Pa /usr/share/zoneinfo/zone.tab
107mapping of timezone file to country and location
108.El
109.Sh SEE ALSO
110.Xr date 1 ,
111.Xr adjtime 2 ,
112.Xr ctime 3 ,
113.Xr timezone 3 ,
114.Xr tzfile 5 ,
115.Xr adjkerntz 8 ,
116.Xr zdump 8 ,
117.Xr zic 8
118.Sh DISCLAIMER
119The representation of certain localities as being associated with certain
120countries and/or territories is for the purposes of identification only,
121and does not imply any endorsement or rejection on the part of the
122.Fx
123Project of the territorial claims of any entity.
124.Sh BUGS
125Programs which are already running when
126.Nm
127creates or updates
128.Pa /etc/localtime
129will not reflect the updated timezone.
130When the system is first configured for a
131.Pf non- Tn UTC
132hardware clock, it is necessary to run
133.Xr adjkerntz 8
134(which normally happens as a part of system startup) in order to update
135the kernel's idea of the correct timezone offset.
136