1 .\" Copyright (c) 1998-2010 Douglas Barton
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd merge configuration files, et al during an upgrade
37 .Op Fl m Ar /path/to/sources
38 .Op Fl t Ar /path/to/temp/root
42 .Op Fl A Ar Target architecture
43 .Op Fl D Ar /destdir/path
47 utility is a Bourne shell script which is designed to aid you
48 in updating the various configuration and other files
53 recommended that you back up your
55 directory before beginning this process.
59 to build a temporary root environment from
61 down, populating that environment with the various
63 You can specify a different source directory
66 command line option, or specify the destination
70 It then compares each file in that environment
71 to its installed counterpart.
72 When the script finds a
73 change in the new file, or there is no installed
74 version of the new file it gives you four options to
76 You can install the new file as is,
77 delete the new file, merge the old and new
78 files (as appropriate) using
80 or leave the file in the temporary root environment to
83 By default it creates the temporary root in
86 Version Control System (VCS) Id strings ($FreeBSD)
87 for files that have them, deleting
88 the temporary file if the strings match.
90 no Id string, or if the strings are different it
91 compares the files themselves.
93 also specify that the script ignore the Id strings and
94 compare every file with the
101 will install the new file for you if they differ only by
104 The merge menu option is designed to let you easily combine your
105 customizations from the old version of a file into the new one.
106 While you can use the merge function to incorporate changes from
107 files that you have not customized,
108 it is not recommended.
112 utility checks your umask and issues a warning for anything
114 While it is not mandatory to grant
115 world read permissions for most configuration files, you
116 may run into problems without them.
118 umask other than 022 and experience trouble later this
120 .Pa /etc/master.passwd
121 is treated as a special case.
122 If you choose to install
123 this file or a merged version of it the file permissions
124 are always 600 (rw-------) for security reasons.
126 installing an updated version of this file you should
131 option to rebuild your password databases
135 The script uses the owner and group ids
136 that the files are created with by
137 .Pa /usr/src/etc/Makefile ,
138 and file permissions as specified by the umask.
139 Unified diffs are used by default to display any
140 differences unless you choose context diffs.
144 utility will source scripts that you specify right before
145 it starts the comparison, and after it is done running.
146 The easiest way to handle this is to place the path
147 to the script(s) in the appropriate variables in your
150 The script sourced before comparison is named in
151 .Ev MM_PRE_COMPARE_SCRIPT ,
152 and the one sourced after the script is done is
154 This is the recommended way to specify local modifications,
155 or files that you want to give special handling to.
156 This includes files that you want to be deleted without
158 Because the named scripts are sourced from within
160 all of the script's variables are available for use in
163 .Pa /etc/mergemaster.rc
164 which will be read before
166 Options specified on the command line are updated last,
167 and therefore can override both files.
169 When the comparison is done if there are any files remaining
170 in the temproot directory they will be listed, and if the
172 option is not in use the user will be given the option of
173 deleting the temproot directory.
174 If there are no files remaining in the temproot directory
177 The options are as follows:
180 Perform a strict comparison, diffing every pair of files.
181 This comparison is performed line by line,
182 without regard to VCS Ids.
184 Use context diffs instead of unified diffs.
188 on a previously cleaned directory, skipping the creation of
189 the temporary root environment.
190 This option is compatible
191 with all other options.
193 Be more verbose about the process.
194 You should probably use
195 this option the first time you run
197 This option also gives you a list of files that exist
198 only in the installed version of
202 This option will leave all the files that
203 differ from the installed versions in the temporary directory
204 to be dealt with by hand.
207 directory exists, it creates a new one in a previously
208 non-existent directory.
209 This option unsets the verbose flag,
210 and is not compatible with
221 Display usage and help information.
223 Automatically install any files that do not exist in the
224 destination directory.
227 Compares only files known to be essential to the success of
228 {build|install}world,
232 If the files differ only by VCS Id ($FreeBSD)
233 install the new file.
238 compares your rc.conf[.local] options to the defaults.
240 Preserve files that you replace in
241 .Pa /var/tmp/mergemaster/preserved-files-<date> ,
242 or another directory you specify in your
246 Attempt to auto upgrade files that have not been user modified.
247 .It Fl m Ar /path/to/sources
248 Specify the path to the directory where you want to do the
250 (In other words, where your sources are, but -s was already
252 In previous versions of
254 you needed to specify the path all the way to
256 Starting with r186678 you only need to specify the path to
259 will convert the path for you if you use the old method.
260 .It Fl t Ar /path/to/temp/root
261 Create the temporary root environment in
262 .Pa /path/to/temp/root
263 instead of the default
264 .Pa /var/tmp/temproot .
266 Add the date and time to the name of the temporary
270 is specified, this option must
271 follow it if you want the date added too.
273 Specify a numeric umask.
276 Supply an alternate screen width to the
278 command in numbers of columns.
280 .It Fl A Ar Target architecture
281 Specify an alternative
285 Specify the destination directory for the installed files.
292 environment variable if set.
297 specifies a program outside
301 without specifying the full path,
303 prompts you with options on how to proceed.
305 .Ev MM_PRE_COMPARE_SCRIPT
308 variables are used as described above.
309 Other variables that are used by the script internally
312 as described in more detail below.
314 .Bl -tag -width $HOME/.mergemasterrc -compact
315 .It Pa /etc/mergemaster.rc
316 .It Pa $HOME/.mergemasterrc
323 (source) these files if they exist.
325 will override rc file options.
326 .Pa $HOME/.mergemasterrc
328 .Pa /etc/mergemaster.rc .
330 with all values commented out:
333 # These are options for mergemaster, with their default values listed
334 # The following options have command line overrides
336 # The target architecture (-A, unset by default)
337 #ARCHSTRING='TARGET_ARCH=<foo>'
339 # Sourcedir is the directory to do the 'make' in (-m)
340 #SOURCEDIR='/usr/src'
342 # Directory to install the temporary root environment into (-t)
343 #TEMPROOT='/var/tmp/temproot'
345 # Specify the destination directory for the installed files (-D)
348 # Strict comparison skips the VCS Id test and compares every file (-s)
351 # Type of diff, such as unified, context, etc. (-c)
354 # Install the new file if it differs only by VCS Id ($FreeBSD, -F)
357 # Verbose mode includes more details and additional checks (-v)
360 # Automatically install files that do not exist on the system already (-i)
363 # Automatically upgrade files that have not been user modified (-U)
366 # Compare /etc/rc.conf[.local] to /etc/defaults/rc.conf (-C)
369 # Preserve files that you replace (-P)
371 #PRESERVE_FILES_DIR=/var/tmp/mergemaster/preserved-files-`date +%y%m%d-%H%M%S`
373 # The umask for mergemaster to compare the default file's modes to (-u)
376 # The following options have no command line overrides
378 # Files to always avoid comparing
379 #IGNORE_FILES='/etc/motd /etc/printcap foo bar'
381 # Additional options for diff. This will get unset when using -s.
382 #DIFF_OPTIONS='-Bb' # Ignore changes in whitespace
384 # Location to store the list of mtree values for AUTO_UPGRADE purposes
387 # For those who just cannot stand including the full path to PAGER
390 # If you set 'yes' above, make sure to include the PATH to your pager
391 #PATH=/bin:/usr/bin:/usr/sbin
393 # Delete stale files in /etc/rc.d without prompting
394 #DELETE_STALE_RC_FILES=
396 # Specify the path to scripts to run before the comparison starts,
397 # and/or after the script has finished its work
398 #MM_PRE_COMPARE_SCRIPT=
402 Exit status is 0 on successful completion, or if the user bails out
403 manually at some point during execution.
405 Exit status is 1 if it fails for one of the following reasons:
407 Invalid command line option
409 Failure to create the temporary root environment
411 Failure to populate the temporary root
413 Presence of the 'nodev' option in
414 .Pa <DESTDIR>/etc/fstab
416 Failure to install a file
418 Typically all you will need to do is type
420 at the prompt and the script will do all the work for you.
422 To use context diffs and have
424 explain more things as it goes along, use:
426 .Dl # mergemaster -cv
430 put the temporary root environment in
434 .Dl # mergemaster -t /usr/tmp/root
436 To specify a 110 column screen with a strict
439 .Dl # mergemaster -sw 110
447 .Pa /usr/src/etc/Makefile
449 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
450 .%T The Cutting Edge (using make world)
456 utility was first publicly available on one of my
457 web pages in a much simpler form under the name
460 The idea for creating the
461 temporary root environment comes from Nik Clayton's
462 make world tutorial which is referenced above.
464 This manual page and the script itself were written by
465 .An Douglas Barton Aq DougB@FreeBSD.org .
467 There are no known bugs.
468 Please report any problems,
469 comments or suggestions to the author.
471 improvements to this program have come from user