xref: /openbsd-src/usr.sbin/sysupgrade/sysupgrade.8 (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1.\"	$OpenBSD: sysupgrade.8,v 1.13 2022/06/08 09:03:11 mglocker 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: June 8 2022 $
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 Fl b Ar base-directory
28.Op Ar installurl
29.Sh DESCRIPTION
30.Nm
31is a utility to upgrade
32.Ox
33to the next release or a new snapshot if available.
34.Pp
35.Nm
36downloads the necessary files to
37.Pa /home/_sysupgrade ,
38verifies them with
39.Xr signify 1 ,
40and copies bsd.rd to
41.Pa /bsd.upgrade .
42.Pp
43.Nm
44by default then reboots the system.
45The bootloader will automatically choose
46.Pa /bsd.upgrade ,
47triggering a one-shot upgrade using the files in
48.Pa /home/_sysupgrade .
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl b Ar base-directory
53Download files to
54.Ar base-directory Ns / Ns Pa _sysupgrade
55instead of
56.Pa /home/_sysupgrade .
57.It Fl f
58Force an already applied upgrade.
59The default is to upgrade to latest snapshot only if available.
60This option has no effect on releases.
61.It Fl k
62Keep the files in
63.Pa /home/_sysupgrade .
64By default they will be deleted after the upgrade.
65.It Fl n
66Fetch and verify the files and create
67.Pa /bsd.upgrade
68but do not reboot.
69.It Fl r
70Upgrade to the next release.
71This is the default if the system is currently running a release.
72.It Fl s
73Upgrade to a snapshot.
74This is the default if the system is currently running a snapshot.
75.El
76.Pp
77See
78.Xr upgrade.site 5
79for how to customize the upgrade process.
80.Sh FILES
81.Bl -tag -width "/auto_upgrade.conf" -compact
82.It Pa /auto_upgrade.conf
83Response file for the ramdisk kernel.
84.It Pa /bsd.upgrade
85The ramdisk kernel to trigger an unattended upgrade.
86.It Pa /etc/installurl
87.Ox
88mirror top-level URL for fetching an upgrade.
89.It Pa /home/_sysupgrade
90Directory the upgrade is downloaded to.
91.El
92.Sh SEE ALSO
93.Xr signify 1 ,
94.Xr installurl 5 ,
95.Xr upgrade.site 5 ,
96.Xr autoinstall 8 ,
97.Xr release 8
98.Sh HISTORY
99.Nm
100first appeared in
101.Ox 6.6 .
102