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 August 25, 2020 | .Dd January 6, 2021 | ||||
.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 | ||||
Show All 37 Lines | |||||
.Ar beName | .Ar beName | ||||
.Op Ar mountpoint | .Op Ar mountpoint | ||||
.Nm | .Nm | ||||
.Cm rename | .Cm rename | ||||
.Ar origBeName | .Ar origBeName | ||||
.Ar newBeName | .Ar newBeName | ||||
.Nm | .Nm | ||||
.Brq Cm ujail | unjail | .Brq Cm ujail | unjail | ||||
.Brq Ar jailId | jailName | .Brq Ar jailId | jailName | beName | ||||
.Ar beName | |||||
.Nm | .Nm | ||||
.Brq Cm umount | unmount | .Brq Cm umount | unmount | ||||
.Op Fl f | .Op Fl f | ||||
.Ar beName | .Ar beName | ||||
.Pp | .Pp | ||||
.Nm | .Nm | ||||
.Op Fl h\&? | .Op Fl h\&? | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
▲ Show 20 Lines • Show All 167 Lines • ▼ Show 20 Lines | |||||
.It Va path Ta Set to a path in Pa /tmp | .It Va path Ta Set to a path in Pa /tmp | ||||
generated by | generated by | ||||
.Xr libbe 3 . | .Xr libbe 3 . | ||||
.El | .El | ||||
.Pp | .Pp | ||||
All default parameters may be overwritten. | All default parameters may be overwritten. | ||||
.It Xo | .It Xo | ||||
.Cm list | .Cm list | ||||
.Op Fl DHas | .Op Fl aDHs | ||||
.Oo Bro Fl c Ar property | Fl C Ar property Brc Oc | .Oo Bro Fl c Ar property | Fl C Ar property Brc Oc | ||||
.Xc | .Xc | ||||
.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 ; | ||||
▲ Show 20 Lines • Show All 48 Lines • ▼ Show 20 Lines | |||||
.Ar mountpoint | .Ar mountpoint | ||||
if provided. | if provided. | ||||
.It Cm rename Ar origBeName newBeName | .It Cm rename Ar origBeName newBeName | ||||
Rename the given | Rename the given | ||||
.Ar origBeName | .Ar origBeName | ||||
to the given | to the given | ||||
.Ar newBeName . | .Ar newBeName . | ||||
The boot environment will not be unmounted in order for this rename to occur. | The boot environment will not be unmounted in order for this rename to occur. | ||||
.It Cm ujail Bro Ar jailId | jailName Brc Ar beName | .It Cm ujail Brq Ar jailId | jailName | beName | ||||
.It Cm unjail Bro Ar jailId | jailName Brc Ar beName | .It Cm unjail Brq Ar jailId | jailName | beName | ||||
Destroy the jail created from the given boot environment. | Destroy the jail created from the given boot environment. | ||||
.It Xo | .It Xo | ||||
.Cm umount | .Cm umount | ||||
.Op Fl f | .Op Fl f | ||||
.Ar beName | .Ar beName | ||||
.Xc | .Xc | ||||
.It Xo | .It Xo | ||||
.Cm unmount | .Cm unmount | ||||
▲ Show 20 Lines • Show All 45 Lines • Show Last 20 Lines |