2 .\" Copyright 2006, 2007 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.
33 .Nd fetch and install binary updates to FreeBSD
41 .Op Fl r Ar newrelease
44 .Op Fl -not-running-from-cron
49 tool is used to fetch, install, and rollback binary
53 Note that updates are only available if they are being built for the
55 release and architecture being used; in particular, the
57 Security Team only builds updates for releases shipped in binary form
60 Release Engineering Team, e.g.,
70 The following options are supported:
71 .Bl -tag -width "-r newrelease"
73 Operate on a system mounted at
77 or as given in the configuration file.)
79 Store working files in
82 .Pa /var/db/freebsd-update/ ,
83 or as given in the configuration file.)
85 Read configuration options from
88 .Pa /etc/freebsd-update.conf )
92 to proceed in the case of an unfinished upgrade.
94 Trust an RSA key with SHA256 of
96 (default: read value from configuration file.)
97 .It Fl r Ar newrelease
98 Specify the new release (e.g. 11.2-RELEASE) to which
100 should upgrade (upgrade command only).
102 Fetch files from the specified server or server pool.
103 (default: read value from configuration file.)
109 (default: root, or as given in the configuration file.)
110 .It Fl -not-running-from-cron
113 to proceed when there is no controlling tty.
114 This is for use by automated scripts and orchestration tools.
117 from crontab or similar using this flag, see:
119 .It Fl -currently-running Ar release
120 Do not detect the currently-running release; instead, assume that the
121 system is running the specified
123 This is most likely to be useful when upgrading jails.
128 can be any one of the following:
129 .Bl -tag -width "rollback"
131 Based on the currently installed world and the configuration
132 options set, fetch all available binary updates.
134 Sleep a random amount of time between 1 and 3600 seconds,
135 then download updates as if the
138 If updates are downloaded, an email will be sent
139 (to root or a different address if specified via the
141 option or in the configuration file).
142 As the name suggests, this command is designed for running
145 the random delay serves to minimize the probability that
146 a large number of machines will simultaneously attempt to
149 Fetch files necessary for upgrading to a new release.
150 Before using this command, make sure that you read the
151 announcement and release notes for the new release in
152 case there are any special steps needed for upgrading.
153 Note that this command may require up to 500 MB of space in
155 depending on which components of the
157 base system are installed.
159 Install the most recently fetched updates or upgrade.
161 Uninstall the most recently installed updates.
163 Compare the system against a "known good" index of the
169 If your clock is set to local time, adding the line
171 .Dl 0 3 * * * root /usr/sbin/freebsd-update cron
173 to /etc/crontab will check for updates every night.
174 If your clock is set to UTC, please pick a random time
175 other than 3AM, to avoid overly imposing an uneven load
176 on the server(s) hosting the updates.
178 In spite of its name,
180 IDS should not be relied upon as an "Intrusion Detection
181 System", since if the system has been tampered with
182 it cannot be trusted to operate correctly.
183 If you intend to use this command for intrusion-detection
184 purposes, make sure you boot from a secure disk (e.g., a CD).
187 .Bl -tag -width "/etc/freebsd-update.conf"
188 .It Pa /etc/freebsd-update.conf
189 Default location of the
192 .It Pa /var/db/freebsd-update/
193 Default location where
195 stores temporary files and downloaded updates.
198 .Xr freebsd-update.conf 5
200 .An Colin Percival Aq Mt cperciva@FreeBSD.org