usr.sbin/postinstall/postinstall.8

   1 .\"     $NetBSD: postinstall.8,v 1.14 2009/10/15 02:15:19 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2005-2008 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Thomas Klausner.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd October 4, 2008
  31 .Dt POSTINSTALL 8
  32 .Os
  33 .Sh NAME
  34 .Nm postinstall
  35 .Nd check and fix installation after system upgrades
  36 .Sh SYNOPSIS
  37 .Nm postinstall
  38 .Op Fl a Ar arch
  39 .Op Fl d Ar destdir
  40 .Op Fl m Ar machine
  41 .Op Fl s Brq Ar srcdir | Ar tgzdir | Ar tgzfile
  42 .Ar operation
  43 .Op Ar item Op ...
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility performs post-installation checks and/or fixes on a system's
  48 configuration files.
  49 It is especially useful after system upgrades, e.g. after updating
  50 from
  51 .Nx 1.6.2
  52 to
  53 .Nx 2.0 .
  54 The items to check or fix are divided in two groups: enabled by
  55 default and disabled by default.
  56 The latter are items that are dangerous for some reason, for example
  57 because they remove files which may be still in use.
  58 If no
  59 .Ar items
  60 are provided, the default checks or fixes are applied.
  61 Those which are disabled by default must be provided explicitly.
  62 .Pp
  63 Supported options:
  64 .Bl -tag -width XsXsrcdirXXX -offset indent
  65 .It Fl a Ar arch
  66 MACHINE_ARCH.
  67 Defaults to machine of the host operating system.
  68 .It Fl d Ar destdir
  69 Destination directory to check.
  70 Defaults to
  71 .Pa / .
  72 .It Fl m Ar machine
  73 MACHINE.
  74 Defaults to machine of the host operating system.
  75 .It Fl s Brq Ar srcdir | Ar tgzdir | Ar tgzfile
  76 The location of the reference files, or the
  77 .Nx
  78 source files used to create the reference files.
  79 This may be specified in one of three ways:
  80 .Bl -tag -width XXsXtgzfileXX
  81 .It Fl s Ar srcdir
  82 The top level directory of the
  83 .Nx
  84 source tree.
  85 By default this is
  86 .Pa /usr/src .
  87 .It Fl s Ar tgzdir
  88 A directory in which reference files have been
  89 extracted from a binary distribution of
  90 .Nx .
  91 The files that are distributed in the
  92 .Dq Pa etc.tgz
  93 set file must be present.
  94 The files that are distributed in the
  95 .Dq Pa xetc.tgz
  96 set file are optional.
  97 .It Fl s Ar tgzfile
  98 The location of a set file
  99 (or
 100 .Dq "tgz file" )
 101 such as
 102 .Dq Pa etc.tgz
 103 or
 104 .Dq Pa xetc.tgz
 105 from a binary distribution of
 106 .Nx .
 107 Each set file is a compressed archive containing reference files,
 108 which will be extracted to the
 109 .Pa temproot
 110 directory.
 111 Multiple
 112 .Fl s
 113 options may be used to specify multiple set files.
 114 The
 115 .Dq Pa etc.tgz
 116 set file must be specified.
 117 The
 118 .Dq Pa xetc.tgz
 119 set file is optional.
 120 .El
 121 .El
 122 .Pp
 123 The
 124 .Ar operation
 125 argument may be one of:
 126 .Bl -tag -width usageXX -offset indent
 127 .It Cm check
 128 Perform post-installation checks on items.
 129 .It Cm diff Op Xr diff 1 Li options
 130 Similar to
 131 .Cm check ,
 132 but also show the differences between the files.
 133 .It Cm fix
 134 Apply fixes that
 135 .Cm check
 136 determines need to be applied.
 137 Not all items can be automatically fixed by
 138 .Nm ,
 139 and in some cases an error will be reported,
 140 after which manual intervention will be required.
 141 .Pp
 142 Conflicts between existing files in the target file system
 143 and new files from the
 144 .Nx
 145 distribution are resolved by replacing the existing file
 146 with the new file; there is no attempt to merge the files.
 147 See
 148 .Xr etcupdate 8
 149 for an alternative update method that is able to merge files.
 150 .It Cm help
 151 Display a short help.
 152 .It Cm list
 153 List available
 154 .Ar items ,
 155 showing if they are enabled or disabled by default.
 156 .It Cm usage
 157 Same as
 158 .Cm help .
 159 .El
 160 .Sh EXIT STATUS
 161 The
 162 .Nm
 163 utility exits 0 on success, and \*[Gt]0 if an error occurs
 164 or a problem was found.
 165 .Sh SEE ALSO
 166 .Xr etcupdate 8
 167 .Sh HISTORY
 168 The
 169 .Nm
 170 utility first appeared in
 171 .Nx 1.6 .
 172 .Pp
 173 In
 174 .Nx 4.0 ,
 175 the
 176 .Fl s Ar tgzfile
 177 option was added.
 178 .Pp
 179 In
 180 .Nx 5.0 ,
 181 the ability to specify multiple colon-separated files with a single
 182 .Fl s
 183 option was deprecated.