Changeset View
Changeset View
Standalone View
Standalone View
sbin/bectl/bectl.8
Show All 11 Lines | |||||
.\" notice, this list of conditions and the following disclaimer in the | .\" notice, this list of conditions and the following disclaimer in the | ||||
.\" documentation and/or other materials provided with the distribution. | .\" documentation and/or other materials provided with the distribution. | ||||
.\" | .\" | ||||
.\" | .\" | ||||
.\" @(#)be.1 | .\" @(#)be.1 | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd April 18, 2020 | .Dd July 18, 2020 | ||||
.Dt BECTL 8 | .Dt BECTL 8 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm bectl | .Nm bectl | ||||
.Nd Utility to manage boot environments on ZFS | .Nd Utility to manage boot environments on ZFS | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Cm activate | .Cm activate | ||||
.Op Fl t | .Op Fl t | Fl T | ||||
.Ar beName | .Ar beName | ||||
.Nm | .Nm | ||||
.Cm check | .Cm check | ||||
.Nm | .Nm | ||||
.Cm create | .Cm create | ||||
.Op Fl r | .Op Fl r | ||||
.Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot | .Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot | ||||
.Ar newBeName | .Ar newBeName | ||||
▲ Show 20 Lines • Show All 52 Lines • ▼ Show 20 Lines | |||||
allow the system to be upgraded, while preserving the old system environment in | allow the system to be upgraded, while preserving the old system environment in | ||||
a separate ZFS dataset. | a separate ZFS dataset. | ||||
.Pp | .Pp | ||||
The following commands are supported by | The following commands are supported by | ||||
.Nm : | .Nm : | ||||
.Bl -tag -width activate | .Bl -tag -width activate | ||||
.It Xo | .It Xo | ||||
.Cm activate | .Cm activate | ||||
.Op Fl t | .Op Fl t | Fl T | ||||
.Ar beName | .Ar beName | ||||
.Xc | .Xc | ||||
Activate the given | Activate the given | ||||
.Ar beName | .Ar beName | ||||
as the default boot filesystem. | as the default boot filesystem. | ||||
If the | If the | ||||
.Op Fl t | .Fl t | ||||
flag is given, this takes effect only for the next boot. | flag is given, this takes effect only for the next boot. | ||||
Flag | |||||
.Fl T | |||||
removes temporary boot once configuration. | |||||
kevans: New sentence should start on a new line. | |||||
Without temporary configuration, the next boot will use zfs dataset specified | |||||
in boot pool | |||||
.Ar bootfs | |||||
property. | |||||
.It Xo | .It Xo | ||||
.Cm check | .Cm check | ||||
.Xc | .Xc | ||||
Performs a silent sanity check on the current system. | Performs a silent sanity check on the current system. | ||||
If boot environments are supported and used, | If boot environments are supported and used, | ||||
.Nm | .Nm | ||||
will exit with a status code of 0. | will exit with a status code of 0. | ||||
Any other status code is not currently defined and may, in the future, grow | Any other status code is not currently defined and may, in the future, grow | ||||
▲ Show 20 Lines • Show All 140 Lines • ▼ Show 20 Lines | |||||
.Pp | .Pp | ||||
Display all boot environments. | Display all boot environments. | ||||
The | The | ||||
.Em Active | .Em Active | ||||
field indicates whether the boot environment is active now | field indicates whether the boot environment is active now | ||||
.Pq Em \&N ; | .Pq Em \&N ; | ||||
active on reboot | active on reboot | ||||
.Pq Em \&R ; | .Pq Em \&R ; | ||||
or both | is used on next boot once | ||||
.Pq Em \&NR . | .Pq Em \&T ; | ||||
or combination of | |||||
.Pq Em \&NRT . | |||||
.Pp | .Pp | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Fl a | .It Fl a | ||||
Display all datasets. | Display all datasets. | ||||
.It Fl D | .It Fl D | ||||
Display the full space usage for each boot environment, assuming all | Display the full space usage for each boot environment, assuming all | ||||
other boot environments were destroyed. | other boot environments were destroyed. | ||||
.It Fl H | .It Fl H | ||||
▲ Show 20 Lines • Show All 97 Lines • Show Last 20 Lines |
New sentence should start on a new line.