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 30, 2006 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 36The 37.Nm 38file controls the behaviour of the 39.Xr freebsd-update 8 40utility. 41The file contains lines consisting of a case-sensitive option name and 42zero or more parameters. 43Empty lines and any part of a line following a 44.Ql # 45character are ignored. 46Unless stated otherwise, specifying an option multiple times is an 47error. 48.Pp 49The possible options and their meanings are as follows: 50.Pp 51.Bl -tag -width "KeepModifiedMetadata" 52.It Cm KeyPrint 53The single parameter following this keyword is the SHA256 hash 54of the RSA key which will be trusted to sign updates. 55.It Cm ServerName 56The single parameter following this keyword is the name of the 57server or server pool from which updates will be downloaded. 58.It Cm Components 59The parameters following this keyword are the components or 60sub-components of 61.Fx 62which will be updated. 63The components are 64.Dq src 65(source code), 66.Dq world 67(non-kernel binaries), and 68.Dq kernel ; 69the sub-components are the individual distribution sets generated as 70part 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 ) . 76Note that prior to 77.Fx 6.1 , 78the 79.Dq kernel 80component was distributed as part of 81.Dq world/base . 82.Pp 83This option can be specified multiple times, and the parameters 84accumulate. 85.It Cm IgnorePaths 86The parameters following this keyword are regular expressions; 87updates to paths which start with a string matching one of 88these regular expressions will be ignored. 89.Pp 90This option can be specified multiple times, and the parameters 91accumulate. 92.It Cm UpdateIfUnmodified 93The parameters following this keyword are regular expressions; 94updates to paths which start with a string matching one of 95these regular expressions will be ignored if the files have 96been modified locally (unless they are merged -- see MergeChanges 97below). 98.Pp 99This option can be specified multiple times, and the parameters 100accumulate. 101.It Cm MergeChanges 102The parameters following this keyword are regular expressions; 103updates to paths which start with a string matching one of 104these regular expressions will be merged with local modifications. 105.Pp 106This option can be specified multiple times, and the parameters 107accumulate. 108.It Cm WorkDir 109The single parameter following this keyword is the directory 110in which temporary files and downloaded updates will be stored. 111.It Cm MailTo 112The single parameter following this keyword is the address 113to which 114.Cm cron 115output will be mailed. 116.It Cm AllowAdd 117The single parameter following this keyword must be 118.Dq yes 119or 120.Dq no 121and specifies whether 122.Cm freebsd-update 123is allowed to create new files, directories, and symlinks if 124these are part of updates downloaded. 125Note that 126.Cm freebsd-update 127will not re-add files which have been deleted from a 128.Fx 129installation unless those files were previously added as part 130of an update. 131.It Cm AllowDelete 132The single parameter following this keyword must be 133.Dq yes 134or 135.Dq no 136and specifies whether 137.Cm freebsd-update 138is allowed to delete files, directories, and symlinks as 139part of updates downloaded. 140.It Cm KeepModifiedMetadata 141The single parameter following this keyword must be 142.Dq yes 143or 144.Dq no 145and specifies whether 146.Cm freebsd-update 147should keep existing file ownership, permissions, and flags 148when installing updates if these have been modified locally. 149.It Cm StrictComponents 150The single parameter following this keyword must be 151.Dq yes 152or 153.Dq no 154and specifies whether 155.Cm freebsd-update 156should interpret the list of components of 157.Fx 158specified via the 159.Cm Components 160option strictly as a list of components installed which 161should be upgraded when the 162.Cm upgrade 163command is used ("yes"), or merely as a list of components 164which might be installed, of which 165.Cm freebsd-update 166should identify which in fact are present ("no"). 167.El 168.Sh FILES 169.Bl -tag -width "/etc/freebsd-update.conf" 170.It /etc/freebsd-update.conf 171Default location of the 172.Cm freebsd-update 173configuration file. 174.El 175.Sh SEE ALSO 176.Xr sha256 1 , 177.Xr freebsd-update 8 178.Sh AUTHORS 179.An Colin Percival Aq cperciva@FreeBSD.org 180