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. 97.Pp 98This option can be specified multiple times, and the parameters 99accumulate. 100.It Cm WorkDir 101The single parameter following this keyword is the directory 102in which temporary files and downloaded updates will be stored. 103.It Cm MailTo 104The single parameter following this keyword is the address 105to which 106.Cm cron 107output will be mailed. 108.It Cm AllowAdd 109The single parameter following this keyword must be 110.Dq yes 111or 112.Dq no 113and specifies whether 114.Cm freebsd-update 115is allowed to create new files, directories, and symlinks if 116these are part of updates downloaded. 117Note that 118.Cm freebsd-update 119will not re-add files which have been deleted from a 120.Fx 121installation unless those files were previously added as part 122of an update. 123.It Cm AllowDelete 124The single parameter following this keyword must be 125.Dq yes 126or 127.Dq no 128and specifies whether 129.Cm freebsd-update 130is allowed to delete files, directories, and symlinks as 131part of updates downloaded. 132.It Cm KeepModifiedMetadata 133The single parameter following this keyword must be 134.Dq yes 135or 136.Dq no 137and specifies whether 138.Cm freebsd-update 139should keep existing file ownership, permissions, and flags 140when installing updates if these have been modified locally. 141.El 142.Sh FILES 143.Bl -tag -width "/etc/freebsd-update.conf" 144.It /etc/freebsd-update.conf 145Default location of the 146.Cm freebsd-update 147configuration file. 148.El 149.Sh SEE ALSO 150.Xr sha256 1 , 151.Xr freebsd-update 8 152.Sh AUTHORS 153.An Colin Percival Aq cperciva@FreeBSD.org 154