share/man/man5/freebsd-update.conf.5

   1 .\"-
   2 .\" Copyright 2006 Colin Percival
   3 .\" All rights reserved
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted providing that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  18 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  22 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  23 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd August 19, 2009
  29 .Dt FREEBSD-UPDATE.CONF 5
  30 .Os FreeBSD
  31 .Sh NAME
  32 .Nm freebsd-update.conf
  33 .Nd configuration file for
  34 .Xr freebsd-update 8
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 file controls the behaviour of the
  39 .Xr freebsd-update 8
  40 utility.
  41 The file contains lines consisting of a case-sensitive option name and
  42 zero or more parameters.
  43 Empty lines and any part of a line following a
  44 .Ql #
  45 character are ignored.
  46 Unless stated otherwise, specifying an option multiple times is an
  47 error.
  48 .Pp
  49 The possible options and their meanings are as follows:
  50 .Pp
  51 .Bl -tag -width ".Cm BackupKernelSymbolFiles"
  52 .It Cm KeyPrint
  53 The single parameter following this keyword is the SHA256 hash
  54 of the RSA key which will be trusted to sign updates.
  55 .It Cm ServerName
  56 The single parameter following this keyword is the name of the
  57 server or server pool from which updates will be downloaded.
  58 .It Cm Components
  59 The parameters following this keyword are the components or
  60 sub-components of
  61 .Fx
  62 which will be updated.
  63 The components are
  64 .Dq src
  65 (source code),
  66 .Dq world
  67 (non-kernel binaries), and
  68 .Dq kernel ;
  69 the sub-components are the individual distribution sets generated as
  70 part of the release process (e.g.,
  71 .Dq src/base ,
  72 .Dq src/sys ,
  73 .Dq world/base ,
  74 .Dq world/catpages ,
  75 .Dq kernel/smp ) .
  76 Note that prior to
  77 .Fx 6.1 ,
  78 the
  79 .Dq kernel
  80 component was distributed as part of
  81 .Dq world/base .
  82 .Pp
  83 This option can be specified multiple times, and the parameters
  84 accumulate.
  85 .It Cm IgnorePaths
  86 The parameters following this keyword are regular expressions;
  87 updates to paths which start with a string matching one of
  88 these regular expressions will be ignored.
  89 .Pp
  90 This option can be specified multiple times, and the parameters
  91 accumulate.
  92 .It Cm IDSIgnorePaths
  93 The parameters following this keyword are regular expressions;
  94 paths which start with a string matching one of these regular
  95 expressions will be ignored by "freebsd-update IDS".
  96 .Pp
  97 This option can be specified multiple times, and the parameters
  98 accumulate.
  99 .It Cm UpdateIfUnmodified
 100 The parameters following this keyword are regular expressions;
 101 updates to paths which start with a string matching one of
 102 these regular expressions will be ignored if the files have
 103 been modified locally (unless they are merged -- see MergeChanges
 104 below).
 105 .Pp
 106 This option can be specified multiple times, and the parameters
 107 accumulate.
 108 .It Cm MergeChanges
 109 The parameters following this keyword are regular expressions;
 110 updates to paths which start with a string matching one of
 111 these regular expressions will be merged with local modifications.
 112 .Pp
 113 This option can be specified multiple times, and the parameters
 114 accumulate.
 115 .It Cm WorkDir
 116 The single parameter following this keyword is the directory
 117 in which temporary files and downloaded updates will be stored.
 118 .It Cm MailTo
 119 The single parameter following this keyword is the address
 120 to which
 121 .Cm cron
 122 output will be mailed.
 123 .It Cm AllowAdd
 124 The single parameter following this keyword must be
 125 .Dq yes
 126 or
 127 .Dq no
 128 and specifies whether
 129 .Cm freebsd-update
 130 is allowed to create new files, directories, and symlinks if
 131 these are part of updates downloaded.
 132 Note that
 133 .Cm freebsd-update
 134 will not re-add files which have been deleted from a
 135 .Fx
 136 installation unless those files were previously added as part
 137 of an update.
 138 .It Cm AllowDelete
 139 The single parameter following this keyword must be
 140 .Dq yes
 141 or
 142 .Dq no
 143 and specifies whether
 144 .Cm freebsd-update
 145 is allowed to delete files, directories, and symlinks as
 146 part of updates downloaded.
 147 .It Cm KeepModifiedMetadata
 148 The single parameter following this keyword must be
 149 .Dq yes
 150 or
 151 .Dq no
 152 and specifies whether
 153 .Cm freebsd-update
 154 should keep existing file ownership, permissions, and flags
 155 when installing updates if these have been modified locally.
 156 .It Cm StrictComponents
 157 The single parameter following this keyword must be
 158 .Dq yes
 159 or
 160 .Dq no
 161 and specifies whether
 162 .Cm freebsd-update
 163 should interpret the list of components of
 164 .Fx
 165 specified via the
 166 .Cm Components
 167 option strictly as a list of components installed which
 168 should be upgraded when the
 169 .Cm upgrade
 170 command is used ("yes"), or merely as a list of components
 171 which might be installed, of which
 172 .Cm freebsd-update
 173 should identify which in fact are present ("no").
 174 .It Cm BackupKernel
 175 The single parameter following this keyword must be
 176 .Dq yes
 177 or
 178 .Dq no
 179 and specifies whether
 180 .Cm freebsd-update
 181 will create a backup of the old kernel before installing a new kernel.
 182 This backup kernel can be used to recover a system where the newly
 183 installed kernel somehow did not work.
 184 Note that the backup kernel is not reverted to its original state by
 185 the
 186 .Cm freebsd-update
 187 rollback command.
 188 .It Cm BackupKernelDir
 189 This keyword sets the directory which is used to store a backup
 190 kernel, if the BackupKernel feature is enabled.
 191 If the directory already exist, and it was not created by
 192 .Cm freebsd-update ,
 193 the directory is skipped.
 194 In the case of the primary directory name not being usable, a number
 195 starting with
 196 .Sq 1
 197 is appended to the directory name.
 198 Like with the primary directory name, the constructed directory name is
 199 only used if the path name does not exist, or if the directory was
 200 previously created by
 201 .Cm freebsd-update .
 202 If the constructed directory still exist the appended number is
 203 incremented with 1 and the directory search process restarted.
 204 Should the number increment go above 9,
 205 .Cm freebsd-update
 206 will abort.
 207 .It Cm BackupKernelSymbolFiles
 208 The single parameter following this keyword must be
 209 .Dq yes
 210 or
 211 .Dq no
 212 and specifies whether
 213 .Cm freebsd-update
 214 will also backup kernel symbol files, if they exist.
 215 The kernel symbol files takes up a lot of disk space and are not
 216 needed for recovery purposes.
 217 If the symbol files are needed, after recovering a system using the
 218 backup kernel, the
 219 .Cm freebsd-update
 220 rollback command will recreate the symbol files along with the old
 221 kernel.
 222 .El
 223 .Sh FILES
 224 .Bl -tag -width "/etc/freebsd-update.conf"
 225 .It /etc/freebsd-update.conf
 226 Default location of the
 227 .Cm freebsd-update
 228 configuration file.
 229 .El
 230 .Sh SEE ALSO
 231 .Xr sha256 1 ,
 232 .Xr freebsd-update 8
 233 .Sh AUTHORS
 234 .An Colin Percival Aq cperciva@FreeBSD.org