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
40 .Op Fl r Ar newrelease
47 tool is used to fetch, install, and rollback binary
48 updates to the FreeBSD base system.
49 Note that updates are only available if they are being built for the
50 FreeBSD release and architecture being used; in particular, the
52 Security Team only builds updates for releases shipped in binary form
55 Release Engineering Team, e.g.,
65 The following options are supported:
66 .Bl -tag -width "-f conffile"
68 Operate on a system mounted at
72 or as given in the configuration file.)
74 Store working files in
77 .Pa /var/db/freebsd-update/ ,
78 or as given in the configuration file.)
80 Read configuration options from
83 .Pa /etc/freebsd-update.conf )
85 Trust an RSA key with SHA256 of
87 (default: read value from configuration file.)
88 .It Fl r Ar newrelease
89 Specify the new release to which
91 should upgrade (upgrade command only).
93 Fetch files from the specified server or server pool.
94 (default: read value from configuration file.)
100 (default: root, or as given in the configuration file.)
105 can be any one of the following:
106 .Bl -tag -width "-f conffile"
108 Based on the currently installed world and the configuration
109 options set, fetch all available binary updates.
111 Sleep a random amount of time between 1 and 3600 seconds,
112 then download updates as if the
115 If updates are downloaded, an email will be sent
116 (to root or a different address if specified via the
118 option or in the configuration file).
119 As the name suggests, this command is designed for running
122 the random delay serves to minimize the probability that
123 a large number of machines will simultaneously attempt to
126 Fetch files necessary for upgrading to a new release.
127 Before using this command, make sure that you read the
128 announcement and release notes for the new release in
129 case there are any special steps needed for upgrading.
130 Note that this command may require up to 500 MB of space in
132 depending on which components of the
134 base system are installed.
136 Install the most recently fetched updates or upgrade.
138 Uninstall the most recently installed updates.
140 Compare the system against a "known good" index of the
146 If your clock is set to local time, adding the line
148 .Dl 0 3 * * * root /usr/sbin/freebsd-update cron
150 to /etc/crontab will check for updates every night.
151 If your clock is set to UTC, please pick a random time
152 other than 3AM, to avoid overly imposing an uneven load
153 on the server(s) hosting the updates.
155 In spite of its name,
157 IDS should not be relied upon as an "Intrusion Detection
158 System", since if the system has been tampered with
159 it cannot be trusted to operate correctly.
160 If you intend to use this command for intrusion-detection
161 purposes, make sure you boot from a secure disk (e.g., a CD).
164 .Bl -tag -width "/etc/freebsd-update.conf"
165 .It Pa /etc/freebsd-update.conf
166 Default location of the
169 .It Pa /var/db/freebsd-update/
170 Default location where
172 stores temporary files and downloaded updates.
175 .Xr freebsd-update.conf 5
177 .An Colin Percival Aq cperciva@FreeBSD.org