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 ".Cm BackupKernelSymbolFiles"
52 The single parameter following this keyword is the SHA256 hash
53 of the RSA key which will be trusted to sign updates.
55 The single parameter following this keyword is the name of the
56 server or server pool from which updates will be downloaded.
58 The parameters following this keyword are the components or
61 which will be updated.
66 (non-kernel binaries), and
68 the sub-components are the individual distribution sets generated as
69 part of the release process (e.g.,
79 component was distributed as part of
82 This option can be specified multiple times, and the parameters
85 The parameters following this keyword are regular expressions;
86 updates to paths which start with a string matching one of
87 these regular expressions will be ignored.
89 This option can be specified multiple times, and the parameters
92 The parameters following this keyword are regular expressions;
93 paths which start with a string matching one of these regular
94 expressions will be ignored by "freebsd-update IDS".
96 This option can be specified multiple times, and the parameters
98 .It Cm UpdateIfUnmodified
99 The parameters following this keyword are regular expressions;
100 updates to paths which start with a string matching one of
101 these regular expressions will be ignored if the files have
102 been modified locally (unless they are merged -- see MergeChanges
105 This option can be specified multiple times, and the parameters
108 The parameters following this keyword are regular expressions;
109 updates to paths which start with a string matching one of
110 these regular expressions will be merged with local modifications.
112 This option can be specified multiple times, and the parameters
115 The single parameter following this keyword is the directory
116 in which temporary files and downloaded updates will be stored.
118 The single parameter following this keyword is the address
121 output will be mailed.
123 The single parameter following this keyword must be
127 and specifies whether
129 is allowed to create new files, directories, and symlinks if
130 these are part of updates downloaded.
133 will not re-add files which have been deleted from a
135 installation unless those files were previously added as part
138 The single parameter following this keyword must be
142 and specifies whether
144 is allowed to delete files, directories, and symlinks as
145 part of updates downloaded.
146 .It Cm KeepModifiedMetadata
147 The single parameter following this keyword must be
151 and specifies whether
153 should keep existing file ownership, permissions, and flags
154 when installing updates if these have been modified locally.
155 .It Cm StrictComponents
156 The single parameter following this keyword must be
160 and specifies whether
162 should interpret the list of components of
166 option strictly as a list of components installed which
167 should be upgraded when the
169 command is used ("yes"), or merely as a list of components
170 which might be installed, of which
172 should identify which in fact are present ("no").
174 The single parameter following this keyword must be
178 and specifies whether
180 will create a backup of the old kernel before installing a new kernel.
181 This backup kernel can be used to recover a system where the newly
182 installed kernel somehow did not work.
183 Note that the backup kernel is not reverted to its original state by
187 .It Cm BackupKernelDir
188 This keyword sets the directory which is used to store a backup
189 kernel, if the BackupKernel feature is enabled.
190 If the directory already exist, and it was not created by
192 the directory is skipped.
193 In the case of the primary directory name not being usable, a number
196 is appended to the directory name.
197 Like with the primary directory name, the constructed directory name is
198 only used if the path name does not exist, or if the directory was
199 previously created by
201 If the constructed directory still exist the appended number is
202 incremented with 1 and the directory search process restarted.
203 Should the number increment go above 9,
206 .It Cm BackupKernelSymbolFiles
207 The single parameter following this keyword must be
211 and specifies whether
213 will also backup kernel symbol files, if they exist.
214 The kernel symbol files takes up a lot of disk space and are not
215 needed for recovery purposes.
216 If the symbol files are needed, after recovering a system using the
219 rollback command will recreate the symbol files along with the old
223 .Bl -tag -width "/etc/freebsd-update.conf"
224 .It Pa /etc/freebsd-update.conf
225 Default location of the
233 .An Colin Percival Aq cperciva@FreeBSD.org