mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-26 11:47:31 +00:00
280 lines
8.3 KiB
Groff
280 lines
8.3 KiB
Groff
.\" Copyright (c) 1998, 1999 Douglas Barton
|
|
.\" 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 September 10, 1999
|
|
.Dt MERGEMASTER 8
|
|
.Os FreeBSD
|
|
.Sh NAME
|
|
.Nm mergemaster
|
|
.Nd Merge configuration files, et al during an upgrade
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl scrvah
|
|
.Op Fl m Ar /path/to/sources
|
|
.Op Fl t Ar /path/to/temp/root
|
|
.Op Fl d
|
|
.Op Fl u Ar N
|
|
.Op Fl w Ar N
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
is a Bourne shell script which is designed to aid you
|
|
in updating the various configuration and other files
|
|
associated with FreeBSD.
|
|
It is
|
|
.Sy HIGHLY
|
|
recommended that you back up your
|
|
.Pa /etc
|
|
directory before beginning this process.
|
|
.Pp
|
|
The script uses
|
|
.Pa /usr/src/etc/Makefile
|
|
to build a temporary root environment from
|
|
.Pa /
|
|
down, populating that environment with the various
|
|
files. You can specify a different source directory
|
|
with the
|
|
.Op Fl m
|
|
command line option.
|
|
It then compares each file in that environment
|
|
to its installed counterpart. When the script finds a
|
|
change in the new file, or there is no installed
|
|
version of the new file it gives you four options to
|
|
deal with it. You can install the new file as is,
|
|
delete the new file, merge the old and new
|
|
files (as appropriate) using
|
|
.Xr sdiff 1
|
|
or leave the file in the temporary root environment to
|
|
merge by hand later.
|
|
.Pp
|
|
By default it creates the temporary root in
|
|
.Pa /var/tmp/temproot
|
|
and compares the
|
|
.Xr cvs 1
|
|
version $Id/$FreeBSD strings for files that have them, deleting
|
|
the temporary file if the strings match. If there is
|
|
no $Id string, or if the strings are different it
|
|
compares the files themselves. You can
|
|
also specify that the script ignore the $Id strings and
|
|
compare every file.
|
|
.Pp
|
|
.Nm
|
|
checks your umask and issues a warning for anything
|
|
other than 022. While it is not mandatory to grant
|
|
world read permissions for most configuration files, you
|
|
may run into problems without them. If you choose a
|
|
umask other than 022 and experience trouble later this
|
|
could be the cause.
|
|
.Pa /etc/master.passwd
|
|
is treated as a special case. If you choose to install
|
|
this file or a merged version of it the file permissions
|
|
are always 600 (rw-------) for security reasons. After
|
|
installing an updated version of this file you should
|
|
probably run
|
|
.Xr pwd_mkdb 8
|
|
with the -p option to rebuild your password databases
|
|
and recreate
|
|
.Pa /etc/passwd .
|
|
.Pp
|
|
The script uses the owner and group id's
|
|
that the files are created with by
|
|
.Pa /usr/src/etc/Makefile ,
|
|
and file permissions as specified by the umask.
|
|
Unified diffs are used by default to display any
|
|
differences unless you choose context diffs.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width Fl
|
|
.It Fl s
|
|
Perform a strict comparison, diff'ing every pair of files.
|
|
.It Fl c
|
|
Use context diffs instead of unified diffs.
|
|
.It Fl r
|
|
Re-run
|
|
.Nm
|
|
on a previously cleaned directory, skipping the creation of
|
|
the temporary root environment. This option is compatible
|
|
with all other options.
|
|
.It Fl v
|
|
Be more verbose about the process. You should probably use
|
|
this option the first time you run
|
|
.Nm mergemaster .
|
|
This option also gives you a list of files that exist
|
|
only in the installed version of
|
|
.Pa /etc .
|
|
.It Fl a
|
|
Run automatically. This option will leave all the files that
|
|
differ from the installed versions in the temporary directory
|
|
to be dealt with by hand. If the
|
|
.Pa temproot
|
|
directory exists, it creates a new one in a previously
|
|
non-existent directory. This option unsets the verbose flag,
|
|
but is compatible with all other options. Setting -a makes
|
|
-w superfluous.
|
|
.It Fl h
|
|
Display usage and help information.
|
|
.It Fl m Ar /path/to/sources
|
|
Specify the path to the directory where you want to do the
|
|
.Xr make 1 .
|
|
(In other words, where your sources are, but -s was already
|
|
taken.)
|
|
.It Fl t Ar /path/to/temp/root
|
|
Create the temporary root environment in
|
|
.Pa /path/to/temp/root
|
|
instead of the default
|
|
.Pa /var/tmp/temproot .
|
|
.It Fl d
|
|
Add the date and time to the name of the temporary
|
|
root directory. If -t is specified, this option must
|
|
follow it if you want the date added too.
|
|
.It Fl u Ar N
|
|
Specify a numeric umask. The default is 022.
|
|
.It Fl w Ar N
|
|
Supply an alternate screen width to the
|
|
.Xr sdiff 1
|
|
command in numbers of columns. The default is 80.
|
|
.El
|
|
.Sh ENVIRONMENT
|
|
The
|
|
.Nm
|
|
script uses the
|
|
.Ev PAGER
|
|
environment variable if set. Otherwise it uses
|
|
.Xr more 1 .
|
|
If
|
|
.Ev PAGER
|
|
specifies a program outside
|
|
its
|
|
limited
|
|
.Ev PATH
|
|
without specifying the full path,
|
|
.Nm
|
|
prompts you with options on how to proceed.
|
|
.Sh EXAMPLES
|
|
Typically all you will need to do is type
|
|
.Nm
|
|
at the prompt and the script will do all the work for you.
|
|
.Pp
|
|
To use context diff's and have
|
|
.Nm
|
|
explain more things as it goes along, use:
|
|
.Pp
|
|
.Dl # mergemaster -cv
|
|
.Pp
|
|
To specify that
|
|
.Nm
|
|
put the temporary root environment in
|
|
.Pa /usr/tmp/root ,
|
|
use:
|
|
.Pp
|
|
.Dl # mergemaster -t /usr/tmp/root
|
|
.Pp
|
|
To specify a 110 column screen with a strict
|
|
comparison, use:
|
|
.Pp
|
|
.Dl # mergemaster -sw 110
|
|
.Sh FILES
|
|
.Bl -tag -width $HOME/.mergemasterrc -compact
|
|
.Pa $HOME/.mergemasterrc
|
|
.Pp
|
|
.Nm
|
|
will . (source) this file if it exists. Command line options
|
|
will override rc file options. Here is an example
|
|
with all values commented out:
|
|
.Pp
|
|
.Bd -literal
|
|
# These are options for mergemaster, with their default values listed
|
|
# The following options have command line overrides
|
|
#
|
|
# Directory to install the temporary root environment into
|
|
#TEMPROOT='/var/tmp/temproot'
|
|
#
|
|
# Strict comparison bypasses the CVS $Id tests and compares every file
|
|
#STRICT=no
|
|
#
|
|
# Flag(s) to use for diff displayed when files differ
|
|
#DIFF_FLAG='-u'
|
|
#
|
|
# Verbose mode includes more details and additional checks
|
|
#VERBOSE=
|
|
#
|
|
# Sourcedir is the directory to do the 'make' in (where the new files are)
|
|
#SOURCEDIR=/usr/src/etc
|
|
#
|
|
# The umask for mergemaster to compare the default file's modes to
|
|
#NEW_UMASK=022
|
|
#
|
|
# The following options have no command line overrides
|
|
# For those who just cannot stand including the full path to PAGER
|
|
#DONT_CHECK_PAGER=
|
|
# If you set 'yes' above, make sure to include the PATH to your pager
|
|
#PATH=/bin:/usr/bin:/usr/sbin
|
|
# Don't compare the old and new motd files
|
|
#IGNORE_MOTD=yes
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr cvs 1 ,
|
|
.Xr diff 1 ,
|
|
.Xr make 1 ,
|
|
.Xr more 1 ,
|
|
.Xr sdiff 1 ,
|
|
.Xr pwd_mkdb 8
|
|
.Pp
|
|
.Pa /usr/src/etc/Makefile
|
|
.Pp
|
|
http://www.FreeBSD.org/tutorials/,
|
|
.Pa Upgrading FreeBSD from source (using make world) ,
|
|
by Nik Clayton
|
|
.Sh DIAGNOSTICS
|
|
Exit status is 0 on successful completion, or if the user bails out
|
|
manually at some point during execution.
|
|
.Pp
|
|
Exit status is 1 if it fails for one of the following reasons:
|
|
.Pp
|
|
Invalid command line option
|
|
.Pp
|
|
Failure to create the temporary root environment
|
|
.Pp
|
|
Failure to populate the temporary root
|
|
.Pp
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
script was first publicly available on one of my
|
|
web pages in a much simpler form under the name
|
|
.Pa comproot
|
|
on 13 March 1998. The idea for creating the
|
|
temporary root environment comes from Nik Clayton's
|
|
make world tutorial which is referenced above.
|
|
.Pp
|
|
.Sh AUTHOR
|
|
This manual page and the script itself were written by
|
|
.An Douglas Barton Aq Doug@gorean.org .
|
|
.Sh BUGS
|
|
There are no known bugs. Please report any problems,
|
|
comments or suggestions to the author. Several of the
|
|
improvements to this program have come from user
|
|
suggestions. Thank you.
|