freebsd-skq/usr.sbin/tzsetup/tzsetup.8

.\" Copyright (c) 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd July 4, 2009
.Dt TZSETUP 8
.Os
.Sh NAME
.Nm tzsetup
.Nd set local timezone
.Sh SYNOPSIS
.Nm
.Op Fl nrs
.Op Fl C Ar chroot directory
.Op Ar zoneinfo file | zoneinfo name
.Sh DESCRIPTION
The
.Nm
utility reads a database of timezone information and presents a menu
allowing the user to select a specific zone without knowing the details
of the database layout.
The selected zone is installed as the system
default zone.
The
.Nm
utility also determines whether any adjustment is necessary for systems where
the hardware clock does not keep
.Tn UTC .
.Pp
The following option is available:
.Bl -tag -offset indent -width Fl
.It Fl C Ar chroot directory
Open all files and directories relative to
.Ar chroot directory .
.It Fl n
Do not create or copy files.
.It Fl r
Reinstall the zoneinfo file installed last time. The name is obtained from
.Pa /var/db/zoneinfo .
.It Fl s 
Skip the initial question about adjusting the clock if not set to
.Tn UTC .
.El
.Pp
It is possible to short-circuit the menu system by specifying the
location of a
.Ar zoneinfo file
or the name of the
.Ar zoneinfo name
on the command line; this is intended mainly for pre-configured installation
scripts or people who know which zoneinfo they want to install.
.Sh TIMEZONE DATABASE
The contents of the timezone database are indexed by
.Pa /usr/share/zoneinfo/zone.tab .
This file lists, for each timezone data file, the
.Tn ISO
3166 territory code, approximate geographical coordinates
(in
.Tn ISO
6709 format),
and location within the territory.
.Pp
The maintainers of the database maintain the following policies:
.Bl -enum -offset indent
.It
At least one zone for every country or inhabited geographical territory.
.It
One zone for every distinct, documented timezone history since the
beginning of the
.Ux
epoch (January 1, 1970,
.Tn GMT ) .
.It
Each zone is named for the most populous city therein.
(Where possible,
the database includes pre-1970 history for its city.)
.El
The source code to the database
.Pq Pa /usr/src/share/zoneinfo/[a-z]*
contains many additional comments and documentation references for the
historically minded.
.Sh FILES
.Bl -tag -width /usr/share/zoneinfo/zone.tab -compact
.It Pa /etc/localtime
current time zone file.
.It Pa /etc/wall_cmos_clock
see
.Xr adjkerntz 8 .
.It Pa /usr/share/misc/iso3166
mapping of
.Tn ISO
3166 territory codes to names.
.It Pa /usr/share/zoneinfo
directory for zoneinfo files.
.It Pa /usr/share/zoneinfo/zone.tab
mapping of timezone file to country and location.
.It Pa /var/db/zoneinfo
saved name of the timezone file installed last.
.El
.Sh EXAMPLES
Normal usage, to select the right zoneinfo file via the dialog-based
user interface:
.Dl # tzsetup
Install the file
.Pa /usr/share/zoneinfo/Australia/Sydney :
.Dl # tzsetup /usr/share/zoneinfo/Australia/Sydney
Install the zoneinfo file for Australia/Sydney, assumed to be located
in
.Pa /usr/share/zoneinfo :
.Dl # tzsetup Australia/Sydney
After a reinstall of the zoneinfo files, you can reinstall the
latest installed zoneinfo file: (as specified in
.Pa /var/db/zoneinfo )
.Dl # tzsetup -r
.Sh SEE ALSO
.Xr date 1 ,
.Xr adjtime 2 ,
.Xr ctime 3 ,
.Xr timezone 3 ,
.Xr tzfile 5 ,
.Xr adjkerntz 8 ,
.Xr zdump 8 ,
.Xr zic 8
.Sh DISCLAIMER
The representation of certain localities as being associated with certain
countries and/or territories is for the purposes of identification only,
and does not imply any endorsement or rejection on the part of the
.Fx
Project of the territorial claims of any entity.
.Sh BUGS
Programs which are already running when
.Nm
creates or updates
.Pa /etc/localtime
will not reflect the updated timezone.
When the system is first configured for a
.Pf non- Tn UTC
hardware clock, it is necessary to run
.Xr adjkerntz 8
(which normally happens as a part of system startup) in order to update
the kernel's idea of the correct timezone offset.
sync copyright with /usr/share/examples/etc/bsd-style-copyright 1996-08-27 20:04:45 +00:00			`.\" Copyright (c) 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.`
			`.\" All rights reserved.`
add a manpage 1996-01-24 00:11:58 +00:00			`.\"`
sync copyright with /usr/share/examples/etc/bsd-style-copyright 1996-08-27 20:04:45 +00:00			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
add a manpage 1996-01-24 00:11:58 +00:00			`.\"`
sync copyright with /usr/share/examples/etc/bsd-style-copyright 1996-08-27 20:04:45 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Add a new options (-s) that, when specified, skips the question about adjusting the clock to UTC. That avoids to write on /etc/wall_cmos_clock which is useful in some cases (example: host user in a jail). Sponsored by: Sandvine Incorporated Initially submitted by: Matt Koivisto <mkoivisto at sandvine dot com> Approved by: re (kib) 2009-07-04 11:11:21 +00:00			`.Dd July 4, 2009`
add a manpage 1996-01-24 00:11:58 +00:00			`.Dt TZSETUP 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:12:08 +00:00			`.Os`
add a manpage 1996-01-24 00:11:58 +00:00			`.Sh NAME`
			`.Nm tzsetup`
Convert "time zone" to "timezone" in NAME section Submitted by: obrien@cs.ucdavis.edu (David E. O'Brien) 1996-02-27 00:27:21 +00:00			`.Nd set local timezone`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Instead of having to know which timezone was picked last time, you now can run "tzsetup -r" which will reinstall the last choice. This data is recorded in /var/db/zoneinfo. MFC after: 1 week 2009-10-20 06:54:31 +00:00			`.Op Fl nrs`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`.Op Fl C Ar chroot directory`
			`.Op Ar zoneinfo file \| zoneinfo name`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.Sh DESCRIPTION`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`The`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.Nm`
The .Nm utility 2002-07-14 14:47:15 +00:00			`utility reads a database of timezone information and presents a menu`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`allowing the user to select a specific zone without knowing the details`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`of the database layout.`
			`The selected zone is installed as the system`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`default zone.`
The .Nm utility 2002-07-14 14:47:15 +00:00			`The`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Nm`
The .Nm utility 2002-07-14 14:47:15 +00:00			`utility also determines whether any adjustment is necessary for systems where`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`the hardware clock does not keep`
			`.Tn UTC .`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.Pp`
			`The following option is available:`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Bl -tag -offset indent -width Fl`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`.It Fl C Ar chroot directory`
			`Open all files and directories relative to`
			`.Ar chroot directory .`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.It Fl n`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`Do not create or copy files.`
Instead of having to know which timezone was picked last time, you now can run "tzsetup -r" which will reinstall the last choice. This data is recorded in /var/db/zoneinfo. MFC after: 1 week 2009-10-20 06:54:31 +00:00			`.It Fl r`
			`Reinstall the zoneinfo file installed last time. The name is obtained from`
			`.Pa /var/db/zoneinfo .`
Add a new options (-s) that, when specified, skips the question about adjusting the clock to UTC. That avoids to write on /etc/wall_cmos_clock which is useful in some cases (example: host user in a jail). Sponsored by: Sandvine Incorporated Initially submitted by: Matt Koivisto <mkoivisto at sandvine dot com> Approved by: re (kib) 2009-07-04 11:11:21 +00:00			`.It Fl s`
			`Skip the initial question about adjusting the clock if not set to`
			`.Tn UTC .`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`.El`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Pp`
Make the usage of the default zoneinfo file to install clearer. MFC after: 1 week 2009-10-19 21:37:31 +00:00			`It is possible to short-circuit the menu system by specifying the`
			`location of a`
			`.Ar zoneinfo file`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`or the name of the`
			`.Ar zoneinfo name`
Make the usage of the default zoneinfo file to install clearer. MFC after: 1 week 2009-10-19 21:37:31 +00:00			`on the command line; this is intended mainly for pre-configured installation`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`scripts or people who know which zoneinfo they want to install.`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Sh TIMEZONE DATABASE`
			`The contents of the timezone database are indexed by`
			`.Pa /usr/share/zoneinfo/zone.tab .`
			`This file lists, for each timezone data file, the`
			`.Tn ISO`
			`3166 territory code, approximate geographical coordinates`
mdoc(7) police: Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text. Not only this slows down the mdoc(7) processing significantly, but it also has an undesired (in this case) effect of disabling hyphenation within the entire enclosed block. 2001-08-07 15:48:51 +00:00			`(in`
			`.Tn ISO`
			`6709 format),`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`and location within the territory.`
			`.Pp`
			`The maintainers of the database maintain the following policies:`
			`.Bl -enum -offset indent`
			`.It`
			`At least one zone for every country or inhabited geographical territory.`
			`.It`
			`One zone for every distinct, documented timezone history since the`
			`beginning of the`
			`.Ux`
			`epoch (January 1, 1970,`
			`.Tn GMT ) .`
			`.It`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`Each zone is named for the most populous city therein.`
			`(Where possible,`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`the database includes pre-1970 history for its city.)`
			`.El`
			`The source code to the database`
			`.Pq Pa /usr/src/share/zoneinfo/[a-z]*`
			`contains many additional comments and documentation references for the`
			`historically minded.`
add a manpage 1996-01-24 00:11:58 +00:00			`.Sh FILES`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Bl -tag -width /usr/share/zoneinfo/zone.tab -compact`
add a manpage 1996-01-24 00:11:58 +00:00			`.It Pa /etc/localtime`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`current time zone file.`
add a manpage 1996-01-24 00:11:58 +00:00			`.It Pa /etc/wall_cmos_clock`
Add usage(). Document -n flag. Do not touch/remove /etc/wall_cmos_clock when -n (do nothing) is used. 1997-10-27 07:49:47 +00:00			`see`
			`.Xr adjkerntz 8 .`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.It Pa /usr/share/misc/iso3166`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`mapping of`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Tn ISO`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`3166 territory codes to names.`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.It Pa /usr/share/zoneinfo`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`directory for zoneinfo files.`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.It Pa /usr/share/zoneinfo/zone.tab`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`mapping of timezone file to country and location.`
Instead of having to know which timezone was picked last time, you now can run "tzsetup -r" which will reinstall the last choice. This data is recorded in /var/db/zoneinfo. MFC after: 1 week 2009-10-20 06:54:31 +00:00			`.It Pa /var/db/zoneinfo`
			`saved name of the timezone file installed last.`
add a manpage 1996-01-24 00:11:58 +00:00			`.El`
- Add support for chrooted installs. - Add examples to the man-page. MFC after: 1 week 2009-10-21 20:55:04 +00:00			`.Sh EXAMPLES`
			`Normal usage, to select the right zoneinfo file via the dialog-based`
			`user interface:`
			`.Dl # tzsetup`
			`Install the file`
			`.Pa /usr/share/zoneinfo/Australia/Sydney :`
			`.Dl # tzsetup /usr/share/zoneinfo/Australia/Sydney`
			`Install the zoneinfo file for Australia/Sydney, assumed to be located`
			`in`
			`.Pa /usr/share/zoneinfo :`
			`.Dl # tzsetup Australia/Sydney`
			`After a reinstall of the zoneinfo files, you can reinstall the`
			`latest installed zoneinfo file: (as specified in`
			`.Pa /var/db/zoneinfo )`
			`.Dl # tzsetup -r`
add a manpage 1996-01-24 00:11:58 +00:00			`.Sh SEE ALSO`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr date 1 ,`
add a manpage 1996-01-24 00:11:58 +00:00			`.Xr adjtime 2 ,`
			`.Xr ctime 3 ,`
			`.Xr timezone 3 ,`
			`.Xr tzfile 5 ,`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr adjkerntz 8 ,`
add a manpage 1996-01-24 00:11:58 +00:00			`.Xr zdump 8 ,`
Convert err() to errx(), reason is already provided. Complete the abort on allocation failure instead of deferencing NULL later. 2000-01-23 20:25:01 +00:00			`.Xr zic 8`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`.Sh DISCLAIMER`
			`The representation of certain localities as being associated with certain`
			`countries and/or territories is for the purposes of identification only,`
			`and does not imply any endorsement or rejection on the part of the`
Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00			`.Fx`
Add a `default' feature to tzsetup for use in script-driven installation (if someone writes the other half). Also rewrite the man page in a more appropriate (formal) style. 1999-02-02 20:26:31 +00:00			`Project of the territorial claims of any entity.`
Sort sections. 2005-01-18 20:02:45 +00:00			`.Sh BUGS`
			`Programs which are already running when`
			`.Nm`
			`creates or updates`
			`.Pa /etc/localtime`
			`will not reflect the updated timezone.`
			`When the system is first configured for a`
			`.Pf non- Tn UTC`
			`hardware clock, it is necessary to run`
			`.Xr adjkerntz 8`
			`(which normally happens as a part of system startup) in order to update`
			`the kernel's idea of the correct timezone offset.`