xref: /openbsd-src/usr.sbin/sysupgrade/sysupgrade.8 (revision 4e1ee0786f11cc571bd0be17d38e46f635c719fc)
1.\"	$OpenBSD: sysupgrade.8,v 1.10 2019/10/03 12:43:58 florian Exp $
2.\"
3.\" Copyright (c) 2019 Florian Obser <florian@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: October 3 2019 $
18.Dt SYSUPGRADE 8
19.Os
20.Sh NAME
21.Nm sysupgrade
22.Nd upgrade system to the next release or a new snapshot
23.Sh SYNOPSIS
24.Nm
25.Op Fl fkn
26.Op Fl r | s
27.Op Ar installurl
28.Sh DESCRIPTION
29.Nm
30is a utility to upgrade
31.Ox
32to the next release or a new snapshot if available.
33.Pp
34.Nm
35downloads the necessary files to
36.Pa /home/_sysupgrade ,
37verifies them with
38.Xr signify 1 ,
39and copies bsd.rd to
40.Pa /bsd.upgrade .
41.Pp
42.Nm
43by default then reboots the system.
44The bootloader will automatically choose
45.Pa /bsd.upgrade ,
46triggering a one-shot upgrade using the files in
47.Pa /home/_sysupgrade .
48.Pp
49The options are as follows:
50.Bl -tag -width Ds
51.It Fl f
52Force an already applied upgrade.
53The default is to upgrade to latest snapshot only if available.
54This option has no effect on releases.
55.It Fl k
56Keep the files in
57.Pa /home/_sysupgrade .
58By default they will be deleted after the upgrade.
59.It Fl n
60Fetch and verify the files and create
61.Pa /bsd.upgrade
62but do not reboot.
63.It Fl r
64Upgrade to the next release.
65This is the default if the system is currently running a release.
66.It Fl s
67Upgrade to a snapshot.
68This is the default if the system is currently running a snapshot.
69.El
70.Sh FILES
71.Bl -tag -width "/auto_upgrade.conf" -compact
72.It Pa /auto_upgrade.conf
73Response file for the ramdisk kernel.
74.It Pa /bsd.upgrade
75The ramdisk kernel to trigger an unattended upgrade.
76.It Pa /etc/installurl
77.Ox
78mirror top-level URL for fetching an upgrade.
79.It Pa /home/_sysupgrade
80Directory the upgrade is downloaded to.
81.El
82.Sh SEE ALSO
83.Xr signify 1 ,
84.Xr installurl 5 ,
85.Xr autoinstall 8 ,
86.Xr release 8
87.Sh HISTORY
88.Nm
89first appeared in
90.Ox 6.6 .
91