Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/freebsd-update/freebsd-update.8
| Show All 19 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||||
| .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | ||||
| .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||||
| .\" POSSIBILITY OF SUCH DAMAGE. | .\" POSSIBILITY OF SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd July 14, 2010 | .Dd January 17, 2015 | ||||
| .Dt FREEBSD-UPDATE 8 | .Dt FREEBSD-UPDATE 8 | ||||
| .Os FreeBSD | .Os FreeBSD | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm freebsd-update | .Nm freebsd-update | ||||
| .Nd fetch and install binary updates to FreeBSD | .Nd fetch and install binary updates to FreeBSD | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .Nm | .Nm | ||||
| .Op Fl F | |||||
| .Op Fl b Ar basedir | .Op Fl b Ar basedir | ||||
| .Op Fl d Ar workdir | .Op Fl d Ar workdir | ||||
| .Op Fl f Ar conffile | .Op Fl f Ar conffile | ||||
| .Op Fl k Ar KEY | .Op Fl k Ar KEY | ||||
| .Op Fl r Ar newrelease | .Op Fl r Ar newrelease | ||||
| .Op Fl s Ar server | .Op Fl s Ar server | ||||
| .Op Fl t Ar address | .Op Fl t Ar address | ||||
| .Cm command ... | .Cm command ... | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| tool is used to fetch, install, and rollback binary | tool is used to fetch, install, and rollback binary | ||||
| updates to the FreeBSD base system. | updates to the FreeBSD base system. | ||||
| Note that updates are only available if they are being built for the | Note that updates are only available if they are being built for the | ||||
| FreeBSD release and architecture being used; in particular, the | FreeBSD release and architecture being used; in particular, the | ||||
| .Fx | .Fx | ||||
| Security Team only builds updates for releases shipped in binary form | Security Team only builds updates for releases shipped in binary form | ||||
| by the | by the | ||||
| .Fx | .Fx | ||||
| Release Engineering Team, e.g., | Release Engineering Team, e.g., | ||||
| .Fx | .Fx | ||||
| 7.3-RELEASE and | 9.3-RELEASE and | ||||
| .Fx | .Fx | ||||
| 8.0-RELEASE, but not | 10.1-RELEASE, but not | ||||
| .Fx | .Fx | ||||
| 6.3-STABLE or | 9.3-STABLE or | ||||
| .Fx | .Fx | ||||
| 9.0-CURRENT. | 11-CURRENT. | ||||
| .Sh OPTIONS | .Sh OPTIONS | ||||
| The following options are supported: | The following options are supported: | ||||
| .Bl -tag -width "-f conffile" | .Bl -tag -width "-f newrelease" | ||||
| .It Fl b Ar basedir | .It Fl b Ar basedir | ||||
| Operate on a system mounted at | Operate on a system mounted at | ||||
| .Ar basedir . | .Ar basedir . | ||||
| (default: | (default: | ||||
| .Pa / , | .Pa / , | ||||
| or as given in the configuration file.) | or as given in the configuration file.) | ||||
| .It Fl d Ar workdir | .It Fl d Ar workdir | ||||
| Store working files in | Store working files in | ||||
| .Ar workdir . | .Ar workdir . | ||||
| (default: | (default: | ||||
| .Pa /var/db/freebsd-update/ , | .Pa /var/db/freebsd-update/ , | ||||
| or as given in the configuration file.) | or as given in the configuration file.) | ||||
| .It Fl f Ar conffile | .It Fl f Ar conffile | ||||
| Read configuration options from | Read configuration options from | ||||
| .Ar conffile . | .Ar conffile . | ||||
| (default: | (default: | ||||
| .Pa /etc/freebsd-update.conf ) | .Pa /etc/freebsd-update.conf ) | ||||
| .It Fl F | |||||
| Force | |||||
| .Nm | |||||
| .Cm fetch | |||||
| to proceed where it normally would not, such as when there is no tty. | |||||
| .It Fl k Ar KEY | .It Fl k Ar KEY | ||||
| Trust an RSA key with SHA256 of | Trust an RSA key with SHA256 of | ||||
| .Ar KEY . | .Ar KEY . | ||||
| (default: read value from configuration file.) | (default: read value from configuration file.) | ||||
| .It Fl r Ar newrelease | .It Fl r Ar newrelease | ||||
| Specify the new release to which | Specify the new release to which | ||||
| .Nm | .Nm | ||||
| should upgrade (upgrade command only). | should upgrade (upgrade command only). | ||||
| .It Fl s Ar server | .It Fl s Ar server | ||||
| Fetch files from the specified server or server pool. | Fetch files from the specified server or server pool. | ||||
| (default: read value from configuration file.) | (default: read value from configuration file.) | ||||
| .It Fl t Ar address | .It Fl t Ar address | ||||
| Mail output of | Mail output of | ||||
| .Cm cron | .Cm cron | ||||
| command, if any, to | command, if any, to | ||||
| .Ar address . | .Ar address . | ||||
| (default: root, or as given in the configuration file.) | (default: root, or as given in the configuration file.) | ||||
| .El | .El | ||||
| .Sh COMMANDS | .Sh COMMANDS | ||||
| The | The | ||||
| .Cm command | .Cm command | ||||
| can be any one of the following: | can be any one of the following: | ||||
bcr: Hmm, are we endorsing products here? I see the intention to give examples and I use some of… | |||||
Not Done Inline ActionsThere might also be an issue with this page still being around long after the named programs are gone. I can't think of a generic term for them right now, but there should be one. If names are going to be mentioned, they should be capitalized. wblock: There might also be an issue with this page still being around long after the named programs… | |||||
Not Done Inline ActionsHow about just writing "This is for use by automated tools." for now? This would keep the issue from stalling and we can always add more details to the handbook with concrete examples. bcr: How about just writing "This is for use by automated tools." for now? This would keep the issue… | |||||
| .Bl -tag -width "-f conffile" | .Bl -tag -width "-f conffile" | ||||
| .It Cm fetch | .It Cm fetch | ||||
| Based on the currently installed world and the configuration | Based on the currently installed world and the configuration | ||||
| options set, fetch all available binary updates. | options set, fetch all available binary updates. | ||||
| .It Cm cron | .It Cm cron | ||||
| Sleep a random amount of time between 1 and 3600 seconds, | Sleep a random amount of time between 1 and 3600 seconds, | ||||
| then download updates as if the | then download updates as if the | ||||
| .Cm fetch | .Cm fetch | ||||
| ▲ Show 20 Lines • Show All 64 Lines • Show Last 20 Lines | |||||
Hmm, are we endorsing products here? I see the intention to give examples and I use some of these myself. I just want to avoid that similar solutions file PRs wanting to be listed there as well. Maybe we can phrase this less product specific while still making it clear what we mean?