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: head/usr.sbin/tzsetup/tzsetup.8 198255 2009-10-19 21:37:31Z edwin $
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 zoneinfo file
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 the
60location of a
61.Ar zoneinfo file
62on the command line; this is intended mainly for pre-configured installation
63scripts.
64.Sh TIMEZONE DATABASE
65The contents of the timezone database are indexed by
66.Pa /usr/share/zoneinfo/zone.tab .
67This file lists, for each timezone data file, the
68.Tn ISO
693166 territory code, approximate geographical coordinates
70(in
71.Tn ISO
726709 format),
73and location within the territory.
74.Pp
75The maintainers of the database maintain the following policies:
76.Bl -enum -offset indent
77.It
78At least one zone for every country or inhabited geographical territory.
79.It
80One zone for every distinct, documented timezone history since the
81beginning of the
82.Ux
83epoch (January 1, 1970,
84.Tn GMT ) .
85.It
86Each zone is named for the most populous city therein.
87(Where possible,
88the database includes pre-1970 history for its city.)
89.El
90The source code to the database
91.Pq Pa /usr/src/share/zoneinfo/[a-z]*
92contains many additional comments and documentation references for the
93historically minded.
94.Sh FILES
95.Bl -tag -width /usr/share/zoneinfo/zone.tab -compact
96.It Pa /etc/localtime
97current time zone file
98.It Pa /etc/wall_cmos_clock
99see
100.Xr adjkerntz 8 .
101.It Pa /usr/share/misc/iso3166
102mapping of
103.Tn ISO
1043166 territory codes to names
105.It Pa /usr/share/zoneinfo
106directory for zoneinfo files
107.It Pa /usr/share/zoneinfo/zone.tab
108mapping of timezone file to country and location
109.El
110.Sh SEE ALSO
111.Xr date 1 ,
112.Xr adjtime 2 ,
113.Xr ctime 3 ,
114.Xr timezone 3 ,
115.Xr tzfile 5 ,
116.Xr adjkerntz 8 ,
117.Xr zdump 8 ,
118.Xr zic 8
119.Sh DISCLAIMER
120The representation of certain localities as being associated with certain
121countries and/or territories is for the purposes of identification only,
122and does not imply any endorsement or rejection on the part of the
123.Fx
124Project of the territorial claims of any entity.
125.Sh BUGS
126Programs which are already running when
127.Nm
128creates or updates
129.Pa /etc/localtime
130will not reflect the updated timezone.
131When the system is first configured for a
132.Pf non- Tn UTC
133hardware clock, it is necessary to run
134.Xr adjkerntz 8
135(which normally happens as a part of system startup) in order to update
136the kernel's idea of the correct timezone offset.
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: head/usr.sbin/tzsetup/tzsetup.8 198255 2009-10-19 21:37:31Z edwin $
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 zoneinfo file
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 the
60location of a
61.Ar zoneinfo file
62on the command line; this is intended mainly for pre-configured installation
63scripts.
64.Sh TIMEZONE DATABASE
65The contents of the timezone database are indexed by
66.Pa /usr/share/zoneinfo/zone.tab .
67This file lists, for each timezone data file, the
68.Tn ISO
693166 territory code, approximate geographical coordinates
70(in
71.Tn ISO
726709 format),
73and location within the territory.
74.Pp
75The maintainers of the database maintain the following policies:
76.Bl -enum -offset indent
77.It
78At least one zone for every country or inhabited geographical territory.
79.It
80One zone for every distinct, documented timezone history since the
81beginning of the
82.Ux
83epoch (January 1, 1970,
84.Tn GMT ) .
85.It
86Each zone is named for the most populous city therein.
87(Where possible,
88the database includes pre-1970 history for its city.)
89.El
90The source code to the database
91.Pq Pa /usr/src/share/zoneinfo/[a-z]*
92contains many additional comments and documentation references for the
93historically minded.
94.Sh FILES
95.Bl -tag -width /usr/share/zoneinfo/zone.tab -compact
96.It Pa /etc/localtime
97current time zone file
98.It Pa /etc/wall_cmos_clock
99see
100.Xr adjkerntz 8 .
101.It Pa /usr/share/misc/iso3166
102mapping of
103.Tn ISO
1043166 territory codes to names
105.It Pa /usr/share/zoneinfo
106directory for zoneinfo files
107.It Pa /usr/share/zoneinfo/zone.tab
108mapping of timezone file to country and location
109.El
110.Sh SEE ALSO
111.Xr date 1 ,
112.Xr adjtime 2 ,
113.Xr ctime 3 ,
114.Xr timezone 3 ,
115.Xr tzfile 5 ,
116.Xr adjkerntz 8 ,
117.Xr zdump 8 ,
118.Xr zic 8
119.Sh DISCLAIMER
120The representation of certain localities as being associated with certain
121countries and/or territories is for the purposes of identification only,
122and does not imply any endorsement or rejection on the part of the
123.Fx
124Project of the territorial claims of any entity.
125.Sh BUGS
126Programs which are already running when
127.Nm
128creates or updates
129.Pa /etc/localtime
130will not reflect the updated timezone.
131When the system is first configured for a
132.Pf non- Tn UTC
133hardware clock, it is necessary to run
134.Xr adjkerntz 8
135(which normally happens as a part of system startup) in order to update
136the kernel's idea of the correct timezone offset.