d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
60bdfe9869
freebsd-dev/sbin/bectl/bectl.8

378 lines
7.7 KiB
Groff
Raw Normal View History

Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.\"
libbe(3)/bectl(8): Standardize copyright headers - File names don't necessarily need to be repeated - Add SPDX tags - Add a missing copyright for Kyle Kneitinger in bectl.8, originally written by him in GSoC 2017; his standard copyright notice has been copied from other files within the same directory to remain consistent with how he clearly wished to portray it
2018-08-07 13:46:06 +00:00
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
.\"
.\" Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\"
.\" @(#)be.1
libbe(3)/bectl(8): Standardize $FreeBSD$ IDs
2018-08-07 14:02:41 +00:00
.\"
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.\" $FreeBSD$
.\"
bectl(8): sync man page and help text Sync man page with behavior of bectl(8). Sync help text with man page. PR: 246697 Reported by: olgeni Submitted by: olgeni (with changes) Reviewed by: kevans, olgeni Approved by: kevans (mentor) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D27482
2021-01-06 19:38:25 +00:00
.Dd January 6, 2021
bectl(8): Chase rename in manpage
2018-07-24 13:24:30 +00:00
.Dt BECTL 8
libbe(3)/bectl(8): Make igor and mandoc -Tlint a little happier
2018-08-11 01:40:24 +00:00
.Os
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Sh NAME
bectl(8): Chase rename in manpage
2018-07-24 13:24:30 +00:00
.Nm bectl
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Nd Utility to manage boot environments on ZFS
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Sh SYNOPSIS
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm activate
loader: zfs should support bootonce an nextboot bootonce feature is temporary, one time boot, activated by "bectl activate -t BE", "bectl activate -T BE" will reset the bootonce flag. By default, the bootonce setting is reset on attempt to boot and the next boot will use previously active BE. By setting zfs_bootonce_activate="YES" in rc.conf, the bootonce BE will be set permanently active. bootonce dataset name is recorded in boot pool labels, bootenv area. in case of nextboot, the nextboot_enable boolean variable is recorded in freebsd:nvstore nvlist, also stored in boot pool label bootenv area. On boot, the loader will process /boot/nextboot.conf if nextboot_enable is "YES", and will set nextboot_enable to "NO", preventing /boot/nextboot.conf processing on next boot. bootonce and nextboot features are usable in both UEFI and BIOS boot. To use bootonce/nextboot features, the boot loader needs to be updated on disk; if loader.efi is stored on ESP, then ESP needs to be updated and for BIOS boot, stage2 (zfsboot or gptzfsboot) needs to be updated (gpart or other tools). At this time, only lua loader is updated. Sponsored by: Netflix, Klara Inc. Differential Revision: https://reviews.freebsd.org/D25512
2020-09-21 09:01:10 +00:00
.Op Fl t | Fl T
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Ar beName
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Add a "check" command This command simply returns 0 at the moment and explicitly takes no arguments. This should be used by utilities wanting to see if bectl can operate on the system they're running, or with a specific root (`bectl -r`). It may grow more checks than "will libbe successfully init" in the future, but for now this is enough as that checks for the dataset mounted at "/" and that it looks capable of being a BE root (e.g. it's not a top-level dataset) bectl commands can now specify if they want to be silent, and this will turn off libbe_print_on_error so they can control the output as needed. This is already used in `bectl check`, and may be turned on in the future for some other commands where libbe errors are better suppressed as the failure mode may be obvious. Requested by: David Fullard MFC after: 3 days
2019-09-11 13:27:10 +00:00
.Cm check
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm create
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Op Fl r
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot
.Ar newBeName
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): add description for create subcommand In commit r345845, a portion of documentation for the create subcommand was removed. Specifically, for creating a snapshot of an existing boot environment. bectl even has a test-case for this functionality. Removing the sub-command description was discussed in PR 235850. This patch brings back the second "create" description that was originally in place. Albeit, with a few wording/clarifying changes. Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: kevans MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20249
2019-05-22 23:07:40 +00:00
.Cm create
.Op Fl r
.Ar beName@snapshot
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm destroy
bectl(8): Add -o flag to destroy to clean up the origin snapshot of BE We can't predict when destruction of origin is needed, and currently we have a precedent for not prompting for things. Leave the decision up to the user of bectl(8) if they want the origin snapshot to be destroyed or not. Emits a warning when -o isn't used and an origin snapshot is left to be cleaned up, for the time being. This is handy when one drops the -o flag but really did want to clean up the origin. A couple of -e ignore's have been sprinkled around the test suite for places that we don't care that the origin's not been cleaned up. -o functionality tests will be added in the future, but are omitted for now to reduce conflicts with work in flight to fix bits of the tests. Reported by: Shawn Webb MFC after: 1 week
2019-02-11 04:00:01 +00:00
.Op Fl \&Fo
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Ar beName Ns Op Cm @ Ns Ar snapshot
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm export
.Ar sourceBe
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm import
.Ar targetBe
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm jail
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Fl bU
.Oo Bro Fl o Ar key Ns Cm = Ns Ar value | Fl u Ar key Brc Oc Ns ...
.Ar beName
bectl(8): Allow running a custom command in the 'jail' subcommand Instead of always running /bin/sh, allow the user to specify the command to run. The jail is not removed when the command finishes. Meaning, `bectl unjail` will still need to be run. For example: ``` bectl jail newBE pkg upgrade bectl ujail newBE ``` Submitted by: Shawn Webb Obtained from: HardenedBSD (8b451014ab)
2018-08-18 01:12:44 +00:00
.Op Ar utility Op Ar argument ...
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm list
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Fl aDHs
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.Op Fl c Ar property
.Op Fl C Ar property
.Oo Bro Fl c Ar property | Fl C Ar property Brc Oc
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm mount
.Ar beName
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Ar mountpoint
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm rename
.Ar origBeName
.Ar newBeName
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Brq Cm ujail | unjail
bectl(8): sync man page and help text Sync man page with behavior of bectl(8). Sync help text with man page. PR: 246697 Reported by: olgeni Submitted by: olgeni (with changes) Reviewed by: kevans, olgeni Approved by: kevans (mentor) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D27482
2021-01-06 19:38:25 +00:00
.Brq Ar jailId | jailName | beName
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Brq Cm umount | unmount
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Op Fl f
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Ar beName
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Pp
.Nm
.Op Fl h\&?
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Sh DESCRIPTION
The
.Nm
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
command is used to setup and interact with ZFS boot environments, which are
bootable clones of datasets.
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Pp
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Boot environments
allow the system to be upgraded, while preserving the old system environment in
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
a separate ZFS dataset.
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Pp
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
The following commands are supported by
.Nm :
.Bl -tag -width activate
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Xo
.Cm activate
loader: zfs should support bootonce an nextboot bootonce feature is temporary, one time boot, activated by "bectl activate -t BE", "bectl activate -T BE" will reset the bootonce flag. By default, the bootonce setting is reset on attempt to boot and the next boot will use previously active BE. By setting zfs_bootonce_activate="YES" in rc.conf, the bootonce BE will be set permanently active. bootonce dataset name is recorded in boot pool labels, bootenv area. in case of nextboot, the nextboot_enable boolean variable is recorded in freebsd:nvstore nvlist, also stored in boot pool label bootenv area. On boot, the loader will process /boot/nextboot.conf if nextboot_enable is "YES", and will set nextboot_enable to "NO", preventing /boot/nextboot.conf processing on next boot. bootonce and nextboot features are usable in both UEFI and BIOS boot. To use bootonce/nextboot features, the boot loader needs to be updated on disk; if loader.efi is stored on ESP, then ESP needs to be updated and for BIOS boot, stage2 (zfsboot or gptzfsboot) needs to be updated (gpart or other tools). At this time, only lua loader is updated. Sponsored by: Netflix, Klara Inc. Differential Revision: https://reviews.freebsd.org/D25512
2020-09-21 09:01:10 +00:00
.Op Fl t | Fl T
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Ar beName
.Xc
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
Activate the given
.Ar beName
libbe(3)/bectl(8): Make igor and mandoc -Tlint a little happier
2018-08-11 01:40:24 +00:00
as the default boot filesystem.
If the
Remove an unnecessary macro MFC after: 2 days
2020-08-17 08:24:50 +00:00
.Fl t
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
flag is given, this takes effect only for the next boot.
loader: zfs should support bootonce an nextboot bootonce feature is temporary, one time boot, activated by "bectl activate -t BE", "bectl activate -T BE" will reset the bootonce flag. By default, the bootonce setting is reset on attempt to boot and the next boot will use previously active BE. By setting zfs_bootonce_activate="YES" in rc.conf, the bootonce BE will be set permanently active. bootonce dataset name is recorded in boot pool labels, bootenv area. in case of nextboot, the nextboot_enable boolean variable is recorded in freebsd:nvstore nvlist, also stored in boot pool label bootenv area. On boot, the loader will process /boot/nextboot.conf if nextboot_enable is "YES", and will set nextboot_enable to "NO", preventing /boot/nextboot.conf processing on next boot. bootonce and nextboot features are usable in both UEFI and BIOS boot. To use bootonce/nextboot features, the boot loader needs to be updated on disk; if loader.efi is stored on ESP, then ESP needs to be updated and for BIOS boot, stage2 (zfsboot or gptzfsboot) needs to be updated (gpart or other tools). At this time, only lua loader is updated. Sponsored by: Netflix, Klara Inc. Differential Revision: https://reviews.freebsd.org/D25512
2020-09-21 09:01:10 +00:00
Flag
.Fl T
removes temporary boot once configuration.
Without temporary configuration, the next boot will use zfs dataset specified
in boot pool
.Ar bootfs
property.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Xo
bectl(8): Add a "check" command This command simply returns 0 at the moment and explicitly takes no arguments. This should be used by utilities wanting to see if bectl can operate on the system they're running, or with a specific root (`bectl -r`). It may grow more checks than "will libbe successfully init" in the future, but for now this is enough as that checks for the dataset mounted at "/" and that it looks capable of being a BE root (e.g. it's not a top-level dataset) bectl commands can now specify if they want to be silent, and this will turn off libbe_print_on_error so they can control the output as needed. This is already used in `bectl check`, and may be turned on in the future for some other commands where libbe errors are better suppressed as the failure mode may be obvious. Requested by: David Fullard MFC after: 3 days
2019-09-11 13:27:10 +00:00
.Cm check
.Xc
Performs a silent sanity check on the current system.
If boot environments are supported and used,
.Nm
will exit with a status code of 0.
Any other status code is not currently defined and may, in the future, grow
special meaning for different degrees of sanity check failures.
.It Xo
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm create
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Op Fl r
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot
.Ar newBeName
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Xc
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Create a new boot environment named
.Ar newBeName .
.Pp
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
If the
.Fl r
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
flag is given, a recursive boot environment will be made.
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Pp
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
If the
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Fl e
flag is specified, the new environment will be cloned from the given
.Ar nonActiveBe
or
.Ar beName Ns Cm @ Ns Ar snapshot .
Otherwise, the new environment will be created from the currently booted environment.
.Pp
If
.Nm
is creating from another boot environment, a snapshot of that boot environment will be created to clone from.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Xo
bectl(8): add description for create subcommand In commit r345845, a portion of documentation for the create subcommand was removed. Specifically, for creating a snapshot of an existing boot environment. bectl even has a test-case for this functionality. Removing the sub-command description was discussed in PR 235850. This patch brings back the second "create" description that was originally in place. Albeit, with a few wording/clarifying changes. Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: kevans MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20249
2019-05-22 23:07:40 +00:00
.Cm create
.Op Fl r
.Ar beName@snapshot
.Xc
Create a snapshot of the boot environment named
.Ar beName .
.Pp
If the
.Fl r
flag is given, a recursive snapshot of the boot environment will be created.
A snapshot is created for each descendant dataset of the boot environment.
.Pp
No new boot environment is created with this command.
.It Xo
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Cm destroy
bectl(8): Add -o flag to destroy to clean up the origin snapshot of BE We can't predict when destruction of origin is needed, and currently we have a precedent for not prompting for things. Leave the decision up to the user of bectl(8) if they want the origin snapshot to be destroyed or not. Emits a warning when -o isn't used and an origin snapshot is left to be cleaned up, for the time being. This is handy when one drops the -o flag but really did want to clean up the origin. A couple of -e ignore's have been sprinkled around the test suite for places that we don't care that the origin's not been cleaned up. -o functionality tests will be added in the future, but are omitted for now to reduce conflicts with work in flight to fix bits of the tests. Reported by: Shawn Webb MFC after: 1 week
2019-02-11 04:00:01 +00:00
.Op Fl \&Fo
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Ar beName Ns Op Cm @ Ns Ar snapshot
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Xc
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Destroy the given
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Ar beName
boot environment or
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Ar beName Ns Cm @ Ns Ar snapshot
libbe(3)/bectl(8): Make consistent with beadm vermaden (maintainer of beadm) points out the following inconsistencies: - "missing command" is not printed prior to usage if the error is simply a missing command; this should be obvious from the context - "bectl rename" isn't using the "don't unmount" flag (zfs rename -u), so the active BE can't be renamed. It doesn't make sense in our context to *not* use -u, so use it. Documentation updates reflect the above and note an inconsistency with the 'destroy' command that is consistent with other parts of the base system. A fix for libbe(3) not properly being installed to /lib is included. SHLIBDIR should have been added when it was moved in r337995. Approved by: re (kib)
2018-08-24 20:44:58 +00:00
snapshot without confirmation, unlike in
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr beadm 1 .
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
Specifying
.Fl F
will automatically unmount without confirmation.
bectl(8): Add -o flag to destroy to clean up the origin snapshot of BE We can't predict when destruction of origin is needed, and currently we have a precedent for not prompting for things. Leave the decision up to the user of bectl(8) if they want the origin snapshot to be destroyed or not. Emits a warning when -o isn't used and an origin snapshot is left to be cleaned up, for the time being. This is handy when one drops the -o flag but really did want to clean up the origin. A couple of -e ignore's have been sprinkled around the test suite for places that we don't care that the origin's not been cleaned up. -o functionality tests will be added in the future, but are omitted for now to reduce conflicts with work in flight to fix bits of the tests. Reported by: Shawn Webb MFC after: 1 week
2019-02-11 04:00:01 +00:00
.Pp
By default,
.Nm
will warn that it is not destroying the origin of
.Ar beName .
The
.Fl o
flag may be specified to destroy the origin as well.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Cm export Ar sourceBe
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
Export
.Ar sourceBe
to
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr stdout 4 .
.Xr stdout 4
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
must be piped or redirected to a file.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Cm import Ar targetBe
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
Import
.Ar targetBe
from
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr stdin 4 .
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Xo
.Cm jail
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Op Fl bU
.Oo Bro Fl o Ar key Ns Cm = Ns Ar value | Fl u Ar key Brc Oc Ns ...
.Ar beName
bectl(8): Allow running a custom command in the 'jail' subcommand Instead of always running /bin/sh, allow the user to specify the command to run. The jail is not removed when the command finishes. Meaning, `bectl unjail` will still need to be run. For example: ``` bectl jail newBE pkg upgrade bectl ujail newBE ``` Submitted by: Shawn Webb Obtained from: HardenedBSD (8b451014ab)
2018-08-18 01:12:44 +00:00
.Op Ar utility Op Ar argument ...
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Xc
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Create a jail of the given boot environment.
bectl(8): bectl jail improvements - Support passing arbitrary jail arguments via -o - Split the related (and rewritten since the GSoC) jail bits out into a new bectl_jail.c file, to reduce clutter in bectl.c - Don't use RFC 1918 IP space [0]; we'll instead set no default IPv4 and let the user pass in any address options they wish via -o Reported by: rgrimes [0], Shawn Webb [0]
2018-08-06 03:32:25 +00:00
Multiple
.Fl o
bectl(8): Provide -u option to unset jail parameters All but name, host.hostname, and path may be completely unset.
2018-08-06 15:21:46 +00:00
and
.Fl u
bectl(8): bectl jail improvements - Support passing arbitrary jail arguments via -o - Split the related (and rewritten since the GSoC) jail bits out into a new bectl_jail.c file, to reduce clutter in bectl.c - Don't use RFC 1918 IP space [0]; we'll instead set no default IPv4 and let the user pass in any address options they wish via -o Reported by: rgrimes [0], Shawn Webb [0]
2018-08-06 03:32:25 +00:00
arguments may be specified.
bectl(8): Provide -u option to unset jail parameters All but name, host.hostname, and path may be completely unset.
2018-08-06 15:21:46 +00:00
.Fl o
will set a jail parameter, and
.Fl u
will unset a jail parameter.
bectl(8): Allow running a custom command in the 'jail' subcommand Instead of always running /bin/sh, allow the user to specify the command to run. The jail is not removed when the command finishes. Meaning, `bectl unjail` will still need to be run. For example: ``` bectl jail newBE pkg upgrade bectl ujail newBE ``` Submitted by: Shawn Webb Obtained from: HardenedBSD (8b451014ab)
2018-08-18 01:12:44 +00:00
.Pp
By default, jails are created in interactive mode and
.Pa /bin/sh
is
bectl(8): Add batch mode to jail subcommand Adding batch mode to the jail `bectl(8)` subcommand enables jailing of ZFS Boot Environments in a scriptable fashion. Submitted by: Shawn Webb Obtained from: HardenedBSD (9e72d1c59a and ef7b6d9e1c with minor edit)
2018-08-17 01:59:19 +00:00
executed within the jail.
bectl(8): Allow running a custom command in the 'jail' subcommand Instead of always running /bin/sh, allow the user to specify the command to run. The jail is not removed when the command finishes. Meaning, `bectl unjail` will still need to be run. For example: ``` bectl jail newBE pkg upgrade bectl ujail newBE ``` Submitted by: Shawn Webb Obtained from: HardenedBSD (8b451014ab)
2018-08-18 01:12:44 +00:00
If
.Ar utility
is specified, it will be executed instead of
.Pa /bin/sh .
bectl(8): jail: Tear down jail by default after command exits Add a -U flag to get back the old behavior. The new behavior is a little more friendly to the common use cases, jail the BE and execute a script. Having the jail torn down automatically when the script is finished, or when you exit the shell, is a little more friendly than having to remember to `bectl ujail`. Batch mode (-b) will continue to leave the jail up, as it's assumed the caller has other intentions. Submitted by: Shawn Webb (partially)
2018-08-23 01:45:18 +00:00
The jail will be destroyed and the boot environment unmounted when the command
finishes executing, unless the
.Fl U
argument is specified.
bectl(8): Allow running a custom command in the 'jail' subcommand Instead of always running /bin/sh, allow the user to specify the command to run. The jail is not removed when the command finishes. Meaning, `bectl unjail` will still need to be run. For example: ``` bectl jail newBE pkg upgrade bectl ujail newBE ``` Submitted by: Shawn Webb Obtained from: HardenedBSD (8b451014ab)
2018-08-18 01:12:44 +00:00
.Pp
bectl(8): Add batch mode to jail subcommand Adding batch mode to the jail `bectl(8)` subcommand enables jailing of ZFS Boot Environments in a scriptable fashion. Submitted by: Shawn Webb Obtained from: HardenedBSD (9e72d1c59a and ef7b6d9e1c with minor edit)
2018-08-17 01:59:19 +00:00
The
.Fl b
argument enables batch mode, thereby disabling interactive mode.
bectl(8): jail: Tear down jail by default after command exits Add a -U flag to get back the old behavior. The new behavior is a little more friendly to the common use cases, jail the BE and execute a script. Having the jail torn down automatically when the script is finished, or when you exit the shell, is a little more friendly than having to remember to `bectl ujail`. Batch mode (-b) will continue to leave the jail up, as it's assumed the caller has other intentions. Submitted by: Shawn Webb (partially)
2018-08-23 01:45:18 +00:00
The
.Fl U
argument will be ignored in batch mode.
bectl(8): Provide -u option to unset jail parameters All but name, host.hostname, and path may be completely unset.
2018-08-06 15:21:46 +00:00
.Pp
The
.Va name ,
.Va host.hostname ,
and
.Va path
bectl: use jail id as the default jail name for a boot environment By default, bectl is setting the jail 'name' parameter to the boot environment name, which causes an error when the boot environment name is not a valid jail name. With the attached fix, when no name is supplied, the default jail name will be the jail id - this is is the same behavior as the jail command. Additionally, this commit addresses two other bugs that prevented unjailing in scenarios where the jail name does not match the boot environment name: 1. In 'bectl_locate_jail', 'mountpoint' is used to resolve the boot environment path, but really 'mounted' should be used. 'mountpoint' is the path where the zfs dataset will be mounted. 'mounted' is the path where the dataset is actually mounted. 2. in 'bectl_search_jail_paths', 'jail_getv' would fail after the first call. Which is fine, if the boot environment you're unjailing is the next one up. According to 'man jail_getv', it's expecting name and value strings. 'jail_getv' is being passed an integer for the lastjid, so amend that to use a string instead. Test cases have been amended to reflect the bugs found. PR: 233637 Submitted by: Rob <rob.fx907_gmail.com> MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D18607
2018-12-25 15:18:41 +00:00
must be set, the default values are specified below.
bectl(8): Provide -u option to unset jail parameters All but name, host.hostname, and path may be completely unset.
2018-08-06 15:21:46 +00:00
.Pp
All
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Ar key Ns Cm = Ns Ar value
bectl(8): bectl jail improvements - Support passing arbitrary jail arguments via -o - Split the related (and rewritten since the GSoC) jail bits out into a new bectl_jail.c file, to reduce clutter in bectl.c - Don't use RFC 1918 IP space [0]; we'll instead set no default IPv4 and let the user pass in any address options they wish via -o Reported by: rgrimes [0], Shawn Webb [0]
2018-08-06 03:32:25 +00:00
pairs are interpreted as jail parameters as described in
.Xr jail 8 .
The following default parameters are provided:
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Bl -column "allow.mount.devfs" ""
.It Va allow.mount Ta Cm true
.It Va allow.mount.devfs Ta Cm true
.It Va enforce_statfs Ta Cm 1
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.It Va name Ta Set to jail ID.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Va host.hostname Ta Va bootenv
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.It Va path Ta Set to a path in Pa /tmp
generated by
libbe(3)/bectl(8): Make igor and mandoc -Tlint a little happier
2018-08-11 01:40:24 +00:00
.Xr libbe 3 .
bectl(8): bectl jail improvements - Support passing arbitrary jail arguments via -o - Split the related (and rewritten since the GSoC) jail bits out into a new bectl_jail.c file, to reduce clutter in bectl.c - Don't use RFC 1918 IP space [0]; we'll instead set no default IPv4 and let the user pass in any address options they wish via -o Reported by: rgrimes [0], Shawn Webb [0]
2018-08-06 03:32:25 +00:00
.El
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Pp
bectl(8): Provide -u option to unset jail parameters All but name, host.hostname, and path may be completely unset.
2018-08-06 15:21:46 +00:00
All default parameters may be overwritten.
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.It Xo
.Cm list
bectl(8): sync man page and help text Sync man page with behavior of bectl(8). Sync help text with man page. PR: 246697 Reported by: olgeni Submitted by: olgeni (with changes) Reviewed by: kevans, olgeni Approved by: kevans (mentor) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D27482
2021-01-06 19:38:25 +00:00
.Op Fl aDHs
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.Oo Bro Fl c Ar property | Fl C Ar property Brc Oc
.Xc
.Pp
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Display all boot environments.
The
.Em Active
field indicates whether the boot environment is active now
.Pq Em \&N ;
active on reboot
.Pq Em \&R ;
loader: zfs should support bootonce an nextboot bootonce feature is temporary, one time boot, activated by "bectl activate -t BE", "bectl activate -T BE" will reset the bootonce flag. By default, the bootonce setting is reset on attempt to boot and the next boot will use previously active BE. By setting zfs_bootonce_activate="YES" in rc.conf, the bootonce BE will be set permanently active. bootonce dataset name is recorded in boot pool labels, bootenv area. in case of nextboot, the nextboot_enable boolean variable is recorded in freebsd:nvstore nvlist, also stored in boot pool label bootenv area. On boot, the loader will process /boot/nextboot.conf if nextboot_enable is "YES", and will set nextboot_enable to "NO", preventing /boot/nextboot.conf processing on next boot. bootonce and nextboot features are usable in both UEFI and BIOS boot. To use bootonce/nextboot features, the boot loader needs to be updated on disk; if loader.efi is stored on ESP, then ESP needs to be updated and for BIOS boot, stage2 (zfsboot or gptzfsboot) needs to be updated (gpart or other tools). At this time, only lua loader is updated. Sponsored by: Netflix, Klara Inc. Differential Revision: https://reviews.freebsd.org/D25512
2020-09-21 09:01:10 +00:00
is used on next boot once
.Pq Em \&T ;
or combination of
.Pq Em \&NRT .
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Pp
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.Bl -tag -width indent
.It Fl a
Display all datasets.
.It Fl D
Display the full space usage for each boot environment, assuming all
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
other boot environments were destroyed.
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.It Fl H
Used for scripting.
Do not print headers and separate fields by a single tab instead of
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
arbitrary white space.
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
.It Fl s
Display all snapshots as well.
.It Fl c Ar property
Sort boot environments by given property name.
The following properties are supported:
.Pp
.Bl -tag -width 4n -offset indent -compact
.It name (default output)
.It creation
.It origin
.It used
.It usedds
.It usedsnap
.It usedrefreserv
.El
.It Fl C Ar property
Same as the
.Fl c
option, but displays in descending order.
.El
.Pp
The
.Fl D
option is ignored when either the
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Fl s
bectl(8): implement sorting for 'bectl list' output Allow 'bectl list' to sort output by a given property name. The property name is passed in using a command-line flag, '-c' for ascending order and '-C' for descending order. The properties allowed to sort by are: - name (the default output, even if '-c' or '-C' are not used) - creation - origin - used - usedds - usedsnap - usedrefreserv The default output for 'bectl list' is now ascending alphabetical order of BE name. To sort by creation time from earliest to latest, the command would be 'bectl list -c creation' Submitted by: Rob Fairbanks <rob.fx907 gmail com> Reviewed by: ler MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D20818
2019-09-04 13:59:06 +00:00
or
.Fl a
option is used.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Cm mount Ar beName Op Ar mountpoint
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
Temporarily mount the boot environment.
Mount at the specified
.Ar mountpoint
if provided.
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Cm rename Ar origBeName newBeName
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Rename the given
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Ar origBeName
to the given
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Ar newBeName .
libbe(3)/bectl(8): Make consistent with beadm vermaden (maintainer of beadm) points out the following inconsistencies: - "missing command" is not printed prior to usage if the error is simply a missing command; this should be obvious from the context - "bectl rename" isn't using the "don't unmount" flag (zfs rename -u), so the active BE can't be renamed. It doesn't make sense in our context to *not* use -u, so use it. Documentation updates reflect the above and note an inconsistency with the 'destroy' command that is consistent with other parts of the base system. A fix for libbe(3) not properly being installed to /lib is included. SHLIBDIR should have been added when it was moved in r337995. Approved by: re (kib)
2018-08-24 20:44:58 +00:00
The boot environment will not be unmounted in order for this rename to occur.
bectl(8): sync man page and help text Sync man page with behavior of bectl(8). Sync help text with man page. PR: 246697 Reported by: olgeni Submitted by: olgeni (with changes) Reviewed by: kevans, olgeni Approved by: kevans (mentor) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D27482
2021-01-06 19:38:25 +00:00
.It Cm ujail Brq Ar jailId | jailName | beName
.It Cm unjail Brq Ar jailId | jailName | beName
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
Destroy the jail created from the given boot environment.
.It Xo
.Cm umount
.Op Fl f
.Ar beName
.Xc
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.It Xo
.Cm unmount
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Op Fl f
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Ar beName
.Xc
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
Unmount the given boot environment, if it is mounted.
Specifying
.Fl f
will force the unmount if busy.
.El
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Pp
.Nm
prints usage information if
.Fl h
or
.Fl \&?
is specified.
Comment out TODO notes from bectl(8) manual page MFC after: 2 days
2020-08-17 08:43:36 +00:00
\" .Sh EXAMPLES
\" .Bl -bullet
\" .It
\" To fill in with jail upgrade example when behavior is firm.
\" .El
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Sh SEE ALSO
Cross-reference libbe(3) and bectl(8). Those two manual pages are already referencing each other in the HISTORY sections, which people might skip. Mention those manual pages explicitly in the SEE ALSO sections. Also, remove a reference to be(1) from libbe(3). Reviewed by: bcr Approved by: krion (mentor, implicit), mat (mentor, implicit) Differential Revision: https://reviews.freebsd.org/D18136
2018-11-21 12:46:28 +00:00
.Xr libbe 3 ,
bectl.8: correctly sort SEE ALSO section after 360078 Reported by: yuripv MFC after: 2 weeks MFC with: 360078
2020-04-19 01:43:59 +00:00
.Xr beinstall.sh 8 ,
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Xr jail 8 ,
.Xr zfs 8 ,
.Xr zpool 8
.Sh HISTORY
.Nm
is based on
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr beadm 1
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
and was implemented as a project for the 2017 Summer of Code, along with
.Xr libbe 3 .
.Sh AUTHORS
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
.Nm
was written by
.An Kyle Kneitinger (kneitinger) Aq Mt kyle@kneit.in .
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Pp
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr beadm 1
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
was written and is maintained by
.An Slawomir Wojciech Wojtczak (vermaden) Aq Mt vermaden@interia.pl .
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
.Pp
bectl(8): Document export/import
2018-08-11 04:01:24 +00:00
.An Bryan Drewery (bdrewery) Aq Mt bryan@shatow.net
bectl(8): Man page and usage cleanup - Some overly-long lines - Consistently using .Brq ({}) - Consistently using .Cm - Not using .Ao/.Ac around .Ar PR: 230576 Submitted by: Yuri Pankov (with a fair amount of rebasing pre-commit)
2018-08-23 02:09:52 +00:00
wrote the original
bectl.8: Clean up & clarify the create subcommand - Improve formatting - Use consistent variable names - Improve the description of the create subcommand (1) PR: 235850 (1) Submitted by: kevans (1) Reported by: ler (1) Reviewed by: kevans Approved by: src (kevans) Differential Revision: https://reviews.freebsd.org/D19666
2019-04-03 13:46:43 +00:00
.Xr beadm 1
Import libbe(3)/be(1) from socsvn/soc2017/kneitinger/libbe-head
2018-07-24 13:17:40 +00:00
manual page that this one is derived from.
Reference in New Issue Copy Permalink