usr.sbin/freebsd-update/freebsd-update.8

   1 .\"-
   2 .\" Copyright 2006, 2007 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 March 29, 2022
  29 .Dt FREEBSD-UPDATE 8
  30 .Os
  31 .Sh NAME
  32 .Nm freebsd-update
  33 .Nd fetch and install binary updates to FreeBSD
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl b Ar basedir
  37 .Op Fl d Ar workdir
  38 .Op Fl f Ar conffile
  39 .Op Fl F
  40 .Op Fl j Ar jail
  41 .Op Fl k Ar KEY
  42 .Op Fl r Ar newrelease
  43 .Op Fl s Ar server
  44 .Op Fl t Ar address
  45 .Op Fl -not-running-from-cron
  46 .Ar command ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 tool is used to fetch, install, and rollback binary
  51 updates to the
  52 .Fx
  53 base system.
  54 Note that updates are only available if they are being built for the
  55 .Fx
  56 release and architecture being used; in particular, the
  57 .Fx
  58 Security Team only builds updates for releases shipped in binary form
  59 by the
  60 .Fx
  61 Release Engineering Team, e.g.,
  62 .Fx
  63 11.2-RELEASE and
  64 .Fx
  65 12.0-RELEASE, but not
  66 .Fx
  67 11.2-STABLE or
  68 .Fx
  69 13.0-CURRENT.
  70 .Sh OPTIONS
  71 The following options are supported:
  72 .Bl -tag -width "-r newrelease"
  73 .It Fl b Ar basedir
  74 Operate on a system mounted at
  75 .Ar basedir .
  76 (default:
  77 .Pa / ,
  78 or as given in the configuration file.)
  79 .It Fl d Ar workdir
  80 Store working files in
  81 .Ar workdir .
  82 (default:
  83 .Pa /var/db/freebsd-update/ ,
  84 or as given in the configuration file.)
  85 .It Fl f Ar conffile
  86 Read configuration options from
  87 .Ar conffile .
  88 (default:
  89 .Pa /etc/freebsd-update.conf )
  90 .It Fl F
  91 Force
  92 .Nm Cm fetch
  93 to proceed in the case of an unfinished upgrade.
  94 .It Fl j Ar jail
  95 Operate on the given jail specified by
  96 .Va jid
  97 or
  98 .Va name .
  99 (The version of the installed userland is detected and the
 100 .Fl -currently-running
 101 option is no more required.)
 102 .It Fl k Ar KEY
 103 Trust an RSA key with SHA256 of
 104 .Ar KEY .
 105 (default: read value from configuration file.)
 106 .It Fl r Ar newrelease
 107 Specify the new release (e.g., 11.2-RELEASE) to which
 108 .Nm
 109 should upgrade
 110 .Pq Cm upgrade No command only .
 111 .It Fl s Ar server
 112 Fetch files from the specified server or server pool.
 113 (default: read value from configuration file.)
 114 .It Fl t Ar address
 115 Mail output of
 116 .Cm cron
 117 command, if any, to
 118 .Ar address .
 119 (default: root, or as given in the configuration file.)
 120 .It Fl -not-running-from-cron
 121 Force
 122 .Nm Cm fetch
 123 to proceed when there is no controlling
 124 .Xr tty 4 .
 125 This is for use by automated scripts and orchestration tools.
 126 Please do not run
 127 .Nm Cm fetch
 128 from
 129 .Xr crontab 5
 130 or similar using this flag, see:
 131 .Nm Cm cron
 132 .It Fl -currently-running Ar release
 133 Do not detect the currently-running release; instead, assume that the
 134 system is running the specified
 135 .Ar release .
 136 This is most likely to be useful when upgrading jails.
 137 .El
 138 .Sh COMMANDS
 139 The
 140 .Cm command
 141 can be any one of the following:
 142 .Bl -tag -width "rollback"
 143 .It Cm fetch
 144 Based on the currently installed world and the configuration
 145 options set, fetch all available binary updates.
 146 .It Cm cron
 147 Sleep a random amount of time between 1 and 3600 seconds,
 148 then download updates as if the
 149 .Cm fetch
 150 command was used.
 151 If updates are downloaded, an email will be sent
 152 (to root or a different address if specified via the
 153 .Fl t
 154 option or in the configuration file).
 155 As the name suggests, this command is designed for running
 156 from
 157 .Xr cron 8 ;
 158 the random delay serves to minimize the probability that
 159 a large number of machines will simultaneously attempt to
 160 fetch updates.
 161 .It Cm upgrade
 162 Fetch files necessary for upgrading to a new release.
 163 Before using this command, make sure that you read the
 164 announcement and release notes for the new release in
 165 case there are any special steps needed for upgrading.
 166 Note that this command may require up to 500 MB of space in
 167 .Ar workdir
 168 depending on which components of the
 169 .Fx
 170 base system are installed.
 171 .It Cm updatesready
 172 Check if there are fetched updates ready to install.
 173 Returns exit code 2 if there are no updates to install.
 174 .It Cm install
 175 Install the most recently fetched updates or upgrade.
 176 Returns exit code 2 if there are no updates to install
 177 and the
 178 .Cm fetch
 179 command wasn't passed as an earlier argument in the same
 180 invocation.
 181 .It Cm rollback
 182 Uninstall the most recently installed updates.
 183 .It Cm IDS
 184 Compare the system against a "known good" index of the
 185 installed release.
 186 .It Cm showconfig
 187 Show configuration options after parsing conffile and command
 188 line options.
 189 .El
 190 .Sh TIPS
 191 .Bl -bullet
 192 .It
 193 If your clock is set to local time, adding the line
 194 .Pp
 195 .Dl 0 3 * * * root /usr/sbin/freebsd-update cron
 196 .Pp
 197 to
 198 .Pa /etc/crontab
 199 will check for updates every night.
 200 If your clock is set to UTC, please pick a random time
 201 other than 3AM, to avoid overly imposing an uneven load
 202 on the server(s) hosting the updates.
 203 .It
 204 In spite of its name,
 205 .Nm
 206 IDS should not be relied upon as an "Intrusion Detection
 207 System", since if the system has been tampered with
 208 it cannot be trusted to operate correctly.
 209 If you intend to use this command for intrusion-detection
 210 purposes, make sure you boot from a secure disk (e.g., a CD).
 211 .El
 212 .Sh ENVIRONMENT
 213 .Bl -tag -width "PAGER"
 214 .It Ev PAGER
 215 The pager program used to present various reports during the execution.
 216 .Po
 217 Default:
 218 .Dq Pa /usr/bin/less .
 219 .Pc
 220 .Pp
 221 .Ev PAGER
 222 can be set to
 223 .Dq cat
 224 when a non-interactive pager is desired.
 225 .El
 226 .Sh FILES
 227 .Bl -tag -width "/etc/freebsd-update.conf"
 228 .It Pa /etc/freebsd-update.conf
 229 Default location of the
 230 .Nm
 231 configuration file.
 232 .It Pa /var/db/freebsd-update/
 233 Default location where
 234 .Nm
 235 stores temporary files and downloaded updates.
 236 .El
 237 .Sh SEE ALSO
 238 .Xr freebsd-update.conf 5 ,
 239 .Xr nextboot 8
 240 .Sh AUTHORS
 241 .An Colin Percival Aq Mt cperciva@FreeBSD.org