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