usr.sbin/mergemaster/mergemaster.8

   1 .\" Copyright (c) 1998-2011 Douglas Barton
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd November 1, 2011
  28 .Dt MERGEMASTER 8
  29 .Os
  30 .Sh NAME
  31 .Nm mergemaster
  32 .Nd merge configuration files, et al during an upgrade
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl scrvhpCP
  36 .Op Fl a|iFU
  37 .Op Fl -run-updates=[always|never]
  38 .Op Fl m Ar /path/to/sources
  39 .Op Fl t Ar /path/to/temp/root
  40 .Op Fl d
  41 .Op Fl u Ar N
  42 .Op Fl w Ar N
  43 .Op Fl A Ar Target architecture
  44 .Op Fl D Ar /destdir/path
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is a Bourne shell script which is designed to aid you
  49 in updating the various configuration and other files
  50 associated with
  51 .Fx .
  52 It is
  53 .Sy HIGHLY
  54 recommended that you back up your
  55 .Pa /etc
  56 directory before beginning this process.
  57 .Pp
  58 The script uses
  59 .Pa /usr/src/Makefile
  60 to build a temporary root environment from
  61 .Pa /
  62 down, populating that environment with the various
  63 files.
  64 You can specify a different source directory
  65 with the
  66 .Fl m
  67 command line option, or specify the destination
  68 directory with the
  69 .Fl D
  70 option.
  71 It then compares each file in that environment
  72 to its installed counterpart.
  73 When the script finds a
  74 change in the new file, or there is no installed
  75 version of the new file it gives you four options to
  76 deal with it.
  77 You can install the new file as is,
  78 delete the new file, merge the old and new
  79 files (as appropriate) using
  80 .Xr sdiff 1
  81 or leave the file in the temporary root environment to
  82 merge by hand later.
  83 .Pp
  84 By default it creates the temporary root in
  85 .Pa /var/tmp/temproot
  86 and compares the
  87 Version Control System (VCS) Id strings ($FreeBSD)
  88 for files that have them, deleting
  89 the temporary file if the strings match.
  90 If there is
  91 no Id string, or if the strings are different it
  92 compares the files themselves.
  93 You can
  94 also specify that the script ignore the Id strings and
  95 compare every file with the
  96 .Fl s
  97 option.
  98 Using the
  99 .Fl F
 100 option
 101 .Nm
 102 will install the new file for you if they differ only by
 103 VCS strings.
 104 .Pp
 105 The merge menu option is designed to let you easily combine your
 106 customizations from the old version of a file into the new one.
 107 While you can use the merge function to incorporate changes from
 108 files that you have not customized,
 109 it is not recommended.
 110 .Pp
 111 The
 112 .Nm
 113 utility checks your umask and issues a warning for anything
 114 other than 022.
 115 While it is not mandatory to grant
 116 world read permissions for most configuration files, you
 117 may run into problems without them.
 118 If you choose a
 119 umask other than 022 and experience trouble later this
 120 could be the cause.
 121 .Pa /etc/master.passwd
 122 is treated as a special case.
 123 If you choose to install
 124 this file or a merged version of it the file permissions
 125 are always 600 (rw-------) for security reasons.
 126 After
 127 installing an updated version of this file you should
 128 probably run
 129 .Xr pwd_mkdb 8
 130 with the
 131 .Fl p
 132 option to rebuild your password databases
 133 and recreate
 134 .Pa /etc/passwd .
 135 .Pp
 136 The script uses the owner and group ids
 137 that the files are created with by
 138 .Pa /usr/src/etc/Makefile ,
 139 and file permissions as specified by the umask.
 140 Unified diffs are used by default to display any
 141 differences unless you choose context diffs.
 142 .Pp
 143 The
 144 .Nm
 145 utility will source scripts that you specify right before
 146 it starts the comparison, and after it is done running.
 147 The easiest way to handle this is to place the path
 148 to the script(s) in the appropriate variables in your
 149 .Pa .mergemasterrc
 150 file.
 151 The script sourced before comparison is named in
 152 .Ev MM_PRE_COMPARE_SCRIPT ,
 153 and the one sourced after the script is done is
 154 .Ev MM_EXIT_SCRIPT .
 155 This is the recommended way to specify local modifications,
 156 or files that you want to give special handling to.
 157 This includes files that you want to be deleted without
 158 being compared.
 159 Because the named scripts are sourced from within
 160 .Nm ,
 161 all of the script's variables are available for use in
 162 your custom script.
 163 You can also use
 164 .Pa /etc/mergemaster.rc
 165 which will be read before
 166 .Pa .mergemasterrc .
 167 Options specified on the command line are updated last,
 168 and therefore can override both files.
 169 .Pp
 170 When the comparison is done if there are any files remaining
 171 in the temproot directory they will be listed, and if the
 172 .Fl a
 173 option is not in use the user will be given the option of
 174 deleting the temproot directory.
 175 If there are no files remaining in the temproot directory
 176 it will be deleted.
 177 .Pp
 178 The options are as follows:
 179 .Bl -tag -width Fl
 180 .It Fl s
 181 Perform a strict comparison, diffing every pair of files.
 182 This comparison is performed line by line,
 183 without regard to VCS Ids.
 184 .It Fl c
 185 Use context diffs instead of unified diffs.
 186 .It Fl r
 187 Re-run
 188 .Nm
 189 on a previously cleaned directory, skipping the creation of
 190 the temporary root environment.
 191 This option is compatible
 192 with all other options.
 193 .It Fl v
 194 Be more verbose about the process.
 195 You should probably use
 196 this option the first time you run
 197 .Nm .
 198 This option also gives you a list of files that exist
 199 only in the installed version of
 200 .Pa /etc .
 201 .It Fl a
 202 Run automatically.
 203 This option will leave all the files that
 204 differ from the installed versions in the temporary directory
 205 to be dealt with by hand.
 206 If the
 207 .Pa temproot
 208 directory exists, it creates a new one in a previously
 209 non-existent directory.
 210 This option unsets the verbose flag,
 211 and is not compatible with
 212 .Fl i ,
 213 .Fl F ,
 214 or
 215 .Fl U .
 216 Setting
 217 .Fl a
 218 makes
 219 .Fl w
 220 superfluous.
 221 .It Fl h
 222 Display usage and help information.
 223 .It Fl i
 224 Automatically install any files that do not exist in the
 225 destination directory.
 226 .It Fl p
 227 Pre-buildworld mode.
 228 Compares only files known to be essential to the success of
 229 {build|install}world,
 230 including
 231 .Pa /etc/make.conf .
 232 .It Fl F
 233 If the files differ only by VCS Id ($FreeBSD)
 234 install the new file.
 235 .It Fl C
 236 After a standard
 237 .Nm
 238 run,
 239 compares your rc.conf[.local] options to the defaults.
 240 .It Fl P
 241 Preserve files that you replace in
 242 .Pa /var/tmp/mergemaster/preserved-files-<date> ,
 243 or another directory you specify in your
 244 .Nm
 245 rc file.
 246 .It Fl U
 247 Attempt to auto upgrade files that have not been user modified.
 248 This option can be dangerous when there are critical changes
 249 in the new versions that affect your running system.
 250 .It Fl -run-updates=[always|never]
 251 Specify always or never to run newaliases, pwd_mkdb, etc.
 252 at the end of the comparison run.
 253 If this option is omitted the default is to prompt the user
 254 for each update as necessary.
 255 .It Fl m Ar /path/to/sources
 256 Specify the path to the directory where you want to do the
 257 .Xr make 1 .
 258 (In other words, where your sources are, but -s was already
 259 taken.)
 260 In previous versions of
 261 .Nm
 262 you needed to specify the path all the way to
 263 .Pa src/etc .
 264 Starting with r186678 you only need to specify the path to
 265 .Pa src .
 266 .Nm
 267 will convert the path for you if you use the old method.
 268 .It Fl t Ar /path/to/temp/root
 269 Create the temporary root environment in
 270 .Pa /path/to/temp/root
 271 instead of the default
 272 .Pa /var/tmp/temproot .
 273 .It Fl d
 274 Add the date and time to the name of the temporary
 275 root directory.
 276 If
 277 .Fl t
 278 is specified, this option must
 279 follow it if you want the date added too.
 280 .It Fl u Ar N
 281 Specify a numeric umask.
 282 The default is 022.
 283 .It Fl w Ar N
 284 Supply an alternate screen width to the
 285 .Xr sdiff 1
 286 command in numbers of columns.
 287 The default is 80.
 288 .It Fl A Ar Target architecture
 289 Specify an alternative
 290 .Ev TARGET_ARCH
 291 architecture name.
 292 .It Fl D Ar /path
 293 Specify the destination directory for the installed files.
 294 .El
 295 .Sh ENVIRONMENT
 296 The
 297 .Nm
 298 utility uses the
 299 .Ev PAGER
 300 environment variable if set.
 301 Otherwise it uses
 302 .Xr more 1 .
 303 If
 304 .Ev PAGER
 305 specifies a program outside
 306 its
 307 limited
 308 .Ev PATH
 309 without specifying the full path,
 310 .Nm
 311 prompts you with options on how to proceed.
 312 The
 313 .Ev MM_PRE_COMPARE_SCRIPT
 314 and
 315 .Ev MM_EXIT_SCRIPT
 316 variables are used as described above.
 317 Other variables that are used by the script internally
 318 can be specified in
 319 .Pa .mergemasterrc
 320 as described in more detail below.
 321 .Sh FILES
 322 .Bl -tag -width $HOME/.mergemasterrc -compact
 323 .It Pa /etc/mergemaster.rc
 324 .It Pa $HOME/.mergemasterrc
 325 .El
 326 .Pp
 327 The
 328 .Nm
 329 utility will
 330 .Ic .\&
 331 (source) these files if they exist.
 332 Command line options
 333 will override rc file options.
 334 .Pa $HOME/.mergemasterrc
 335 overrides
 336 .Pa /etc/mergemaster.rc .
 337 Here is an example
 338 with all values commented out:
 339 .Bd -literal
 340 # These are options for mergemaster, with their default values listed
 341 # The following options have command line overrides
 342 #
 343 # The target architecture (-A, unset by default)
 344 #ARCHSTRING='TARGET_ARCH=<foo>'
 345 #
 346 # Sourcedir is the directory to do the 'make' in (-m)
 347 #SOURCEDIR='/usr/src'
 348 #
 349 # Directory to install the temporary root environment into (-t)
 350 #TEMPROOT='/var/tmp/temproot'
 351 #
 352 # Specify the destination directory for the installed files (-D)
 353 #DESTDIR=
 354 #
 355 # Strict comparison skips the VCS Id test and compares every file (-s)
 356 #STRICT=no
 357 #
 358 # Type of diff, such as unified, context, etc. (-c)
 359 #DIFF_FLAG='-u'
 360 #
 361 # Install the new file if it differs only by VCS Id ($FreeBSD, -F)
 362 #FREEBSD_ID=
 363 #
 364 # Verbose mode includes more details and additional checks (-v)
 365 #VERBOSE=
 366 #
 367 # Automatically install files that do not exist on the system already (-i)
 368 #AUTO_INSTALL=
 369 #
 370 # Automatically upgrade files that have not been user modified (-U)
 371 # ***DANGEROUS***
 372 #AUTO_UPGRADE=
 373 #
 374 # Either always or never run newaliases, pwd_mkdb at the end (--run-updates)
 375 #RUN_UPDATES=
 376 #
 377 # Compare /etc/rc.conf[.local] to /etc/defaults/rc.conf (-C)
 378 #COMP_CONFS=
 379 #
 380 # Preserve files that you replace (-P)
 381 #PRESERVE_FILES=
 382 #PRESERVE_FILES_DIR=/var/tmp/mergemaster/preserved-files-`date +%y%m%d-%H%M%S`
 383 #
 384 # The umask for mergemaster to compare the default file's modes to (-u)
 385 #NEW_UMASK=022
 386 #
 387 # The following options have no command line overrides
 388 #
 389 # Files to always avoid comparing
 390 #IGNORE_FILES='/etc/motd /etc/printcap foo bar'
 391 #
 392 # Additional options for diff.  This will get unset when using -s.
 393 #DIFF_OPTIONS='-Bb'     # Ignore changes in whitespace
 394 #
 395 # Location to store the list of mtree values for AUTO_UPGRADE purposes
 396 #MTREEDB='/var/db'
 397 #
 398 # For those who just cannot stand including the full path to PAGER
 399 #DONT_CHECK_PAGER=
 400 #
 401 # If you set 'yes' above, make sure to include the PATH to your pager
 402 #PATH=/bin:/usr/bin:/usr/sbin
 403 #
 404 # Delete stale files in /etc/rc.d without prompting
 405 #DELETE_STALE_RC_FILES=
 406 #
 407 # Specify the path to scripts to run before the comparison starts,
 408 # and/or after the script has finished its work
 409 #MM_PRE_COMPARE_SCRIPT=
 410 #MM_EXIT_SCRIPT=
 411 .Ed
 412 .Sh EXIT STATUS
 413 Exit status is 0 on successful completion, or if the user bails out
 414 manually at some point during execution.
 415 .Pp
 416 Exit status is 1 if it fails for one of the following reasons:
 417 .Pp
 418 Invalid command line option
 419 .Pp
 420 Failure to create the temporary root environment
 421 .Pp
 422 Failure to populate the temporary root
 423 .Pp
 424 Presence of the 'nodev' option in
 425 .Pa <DESTDIR>/etc/fstab
 426 .Pp
 427 Failure to install a file
 428 .Sh EXAMPLES
 429 Typically all you will need to do is type
 430 .Nm
 431 at the prompt and the script will do all the work for you.
 432 .Pp
 433 To use context diffs and have
 434 .Nm
 435 explain more things as it goes along, use:
 436 .Pp
 437 .Dl # mergemaster -cv
 438 .Pp
 439 To specify that
 440 .Nm
 441 put the temporary root environment in
 442 .Pa /usr/tmp/root ,
 443 use:
 444 .Pp
 445 .Dl # mergemaster -t /usr/tmp/root
 446 .Pp
 447 To specify a 110 column screen with a strict
 448 comparison, use:
 449 .Pp
 450 .Dl # mergemaster -sw 110
 451 .Sh SEE ALSO
 452 .Xr diff 1 ,
 453 .Xr make 1 ,
 454 .Xr more 1 ,
 455 .Xr sdiff 1 ,
 456 .Xr pwd_mkdb 8
 457 .Pp
 458 .Pa /usr/src/etc/Makefile
 459 .Rs
 460 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
 461 .%T The Cutting Edge (using make world)
 462 .%A Nik Clayton
 463 .Re
 464 .Sh HISTORY
 465 The
 466 .Nm
 467 utility was first publicly available on one of my
 468 web pages in a much simpler form under the name
 469 .Pa comproot
 470 on 13 March 1998.
 471 The idea for creating the
 472 temporary root environment comes from Nik Clayton's
 473 make world tutorial which is referenced above.
 474 .Sh AUTHORS
 475 This manual page and the script itself were written by
 476 .An Douglas Barton Aq dougb@FreeBSD.org .
 477 .Sh BUGS
 478 There are no known bugs.
 479 Please report any problems,
 480 comments or suggestions to the author.
 481 Several of the
 482 improvements to this program have come from user
 483 suggestions.
 484 Thank you.