2 .\" Copyright 2006 Colin Percival
3 .\" All rights reserved
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted providing that the following conditions
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.
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.
29 .Dt FREEBSD-UPDATE.CONF 5
32 .Nm freebsd-update.conf
33 .Nd configuration file for
38 file controls the behaviour of the
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
45 character are ignored.
46 Unless stated otherwise, specifying an option multiple times is an
49 The possible options and their meanings are as follows:
50 .Bl -tag -width "BackupKernelSymbolFiles"
52 The single parameter following this keyword must be
58 is allowed to create new files, directories, and symlinks if
59 these are part of updates downloaded.
62 will not re-add files which have been deleted from a
64 installation unless those files were previously added as part
67 The single parameter following this keyword must be
73 is allowed to delete files, directories, and symlinks as
74 part of updates downloaded.
76 The single parameter following this keyword must be
82 will create a backup of the old kernel before installing a new kernel.
83 This backup kernel can be used to recover a system where the newly
84 installed kernel somehow did not work.
85 Note that the backup kernel is not reverted to its original state by
89 .It Cm BackupKernelDir
90 This keyword sets the directory which is used to store a backup
91 kernel, if the BackupKernel feature is enabled.
92 If the directory already exist, and it was not created by
93 .Xr freebsd-update 8 ,
94 the directory is skipped.
95 In the case of the primary directory name not being usable, a number
98 is appended to the directory name.
99 Like with the primary directory name, the constructed directory name is
100 only used if the path name does not exist, or if the directory was
101 previously created by
102 .Xr freebsd-update 8 .
103 If the constructed directory still exist the appended number is
104 incremented with 1 and the directory search process restarted.
105 Should the number increment go above 9,
108 .It Cm BackupKernelSymbolFiles
109 The single parameter following this keyword must be
113 and specifies whether
115 will also backup kernel symbol files, if they exist.
116 The kernel symbol files takes up a lot of disk space and are not
117 needed for recovery purposes.
118 If the symbol files are needed, after recovering a system using the
121 rollback command will recreate the symbol files along with the old
124 The parameters following this keyword are the components or
127 which will be updated.
132 (non-kernel binaries), and
134 the sub-components are the individual distribution sets generated as
135 part of the release process (e.g.,
145 component was distributed as part of
148 This option can be specified multiple times, and the parameters
151 The single parameter following this keyword must be
155 and specifies whether
157 will create a new boot environment using
159 when installing patches.
161 The name of the new boot environment consists of the current
164 .Bd -literal -offset indent
165 freebsd-version -ku | sort -V | tail -n 1
169 .Bd -literal -offset indent
170 date +"%Y-%m-%d_%H%M%S"
173 separated by a single dash, e.g.:
174 .Bd -literal -offset indent
175 13.0-RELEASE-p7_2022-02-16_141502
179 does not attempt to create a boot environment
180 if any of the following applies:
186 The ZFS root is not set up for boot environments
187 .Po see the check command of
197 is updating a root directory selected via
204 .It Cm IDSIgnorePaths
205 The parameters following this keyword are regular expressions;
206 paths which start with a string matching one of these regular
207 expressions will be ignored by
211 This option can be specified multiple times, and the parameters
214 The parameters following this keyword are regular expressions;
215 updates to paths which start with a string matching one of
216 these regular expressions will be ignored.
218 This option can be specified multiple times, and the parameters
220 .It Cm KeepModifiedMetadata
221 The single parameter following this keyword must be
225 and specifies whether
227 should keep existing file ownership, permissions, and flags
228 when installing updates if these have been modified locally.
230 The single parameter following this keyword is the SHA256 hash
231 of the RSA key which will be trusted to sign updates.
233 The single parameter following this keyword is the address
236 output will be mailed.
238 The parameters following this keyword are regular expressions;
239 updates to paths which start with a string matching one of
240 these regular expressions will be merged with local modifications.
242 This option can be specified multiple times, and the parameters
245 The single parameter following this keyword is the name of the
246 server or server pool from which updates will be downloaded.
247 .It Cm StrictComponents
248 The single parameter following this keyword must be
252 and specifies whether
254 should interpret the list of components of
258 option strictly as a list of components installed which
259 should be upgraded when the
261 command is used ("yes"), or merely as a list of components
262 which might be installed, of which
264 should identify which in fact are present ("no").
265 .It Cm UpdateIfUnmodified
266 The parameters following this keyword are regular expressions;
267 updates to paths which start with a string matching one of
268 these regular expressions will be ignored if the files have
269 been modified locally (unless they are merged \(em see the
273 This option can be specified multiple times, and the parameters
276 The single parameter following this keyword is the directory
277 in which temporary files and downloaded updates will be stored.
280 .Bl -tag -width "/etc/freebsd-update.conf"
281 .It Pa /etc/freebsd-update.conf
282 Default location of the
291 .An Colin Percival Aq Mt cperciva@FreeBSD.org