Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / tzsetup / tzsetup.8
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: src/usr.sbin/tzsetup/tzsetup.8,v 1.11.2.4 2003/03/11 22:31:34 trhodes Exp $
26 .Dd January 24, 1996
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 n
35 .Op Ar default
36 .Sh DESCRIPTION
37 The
38 .Nm
39 utility reads a database of timezone information and presents a menu
40 allowing the user to select a specific zone without knowing the details
41 of the database layout.  The selected zone is installed as the system
42 default zone.
43 The
44 .Nm
45 utility also determines whether any adjustment is necessary for systems where
46 the hardware clock does not keep
47 .Tn UTC .
48 .Pp
49 The following option is available:
50 .Bl -tag -offset indent -width Fl
51 .It Fl n
52 Do not create or copy files.
53 .El
54 .Pp
55 It is possible to short-circuit the menu system by specifying a
56 .Ar default
57 on the command line; this is intended mainly for pre-configured
58 installation scripts.
59 .Sh TIMEZONE DATABASE
60 The contents of the timezone database are indexed by
61 .Pa /usr/share/zoneinfo/zone.tab .
62 This file lists, for each timezone data file, the
63 .Tn ISO
64 3166 territory code, approximate geographical coordinates
65 (in
66 .Tn ISO
67 6709 format),
68 and location within the territory.
69 .Pp
70 The maintainers of the database maintain the following policies:
71 .Bl -enum -offset indent
72 .It
73 At least one zone for every country or inhabited geographical territory.
74 .It
75 One zone for every distinct, documented timezone history since the
76 beginning of the
77 .Ux
78 epoch (January 1, 1970,
79 .Tn GMT ) .
80 .It
81 Each zone is named for the most populous city therein.  (Where possible,
82 the database includes pre-1970 history for its city.)
83 .El
84 The source code to the database
85 .Pq Pa /usr/src/share/zoneinfo/[a-z]*
86 contains many additional comments and documentation references for the
87 historically minded.
88 .Sh BUGS
89 Programs which are already running when
90 .Nm
91 creates or updates
92 .Pa /etc/localtime
93 will not reflect the updated timezone.
94 When the system is first configured for a
95 .Pf non- Tn UTC
96 hardware clock, it is necessary to run
97 .Xr adjkerntz 8
98 (which normally happens as a part of system startup) in order to update
99 the kernel's idea of the correct timezone offset.
100 .Sh FILES
101 .Bl -tag -width /usr/share/zoneinfo/zone.tab -compact
102 .It Pa /etc/localtime
103 current time zone file
104 .It Pa /etc/wall_cmos_clock
105 see
106 .Xr adjkerntz 8 .
107 .It Pa /usr/share/misc/iso3166
108 mapping of
109 .Tn ISO
110 3166 territory codes to names
111 .It Pa /usr/share/zoneinfo
112 directory for zoneinfo files
113 .It Pa /usr/share/zoneinfo/zone.tab
114 mapping of timezone file to country and location
115 .El
116 .Sh SEE ALSO
117 .Xr date 1 ,
118 .Xr adjtime 2 ,
119 .Xr ctime 3 ,
120 .Xr timezone 3 ,
121 .Xr tzfile 5 ,
122 .Xr adjkerntz 8 ,
123 .Xr zdump 8 ,
124 .Xr zic 8
125 .Sh DISCLAIMER
126 The representation of certain localities as being associated with certain
127 countries and/or territories is for the purposes of identification only,
128 and does not imply any endorsement or rejection on the part of the
129 .Fx
130 Project of the territorial claims of any entity.