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 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
  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 "KeepModifiedMetadata"
  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.  The components are
  63 .Dq src
  64 (source code),
  65 .Dq world
  66 (non-kernel binaries), and
  67 .Dq kernel ;
  68 the sub-components are the individual distribution sets generated as
  69 part of the release process (e.g.,
  70 .Dq src/base ,
  71 .Dq src/sys ,
  72 .Dq world/base ,
  73 .Dq world/catpages ,
  74 .Dq kernel/smp ) .
  75 Note that prior to
  76 .Fx 6.1 ,
  77 the
  78 .Dq kernel
  79 component was distributed as part of
  80 .Dq world/base .
  81 .Pp
  82 This option can be specified multiple times, and the parameters
  83 accumulate.
  84 .It Cm IgnorePaths
  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.
  88 .Pp
  89 This option can be specified multiple times, and the parameters
  90 accumulate.
  91 .It Cm UpdateIfUnmodified
  92 The parameters following this keyword are regular expressions;
  93 updates to paths which start with a string matching one of
  94 these regular expressions will be ignored if the files have
  95 been modified locally.
  96 .Pp
  97 This option can be specified multiple times, and the parameters
  98 accumulate.
  99 .It Cm WorkDir
 100 The single parameter following this keyword is the directory
 101 in which temporary files and downloaded updates will be stored.
 102 .It Cm MailTo
 103 The single parameter following this keyword is the address
 104 to which
 105 .Cm cron
 106 output will be mailed.
 107 .It Cm AllowAdd
 108 The single parameter following this keyword must be
 109 .Dq yes
 110 or
 111 .Dq no
 112 and specifies whether
 113 .Cm freebsd-update
 114 is allowed to create new files, directories, and symlinks if
 115 these are part of updates downloaded.  Note that
 116 .Cm freebsd-update
 117 will not re-add files which have been deleted from a
 118 .Fx
 119 installation unless those files were previously added as part
 120 of an update.
 121 .It Cm AllowDelete
 122 The single parameter following this keyword must be
 123 .Dq yes
 124 or
 125 .Dq no
 126 and specifies whether
 127 .Cm freebsd-update
 128 is allowed to delete files, directories, and symlinks as
 129 part of updates downloaded.
 130 .It Cm KeepModifiedMetadata
 131 The single parameter following this keyword must be
 132 .Dq yes
 133 or
 134 .Dq no
 135 and specifies whether
 136 .Cm freebsd-update
 137 should keep existing file ownership, permissions, and flags
 138 when installing updates if these have been modified locally.
 139 .El
 140 .Sh FILES
 141 .Bl -tag -width "/etc/freebsd-update.conf"
 142 .It /etc/freebsd-update.conf
 143 Default location of the
 144 .Cm freebsd-update
 145 configuration file.
 146 .El
 147 .Sh SEE ALSO
 148 .Xr freebsd-update 8
 149 .Xr sha256 8
 150 .Sh AUTHORS
 151 .An Colin Percival Aq cperciva@FreeBSD.org