mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-24 11:29:10 +00:00
c79edb0b27
* Add a paragraph suggesting that the merge option be used only for files that users have modified. People have been using this option for all files that are different, causing unecessary confusion.
404 lines
11 KiB
Groff
404 lines
11 KiB
Groff
.\" Copyright (c) 1998-2003 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 February 5, 2001
|
|
.Dt MERGEMASTER 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm mergemaster
|
|
.Nd merge configuration files, et al during an upgrade
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl scrvahipCP
|
|
.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
|
|
.Op Fl D Ar /path
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility is a Bourne shell script which is designed to aid you
|
|
in updating the various configuration and other files
|
|
associated with
|
|
.Fx .
|
|
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, or specify the destination
|
|
directory with the
|
|
.Op Fl D
|
|
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
|
|
The merge menu option is designed to let you easily combine your
|
|
customizations from the old version of a file into the new one.
|
|
While you can use the merge function to incorporate changes from
|
|
files that you have not customized,
|
|
it is not recommended.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility 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
|
|
.Nm
|
|
utility will source scripts that you specify right before
|
|
it starts the comparison, and after it's done running.
|
|
The easiest way to handle this is to place the path
|
|
to the script(s) in the appropriate variables in your
|
|
.Pa .mergemasterrc
|
|
file.
|
|
The script sourced before comparison is named in
|
|
.Ev MM_PRE_COMPARE_SCRIPT ,
|
|
and the one sourced after the script is done is
|
|
.Ev MM_EXIT_SCRIPT .
|
|
This is the recommended way to specify local modifications,
|
|
or files that you want to give special handling to.
|
|
This includes files that you want to be deleted without
|
|
being compared.
|
|
Because the named scripts are sourced from within
|
|
.Nm ,
|
|
all of the script's variables are available for use in
|
|
your custom script.
|
|
You can also use
|
|
.Pa /etc/mergemaster.rc
|
|
which will be read before
|
|
.Pa .mergemasterrc .
|
|
Options specified on the command line are updated last,
|
|
and therefore can override both files.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width Fl
|
|
.It Fl s
|
|
Perform a strict comparison, diff'ing every pair of files.
|
|
This comparison is performed line by line,
|
|
without regard to CVS $Id's.
|
|
.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 .
|
|
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 i
|
|
Automatically install any files that do not exist in the
|
|
destination directory.
|
|
.It Fl p
|
|
Pre-buildworld mode.
|
|
Compares only files known to be essential to the success of
|
|
{build|install}world,
|
|
including
|
|
.Pa /etc/make.conf .
|
|
.It Fl C
|
|
After a standard
|
|
.Nm
|
|
run,
|
|
compares your rc.conf[.local] options to the defaults.
|
|
.It Fl P
|
|
Preserve files that you replace in
|
|
.Pa /var/tmp/mergemaster/preserved-files-<date> ,
|
|
or another directory you specify in your
|
|
.Nm
|
|
rc file.
|
|
.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.
|
|
.It Fl D Ar /path
|
|
Specify the destination directory for the installed files.
|
|
.El
|
|
.Sh ENVIRONMENT
|
|
The
|
|
.Nm
|
|
utility 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.
|
|
The
|
|
.Ev MM_PRE_COMPARE_SCRIPT
|
|
and
|
|
.Ev MM_EXIT_SCRIPT
|
|
variables are used as described above.
|
|
Other variables that are used by the script internally
|
|
can be specified in
|
|
.Pa .mergemasterrc
|
|
as described in more detail below.
|
|
.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
|
|
.It Pa /etc/mergemaster.rc
|
|
.It Pa $HOME/.mergemasterrc
|
|
.El
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility will . (source) these files if they exist.
|
|
Command line options
|
|
will override rc file options.
|
|
.Pa $HOME/.mergemasterrc
|
|
overrides
|
|
.Pa /etc/mergemaster.rc .
|
|
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
|
|
#
|
|
# Type of diff, such as unified, context, etc.
|
|
#DIFF_FLAG='-u'
|
|
#
|
|
# Additional options for diff. This will get unset when using -s.
|
|
#DIFF_OPTIONS='-I$\&FreeBSD:.*[$]' # Ignores CVS Id tags
|
|
#
|
|
# Verbose mode includes more details and additional checks
|
|
#VERBOSE=
|
|
#
|
|
# Automatically install files that do not exist on the system already
|
|
#AUTO_INSTALL=
|
|
#
|
|
# Compare /etc/rc.conf[.local] to /etc/defaults/rc.conf
|
|
#COMP_CONFS=yes
|
|
#
|
|
# Preserve files that you replace
|
|
#PRESERVE_FILES=yes
|
|
#PRESERVE_FILES_DIR=/var/tmp/mergemaster/preserved-files-`date +%y%m%d-%H%M%S`
|
|
#
|
|
# 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
|
|
#
|
|
# Specify the destination directory for the installed files
|
|
#DESTDIR=
|
|
#
|
|
# 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
|
|
#
|
|
# Specify the path to scripts to run before the comparison starts,
|
|
# and/or after the script has finished its work
|
|
#MM_PRE_COMPARE_SCRIPT=
|
|
#MM_EXIT_SCRIPT=
|
|
.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
|
|
.Rs
|
|
.%O http://www.FreeBSD.org/doc/handbook/makeworld.html
|
|
.%T The Cutting Edge (using make world)
|
|
.%A Nik Clayton
|
|
.Re
|
|
.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
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
utility 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.
|
|
.Sh AUTHORS
|
|
This manual page and the script itself were written by
|
|
.An Douglas Barton Aq DougB@FreeBSD.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.
|