diff options
Diffstat (limited to 'usr.sbin/freebsd-update/freebsd-update.8')
| -rw-r--r-- | usr.sbin/freebsd-update/freebsd-update.8 | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/usr.sbin/freebsd-update/freebsd-update.8 b/usr.sbin/freebsd-update/freebsd-update.8 new file mode 100644 index 0000000..aae5f4d --- /dev/null +++ b/usr.sbin/freebsd-update/freebsd-update.8 @@ -0,0 +1,137 @@ +.\"- +.\" Copyright 2006 Colin Percival +.\" All rights reserved +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted providing that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd August 30, 2006 +.Dt FREEBSD-UPDATE 8 +.Os FreeBSD +.Sh NAME +.Nm freebsd-update +.Nd fetch and install binary updates to FreeBSD +.Sh SYNOPSIS +.Nm +.Op Fl b Ar basedir +.Op Fl d Ar workdir +.Op Fl f Ar conffile +.Op Fl k Ar KEY +.Op Fl s Ar server +.Op Fl t Ar address +.Cm command ... +.Sh DESCRIPTION +The +.Nm +tool is used to fetch, install, and rollback binary +updates to the FreeBSD base system. +.Sh OPTIONS +The following options are supported +.Bl -tag -width "-f conffile" +.It Fl b Ar basedir +Operate on a system mounted at +.Ar basedir . +(default: +.Pa / , +or as given in the configuration file.) +.It Fl d Ar workdir +Store working files in +.Ar workdir . +(default: +.Pa /var/db/freebsd-update/ , +or as given in the configuration file.) +.It Fl f Ar conffile +Read configuration options from +.Ar conffile . +(default: +.Pa /etc/freebsd-update.conf ) +.It Fl k Ar KEY +Trust an RSA key with SHA256 of +.Ar KEY . +(default: read value from configuration file.) +.It Fl s Ar server +Fetch files from the specified server or server pool. +(default: read value from configuration file.) +.It Fl t Ar address +Mail output of +.Cm cron +command, if any, to +.Ar address . +(default: root, or as given in the configuration file.) +.El +.Sh COMMANDS +The +.Cm command +can be any one of the following: +.Pp +.Bl -tag -width "-f conffile" +.It Cm fetch +Based on the currently installed world and the configuration +options set, fetch all available binary updates. +.It Cm cron +Sleep a random amount of time between 1 and 3600 seconds, +then download updates as if the +.Cm fetch +command was used. +If updates are downloaded, an email will be sent +(to root or a different address if specified via the +.Fl t +option or in the configuration file). +As the name suggests, this command is designed for running +from +.Xr cron 8 ; +the random delay serves to minimize the probability that +a large number of machines will simultaneously attempt to +fetch updates. +.It Cm install +Install the most recently fetched updates. +.It Cm rollback +Uninstall the most recently installed updates. +.El +.Sh TIPS +.Bl -bullet +.It +If your clock is set to local time, adding the line +.Pp +.Dl 0 3 * * * root /usr/sbin/freebsd-update cron +.Pp +to /etc/crontab will check for updates every night. +If your block is set to UTC, please pick a random time +other than 3AM, to avoid overly imposing an uneven load +on the server(s) hosting the updates. +.El +.Sh FILES +.Bl -tag -width "/etc/freebsd-update.conf" +.It /etc/freebsd-update.conf +Default location of the +.Nm +configuration file. +.It /var/db/freebsd-update/ +Default location where +.Nm +stores temporary files and downloaded updates. +.El +.Sh SEE ALSO +.Xr freebsd-update.conf 5 +.Sh AUTHORS +.An Colin Percival Aq cperciva@FreeBSD.org |
