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
38 .Op Fl -currently-running Ar release
43 .Op Fl -not-running-from-cron
44 .Op Fl r Ar newrelease
51 tool is used to fetch, install, and rollback binary
55 .Sh BINARY UPDATES AVAILABILITY
56 Binary updates are not available for every single
58 version and architecture.
60 In general, binary updates are available for ALPHA, BETA, RC, and RELEASE
64 .Bl -item -offset indent -compact
74 They are not available for branches such as PRERELEASE, STABLE, and CURRENT,
76 .Bl -item -offset indent -compact
87 Security Team only builds updates for releases shipped in binary form
90 Release Engineering Team.
92 The following options are supported:
93 .Bl -tag -width "-r newrelease"
95 Operate on a system mounted at
99 or as given in the configuration file.)
101 Store working files in
104 .Pa /var/db/freebsd-update/ ,
105 or as given in the configuration file.)
107 Read configuration options from
110 .Pa /etc/freebsd-update.conf )
114 to proceed in the case of an unfinished upgrade.
116 Operate on the given jail specified by
120 (The version of the installed userland is detected and the
121 .Fl -currently-running
122 option is no more required.)
124 Trust an RSA key with SHA256 of
126 (default: read value from configuration file.)
127 .It Fl r Ar newrelease
128 Specify the new release (e.g., 11.2-RELEASE) to which
131 .Pq Cm upgrade No command only .
133 Fetch files from the specified server or server pool.
134 (default: read value from configuration file.)
140 (default: root, or as given in the configuration file.)
141 .It Fl -not-running-from-cron
144 to proceed when there is no controlling
146 This is for use by automated scripts and orchestration tools.
151 or similar using this flag, see:
153 .It Fl -currently-running Ar release
154 Do not detect the currently-running release; instead, assume that the
155 system is running the specified
157 This is most likely to be useful when upgrading jails.
162 can be any one of the following:
163 .Bl -tag -width "rollback"
165 Based on the currently installed world and the configuration
166 options set, fetch all available binary updates.
168 Sleep a random amount of time between 1 and 3600 seconds,
169 then download updates as if the
172 If updates are downloaded, an email will be sent
173 (to root or a different address if specified via the
175 option or in the configuration file).
176 As the name suggests, this command is designed for running
179 the random delay serves to minimize the probability that
180 a large number of machines will simultaneously attempt to
183 Fetch files necessary for upgrading to a new release.
184 Before using this command, make sure that you read the
185 announcement and release notes for the new release in
186 case there are any special steps needed for upgrading.
187 Note that this command may require up to 500 MB of space in
189 depending on which components of the
191 base system are installed.
193 Check if there are fetched updates ready to install.
194 Returns exit code 2 if there are no updates to install.
196 Install the most recently fetched updates or upgrade.
197 Returns exit code 2 if there are no updates to install
200 command wasn't passed as an earlier argument in the same
203 Uninstall the most recently installed updates.
205 Compare the system against a "known good" index of the
208 Show configuration options after parsing conffile and command
214 If your clock is set to local time, adding the line
216 .Dl 0 3 * * * root /usr/sbin/freebsd-update cron
220 will check for updates every night.
221 If your clock is set to UTC, please pick a random time
222 other than 3AM, to avoid overly imposing an uneven load
223 on the server(s) hosting the updates.
225 In spite of its name,
227 IDS should not be relied upon as an "Intrusion Detection
228 System", since if the system has been tampered with
229 it cannot be trusted to operate correctly.
230 If you intend to use this command for intrusion-detection
231 purposes, make sure you boot from a secure disk (e.g., a CD).
234 .Bl -tag -width "PAGER"
236 The pager program used to present various reports during the execution.
239 .Dq Pa /usr/bin/less .
245 when a non-interactive pager is desired.
248 .Bl -tag -width "/etc/freebsd-update.conf"
249 .It Pa /etc/freebsd-update.conf
250 Default location of the
253 .It Pa /var/db/freebsd-update/
254 Default location where
256 stores temporary files and downloaded updates.
259 .Xr freebsd-update.conf 5 ,
262 .An Colin Percival Aq Mt cperciva@FreeBSD.org