Copyright (c) 2001 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Martti Kuparinen.
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.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the NetBSD
Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.Dd April 2, 2003 .Dt ETCUPDATE 8 .Os .Sh NAME .Nm etcupdate .Nd update the configuration and startup files in
a /etc .Sh SYNOPSIS .Nm .Op Fl a .Op Fl b Ar srcdir .Op Fl h .Op Fl l .Op Fl p Ar pager .Op Fl s Ar srcdir .Op Fl t Ar temproot .Op Fl v .Op Fl w Ar width .Sh DESCRIPTION .Nm is a tool that lets the administrator update the configuration and startup files in
a /etc (and some other directories like
a /dev ,
a /root and
a /var ) without having to manually check and modify every file. The administrator should run this script after performing an operating system update (e.g. after running
a make build in
a /usr/src or after extracting new binary distribution files) to update to the latest configuration and startup files.
p .Nm compares the new configuration files against the currently installed files. The user is given the option of installing, merging or deleting each modified or missing file. .Nm also detects if the user installs certain special files and performs corresponding tasks like remaking device nodes or rebuilding a database from the .Xr aliases 5 file.
p .Nm needs a clean set of new configuration files to compare the existing files against. These files, called the .Dq reference files in this manual, may be derived from either a source or binary distribution of .Nx .
p If the user is updating from sources (which is the default mode), .Nm will first create a copy of the reference files by running
a make distribution in
a /usr/src/etc , installing the files to a so-called
a temproot . (See usage of the .Fl s Ar srcdir , and .Fl t Ar temproot options later in this manual page.)
p Instead of using sources, the user can also extract one or more binary distribution sets in a special location and use those as the reference files (see usage of the .Fl b Ar srcdir option later in this manual page).
p The following options are available: l -tag -width indent t Fl a .Nm can automatically update files which have not been modified locally. The .Fl a flag instructs .Nm to store MD5 checksums in
a /var/etcupdate and use these checksums to determine if there have been any local modifications. t Fl b Location of reference files extracted from a binary distribution of .Nx . Note that reference files in
a srcdir will be altered and removed by .Nm when using the .Fl b Ar srcdir option (as the
a srcdir directory is treated like
a temproot ) . t Fl h Prints a help text. t Fl l Automatically skip files with unchanged RCS IDs. This has the effect of leaving alone files that have been altered locally but which have not been changed in the reference files. Since this works using RCS IDs, files without RCS IDs will not be skipped even if only modified locally. This flag may be used together with the .Fl a flag described above. t Fl p The pager to use when displaying files. By default this is .Xr more 1 but it can be changed either with this option or by defining the .Ev PAGER variable. t Fl s The location of the .Nx sources files used to create the reference files. By default this is
a /usr/src/etc but it can be changed either with this option or the .Ev SRCDIR variable. t Fl t Specifies the location of the
a temproot directory. The temporary reference files created from
a /usr/src/etc will be stored there. By default this is
a /tmp/temproot but can be changed either with this option or the .Ev TEMPROOT environment variable. t Fl v Makes .Nm verbose about its actions. t Fl w Sets screen width used during interactive merge. By default this is the number of columns .Xr stty 1 reports but it can be changed either with this option or by defining the .Ev WIDTH variable. This is useful for .Xr xterm 1 users with wider shell windows. .El .Sh ENVIRONMENT l -tag -width TEMPROOT t Ev TEMPROOT Sets a default value for
a temproot . See .Fl t above. t Ev SRCDIR The location of the .Nx sources files. See .Fl s above. t Ev PAGER The pager to use when displaying files. See .Fl p above. t Ev WIDTH The screen width used during interactive merge. See .Fl w above. t Ev IGNOREFILES A list of files that .Nm should ignore. Files listed in this variable will never be considered for updating by .Nm . .El .Sh FILES The environment variables can also be defined in the following configuration files. The user's personal configuration file settings override the global settings.
p ~/.etcupdaterc .Sh EXAMPLES You have just upgraded your .Nx host from 1.6 to 1.6.1 and now it's time to update the configuration files as well. To update the configuration files from the sources (if you have the
p .Dl etcupdate
p The default location of the source files is
a /usr/src/etc but this may be overridden with the .Fl s Ar srcdir command line argument:
p .Dl etcupdate -s /some/where/src/etc
p To update the configuration files from binary distribution sets do something like this:
p .Dl mkdir /tmp/temproot .Dl cd /tmp/temproot .Dl tar xpzf /some/where/etc.tgz .Dl etcupdate -b /tmp/temproot
p You have modified only few files in the
a /etc directory so you would like install most of the updates without being asked. To automatically update the unmodified configuration files:
p .Dl etcupdate -a
p To get a better idea what's going on, use the .Fl v flag:
p .Dl etcupdate -v .Sh SEE ALSO .Xr cmp 1 , .Xr more 1 , .Xr rcs 1 , .Xr sdiff 1 , .Xr stty 1 , .Xr aliases 5 .Sh HISTORY The .Nm command appeared in .Nx 1.6 . .Sh AUTHORS The script was written by .An Martti Kuparinen .Aq martti@NetBSD.org and improved by several other .Nx users.
p
The idea for this script (including code fragments, variable names etc.)
came from the
.Fx
mergemaster (by Douglas Barton).
Unlike the
.Fx
mergemaster, this does not use CVS version tags by default to compare if
the files need to be updated.
Files are compared with
.Xr cmp 1
as this is more reliable and the only way if the version numbers are the
same even though the files are different.
when exactly are the version the same even though the file changes?
.Pp
.Sh BUGS
Because of the use of
.Xr cmp 1
to compare files, rather than CVS versions, files that are locally changed
from the distribution are always considered needing to be updated.