usr.sbin/mergemaster/mergemaster.8

   1 .\" Copyright (c) 1998-2001 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 February 5, 2001
  28 .Dt MERGEMASTER 8
  29 .Os FreeBSD
  30 .Sh NAME
  31 .Nm mergemaster
  32 .Nd merge configuration files, et al during an upgrade
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl scrvahi
  36 .Op Fl m Ar /path/to/sources
  37 .Op Fl t Ar /path/to/temp/root
  38 .Op Fl d
  39 .Op Fl u Ar N
  40 .Op Fl w Ar N
  41 .Op Fl D Ar /path
  42 .Sh DESCRIPTION
  43 .Nm
  44 is a Bourne shell script which is designed to aid you
  45 in updating the various configuration and other files
  46 associated with
  47 .Fx .
  48 It is
  49 .Sy HIGHLY
  50 recommended that you back up your
  51 .Pa /etc
  52 directory before beginning this process.
  53 .Pp
  54 The script uses
  55 .Pa /usr/src/etc/Makefile
  56 to build a temporary root environment from
  57 .Pa /
  58 down, populating that environment with the various
  59 files.
  60 You can specify a different source directory
  61 with the
  62 .Op Fl m
  63 command line option, or specify the destination
  64 directory with the
  65 .Op Fl D
  66 option.
  67 It then compares each file in that environment
  68 to its installed counterpart.
  69 When the script finds a
  70 change in the new file, or there is no installed
  71 version of the new file it gives you four options to
  72 deal with it.
  73 You can install the new file as is,
  74 delete the new file, merge the old and new
  75 files (as appropriate) using
  76 .Xr sdiff 1
  77 or leave the file in the temporary root environment to
  78 merge by hand later.
  79 .Pp
  80 By default it creates the temporary root in
  81 .Pa /var/tmp/temproot
  82 and compares the
  83 .Xr cvs 1
  84 version $Id/$FreeBSD strings for files that have them, deleting
  85 the temporary file if the strings match.
  86 If there is
  87 no $Id string, or if the strings are different it
  88 compares the files themselves.
  89 You can
  90 also specify that the script ignore the $Id strings and
  91 compare every file.
  92 .Pp
  93 .Nm
  94 checks your umask and issues a warning for anything
  95 other than 022. While it is not mandatory to grant
  96 world read permissions for most configuration files, you
  97 may run into problems without them.
  98 If you choose a
  99 umask other than 022 and experience trouble later this
 100 could be the cause.
 101 .Pa /etc/master.passwd
 102 is treated as a special case.
 103 If you choose to install
 104 this file or a merged version of it the file permissions
 105 are always 600 (rw-------) for security reasons.
 106 After
 107 installing an updated version of this file you should
 108 probably run
 109 .Xr pwd_mkdb 8
 110 with the -p option to rebuild your password databases
 111 and recreate
 112 .Pa /etc/passwd .
 113 .Pp
 114 The script uses the owner and group id's
 115 that the files are created with by
 116 .Pa /usr/src/etc/Makefile ,
 117 and file permissions as specified by the umask.
 118 Unified diffs are used by default to display any
 119 differences unless you choose context diffs.
 120 .Pp
 121 .Nm
 122 will source scripts that you specify right before
 123 it starts the comparison, and after it's done running.
 124 The easiest way to handle this is to place the path
 125 to the script(s) in the appropriate variables in your
 126 .Pa .mergemasterrc
 127 file.
 128 The script sourced before comparison is named in
 129 .Ev MM_PRE_COMPARE_SCRIPT ,
 130 and the one sourced after the script is done is
 131 .Ev MM_EXIT_SCRIPT .
 132 This is the recommended way to specify local modifications,
 133 or files that you want to give special handling to.
 134 This includes files that you want to be deleted without
 135 being compared.
 136 Because the named scripts are sourced from within
 137 .Nm ,
 138 all of the script's variables are available for use in
 139 your custom script.
 140 You can also use
 141 .Pa /etc/mergemaster.rc
 142 which will be read before
 143 .Pa .mergemasterrc .
 144 Options specified on the command line are updated last,
 145 and therefore can override both files.
 146 .Pp
 147 The options are as follows:
 148 .Bl -tag -width Fl
 149 .It Fl s
 150 Perform a strict comparison, diff'ing every pair of files.
 151 .It Fl c
 152 Use context diffs instead of unified diffs.
 153 .It Fl r
 154 Re-run
 155 .Nm
 156 on a previously cleaned directory, skipping the creation of
 157 the temporary root environment.
 158 This option is compatible
 159 with all other options.
 160 .It Fl v
 161 Be more verbose about the process.
 162 You should probably use
 163 this option the first time you run
 164 .Nm .
 165 This option also gives you a list of files that exist
 166 only in the installed version of
 167 .Pa /etc .
 168 .It Fl a
 169 Run automatically.
 170 This option will leave all the files that
 171 differ from the installed versions in the temporary directory
 172 to be dealt with by hand.
 173 If the
 174 .Pa temproot
 175 directory exists, it creates a new one in a previously
 176 non-existent directory.
 177 This option unsets the verbose flag,
 178 but is compatible with all other options.
 179 Setting -a makes
 180 -w superfluous.
 181 .It Fl h
 182 Display usage and help information.
 183 .It Fl i
 184 Automatically install any files that do not exist in the
 185 destination directory.
 186 .It Fl m Ar /path/to/sources
 187 Specify the path to the directory where you want to do the
 188 .Xr make 1 .
 189 (In other words, where your sources are, but -s was already
 190 taken.)
 191 .It Fl t Ar /path/to/temp/root
 192 Create the temporary root environment in
 193 .Pa /path/to/temp/root
 194 instead of the default
 195 .Pa /var/tmp/temproot .
 196 .It Fl d
 197 Add the date and time to the name of the temporary
 198 root directory.
 199 If -t is specified, this option must
 200 follow it if you want the date added too.
 201 .It Fl u Ar N
 202 Specify a numeric umask.
 203 The default is 022.
 204 .It Fl w Ar N
 205 Supply an alternate screen width to the
 206 .Xr sdiff 1
 207 command in numbers of columns.
 208 The default is 80.
 209 .It Fl D Ar /path
 210 Specify the destination directory for the installed files.
 211 .El
 212 .Sh ENVIRONMENT
 213 The
 214 .Nm
 215 script uses the
 216 .Ev PAGER
 217 environment variable if set.
 218 Otherwise it uses
 219 .Xr more 1 .
 220 If
 221 .Ev PAGER
 222 specifies a program outside
 223 its
 224 limited
 225 .Ev PATH
 226 without specifying the full path,
 227 .Nm
 228 prompts you with options on how to proceed.
 229 The
 230 .Ev MM_PRE_COMPARE_SCRIPT
 231 and
 232 .Ev MM_EXIT_SCRIPT
 233 variables are used as described above.
 234 Other variables that are used by the script internally
 235 can be specified in
 236 .Pa .mergemasterrc
 237 as described in more detail below.
 238 .Sh EXAMPLES
 239 Typically all you will need to do is type
 240 .Nm
 241 at the prompt and the script will do all the work for you.
 242 .Pp
 243 To use context diff's and have
 244 .Nm
 245 explain more things as it goes along, use:
 246 .Pp
 247 .Dl # mergemaster -cv
 248 .Pp
 249 To specify that
 250 .Nm
 251 put the temporary root environment in
 252 .Pa /usr/tmp/root ,
 253 use:
 254 .Pp
 255 .Dl # mergemaster -t /usr/tmp/root
 256 .Pp
 257 To specify a 110 column screen with a strict
 258 comparison, use:
 259 .Pp
 260 .Dl # mergemaster -sw 110
 261 .Sh FILES
 262 .Bl -ohang
 263 .It Pa /etc/mergemaster.rc
 264 .It Pa $HOME/.mergemasterrc
 265 .Pp
 266 .Nm
 267 will . (source) these files if they exist.
 268 Command line options
 269 will override rc file options.
 270 .Pa $HOME/.mergemasterrc
 271 overrides
 272 .Pa /etc/mergemaster.rc .
 273 Here is an example
 274 with all values commented out:
 275 .Pp
 276 .Bd -literal
 277 # These are options for mergemaster, with their default values listed
 278 # The following options have command line overrides
 279 #
 280 # Directory to install the temporary root environment into
 281 #TEMPROOT='/var/tmp/temproot'
 282 #
 283 # Strict comparison bypasses the CVS $Id tests and compares every file
 284 #STRICT=no
 285 #
 286 # Flag(s) to use for diff displayed when files differ
 287 #DIFF_FLAG='-u'
 288 #
 289 # Verbose mode includes more details and additional checks
 290 #VERBOSE=
 291 #
 292 # Automatically install files that do not exist on the system already
 293 #AUTO_INSTALL=
 294 #
 295 # Sourcedir is the directory to do the 'make' in (where the new files are)
 296 #SOURCEDIR='/usr/src/etc'
 297 #
 298 # The umask for mergemaster to compare the default file's modes to
 299 #NEW_UMASK=022
 300 #
 301 # Specify the destination directory for the installed files
 302 #DESTDIR=
 303 #
 304 # The following options have no command line overrides
 305 # For those who just cannot stand including the full path to PAGER
 306 #DONT_CHECK_PAGER=
 307 #
 308 # If you set 'yes' above, make sure to include the PATH to your pager
 309 #PATH=/bin:/usr/bin:/usr/sbin
 310 #
 311 # Don't compare the old and new motd files
 312 #IGNORE_MOTD=yes
 313 #
 314 # Specify the path to scripts to run before the comparison starts,
 315 # and/or after the script has finished its work
 316 #MM_PRE_COMPARE_SCRIPT=
 317 #MM_EXIT_SCRIPT=
 318 .Ed
 319 .El
 320 .Sh SEE ALSO
 321 .Xr cvs 1 ,
 322 .Xr diff 1 ,
 323 .Xr make 1 ,
 324 .Xr more 1 ,
 325 .Xr sdiff 1 ,
 326 .Xr pwd_mkdb 8
 327 .Pp
 328 .Pa /usr/src/etc/Makefile
 329 .Pp
 330 http://www.FreeBSD.org/handbook/makeworld.html ,
 331 .Pa The Cutting Edge (using make world) ,
 332 by Nik Clayton
 333 .Sh DIAGNOSTICS
 334 Exit status is 0 on successful completion, or if the user bails out
 335 manually at some point during execution.
 336 .Pp
 337 Exit status is 1 if it fails for one of the following reasons:
 338 .Pp
 339 Invalid command line option
 340 .Pp
 341 Failure to create the temporary root environment
 342 .Pp
 343 Failure to populate the temporary root
 344 .Pp
 345 .Sh HISTORY
 346 The
 347 .Nm
 348 script was first publicly available on one of my
 349 web pages in a much simpler form under the name
 350 .Pa comproot
 351 on 13 March 1998. The idea for creating the
 352 temporary root environment comes from Nik Clayton's
 353 make world tutorial which is referenced above.
 354 .Pp
 355 .Sh AUTHORS
 356 This manual page and the script itself were written by
 357 .An Douglas Barton Aq DougB@FreeBSD.org .
 358 .Sh BUGS
 359 There are no known bugs.
 360 Please report any problems,
 361 comments or suggestions to the author.
 362 Several of the
 363 improvements to this program have come from user
 364 suggestions.
 365 Thank you.