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

   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 8
  30 .Os FreeBSD
  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 k Ar KEY
  40 .Op Fl s Ar server
  41 .Op Fl t Ar address
  42 .Cm command ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 tool is used to fetch, install, and rollback binary
  47 updates to the FreeBSD base system.
  48 .Sh OPTIONS
  49 The following options are supported
  50 .Bl -tag -width "-f conffile"
  51 .It Fl b Ar basedir
  52 Operate on a system mounted at
  53 .Ar basedir .
  54 (default:
  55 .Pa / ,
  56 or as given in the configuration file.)
  57 .It Fl d Ar workdir
  58 Store working files in
  59 .Ar workdir .
  60 (default:
  61 .Pa /var/db/freebsd-update/ ,
  62 or as given in the configuration file.)
  63 .It Fl f Ar conffile
  64 Read configuration options from
  65 .Ar conffile .
  66 (default:
  67 .Pa /etc/freebsd-update.conf )
  68 .It Fl k Ar KEY
  69 Trust an RSA key with SHA256 of
  70 .Ar KEY .
  71 (default: read value from configuration file.)
  72 .It Fl s Ar server
  73 Fetch files from the specified server or server pool.
  74 (default: read value from configuration file.)
  75 .It Fl t Ar address
  76 Mail output of
  77 .Cm cron
  78 command, if any, to
  79 .Ar address .
  80 (default: root, or as given in the configuration file.)
  81 .El
  82 .Sh COMMANDS
  83 The
  84 .Cm command
  85 can be any one of the following:
  86 .Pp
  87 .Bl -tag -width "-f conffile"
  88 .It Cm fetch
  89 Based on the currently installed world and the configuration
  90 options set, fetch all available binary updates.
  91 .It Cm cron
  92 Sleep a random amount of time between 1 and 3600 seconds,
  93 then download updates as if the
  94 .Cm fetch
  95 command was used.
  96 If updates are downloaded, an email will be sent
  97 (to root or a different address if specified via the
  98 .Fl t
  99 option or in the configuration file).
 100 As the name suggests, this command is designed for running
 101 from
 102 .Xr cron 8 ;
 103 the random delay serves to minimize the probability that
 104 a large number of machines will simultaneously attempt to
 105 fetch updates.
 106 .It Cm install
 107 Install the most recently fetched updates.
 108 .It Cm rollback
 109 Uninstall the most recently installed updates.
 110 .El
 111 .Sh TIPS
 112 .Bl -bullet
 113 .It
 114 If your clock is set to local time, adding the line
 115 .Pp
 116 .Dl 0 3 * * * root /usr/sbin/freebsd-update cron
 117 .Pp
 118 to /etc/crontab will check for updates every night.
 119 If your block is set to UTC, please pick a random time
 120 other than 3AM, to avoid overly imposing an uneven load
 121 on the server(s) hosting the updates.
 122 .El
 123 .Sh FILES
 124 .Bl -tag -width "/etc/freebsd-update.conf"
 125 .It /etc/freebsd-update.conf
 126 Default location of the
 127 .Nm
 128 configuration file.
 129 .It /var/db/freebsd-update/
 130 Default location where
 131 .Nm
 132 stores temporary files and downloaded updates.
 133 .El
 134 .Sh SEE ALSO
 135 .Xr freebsd-update.conf 5
 136 .Sh AUTHORS
 137 .An Colin Percival Aq cperciva@FreeBSD.org