usr.sbin/mergemaster/mergemaster.8

   1 .\" Copyright (c) 1998-2000 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 October 30, 2000
  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 .Pp
 141 The options are as follows:
 142 .Bl -tag -width Fl
 143 .It Fl s
 144 Perform a strict comparison, diff'ing every pair of files.
 145 .It Fl c
 146 Use context diffs instead of unified diffs.
 147 .It Fl r
 148 Re-run
 149 .Nm
 150 on a previously cleaned directory, skipping the creation of
 151 the temporary root environment.
 152 This option is compatible
 153 with all other options.
 154 .It Fl v
 155 Be more verbose about the process.
 156 You should probably use
 157 this option the first time you run
 158 .Nm .
 159 This option also gives you a list of files that exist
 160 only in the installed version of
 161 .Pa /etc .
 162 .It Fl a
 163 Run automatically.
 164 This option will leave all the files that
 165 differ from the installed versions in the temporary directory
 166 to be dealt with by hand.
 167 If the
 168 .Pa temproot
 169 directory exists, it creates a new one in a previously
 170 non-existent directory.
 171 This option unsets the verbose flag,
 172 but is compatible with all other options.
 173 Setting -a makes
 174 -w superfluous.
 175 .It Fl h
 176 Display usage and help information.
 177 .It Fl i
 178 Automatically install any files that do not exist in the
 179 destination directory.
 180 .It Fl m Ar /path/to/sources
 181 Specify the path to the directory where you want to do the
 182 .Xr make 1 .
 183 (In other words, where your sources are, but -s was already
 184 taken.)
 185 .It Fl t Ar /path/to/temp/root
 186 Create the temporary root environment in
 187 .Pa /path/to/temp/root
 188 instead of the default
 189 .Pa /var/tmp/temproot .
 190 .It Fl d
 191 Add the date and time to the name of the temporary
 192 root directory.
 193 If -t is specified, this option must
 194 follow it if you want the date added too.
 195 .It Fl u Ar N
 196 Specify a numeric umask.
 197 The default is 022.
 198 .It Fl w Ar N
 199 Supply an alternate screen width to the
 200 .Xr sdiff 1
 201 command in numbers of columns.
 202 The default is 80.
 203 .It Fl D Ar /path
 204 Specify the destination directory for the installed files.
 205 .El
 206 .Sh ENVIRONMENT
 207 The
 208 .Nm
 209 script uses the
 210 .Ev PAGER
 211 environment variable if set.
 212 Otherwise it uses
 213 .Xr more 1 .
 214 If
 215 .Ev PAGER
 216 specifies a program outside
 217 its
 218 limited
 219 .Ev PATH
 220 without specifying the full path,
 221 .Nm
 222 prompts you with options on how to proceed.
 223 The
 224 .Ev MM_PRE_COMPARE_SCRIPT
 225 and
 226 .Ev MM_EXIT_SCRIPT
 227 variables are used as described above.
 228 Other variables that are used by the script internally
 229 can be specified in
 230 .Pa .mergemasterrc
 231 as described in more detail below.
 232 .Sh EXAMPLES
 233 Typically all you will need to do is type
 234 .Nm
 235 at the prompt and the script will do all the work for you.
 236 .Pp
 237 To use context diff's and have
 238 .Nm
 239 explain more things as it goes along, use:
 240 .Pp
 241 .Dl # mergemaster -cv
 242 .Pp
 243 To specify that
 244 .Nm
 245 put the temporary root environment in
 246 .Pa /usr/tmp/root ,
 247 use:
 248 .Pp
 249 .Dl # mergemaster -t /usr/tmp/root
 250 .Pp
 251 To specify a 110 column screen with a strict
 252 comparison, use:
 253 .Pp
 254 .Dl # mergemaster -sw 110
 255 .Sh FILES
 256 .Bl -ohang
 257 .It Pa $HOME/.mergemasterrc
 258 .Nm
 259 will . (source) this file if it exists.
 260 Command line options
 261 will override rc file options.
 262 Here is an example
 263 with all values commented out:
 264 .Pp
 265 .Bd -literal
 266 # These are options for mergemaster, with their default values listed
 267 # The following options have command line overrides
 268 #
 269 # Directory to install the temporary root environment into
 270 #TEMPROOT='/var/tmp/temproot'
 271 #
 272 # Strict comparison bypasses the CVS $Id tests and compares every file
 273 #STRICT=no
 274 #
 275 # Flag(s) to use for diff displayed when files differ
 276 #DIFF_FLAG='-u'
 277 #
 278 # Verbose mode includes more details and additional checks
 279 #VERBOSE=
 280 #
 281 # Automatically install files that do not exist on the system already
 282 #AUTO_INSTALL=
 283 #
 284 # Sourcedir is the directory to do the 'make' in (where the new files are)
 285 #SOURCEDIR='/usr/src/etc'
 286 #
 287 # The umask for mergemaster to compare the default file's modes to
 288 #NEW_UMASK=022
 289 #
 290 # Specify the destination directory for the installed files
 291 #DESTDIR=
 292 #
 293 # The following options have no command line overrides
 294 # For those who just cannot stand including the full path to PAGER
 295 #DONT_CHECK_PAGER=
 296 #
 297 # If you set 'yes' above, make sure to include the PATH to your pager
 298 #PATH=/bin:/usr/bin:/usr/sbin
 299 #
 300 # Don't compare the old and new motd files
 301 #IGNORE_MOTD=yes
 302 #
 303 # Specify the path to scripts to run before the comparison starts,
 304 # and/or after the script has finished its work
 305 #MM_PRE_COMPARE_SCRIPT=
 306 #MM_EXIT_SCRIPT=
 307 .Ed
 308 .El
 309 .Sh SEE ALSO
 310 .Xr cvs 1 ,
 311 .Xr diff 1 ,
 312 .Xr make 1 ,
 313 .Xr more 1 ,
 314 .Xr sdiff 1 ,
 315 .Xr pwd_mkdb 8
 316 .Pp
 317 .Pa /usr/src/etc/Makefile
 318 .Pp
 319 http://www.FreeBSD.org/handbook/makeworld.html ,
 320 .Pa The Cutting Edge (using make world) ,
 321 by Nik Clayton
 322 .Sh DIAGNOSTICS
 323 Exit status is 0 on successful completion, or if the user bails out
 324 manually at some point during execution.
 325 .Pp
 326 Exit status is 1 if it fails for one of the following reasons:
 327 .Pp
 328 Invalid command line option
 329 .Pp
 330 Failure to create the temporary root environment
 331 .Pp
 332 Failure to populate the temporary root
 333 .Pp
 334 .Sh HISTORY
 335 The
 336 .Nm
 337 script was first publicly available on one of my
 338 web pages in a much simpler form under the name
 339 .Pa comproot
 340 on 13 March 1998. The idea for creating the
 341 temporary root environment comes from Nik Clayton's
 342 make world tutorial which is referenced above.
 343 .Pp
 344 .Sh AUTHORS
 345 This manual page and the script itself were written by
 346 .An Douglas Barton Aq DougB@FreeBSD.org .
 347 .Sh BUGS
 348 There are no known bugs.
 349 Please report any problems,
 350 comments or suggestions to the author.
 351 Several of the
 352 improvements to this program have come from user
 353 suggestions.
 354 Thank you.