aboutsummaryrefslogtreecommitdiff
path: root/lib/libbe/libbe.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libbe/libbe.3')
-rw-r--r--lib/libbe/libbe.317
1 files changed, 16 insertions, 1 deletions
diff --git a/lib/libbe/libbe.3 b/lib/libbe/libbe.3
index fe2ddaaf1819..8a63fd52d2ca 100644
--- a/lib/libbe/libbe.3
+++ b/lib/libbe/libbe.3
@@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd April 22, 2019
+.Dd October 16, 2019
.Dt LIBBE 3
.Os
.Sh NAME
@@ -59,6 +59,9 @@
.Ft const char * Ns
.Fn be_root_path "libbe_handle_t *hdl"
.Pp
+.Ft bool Ns
+.Fn be_is_auto_snapshot_name "libbe_handle_t *hdl" "const char *snap"
+.Pp
.Ft int
.Fn be_create "libbe_handle_t *hdl" "const char *be_name"
.Pp
@@ -214,6 +217,18 @@ The
function returns the boot environment root path.
.Pp
The
+.Fn be_is_auto_snapshot_name
+function is used to determine if the given snapshot name matches the format that
+the
+.Fn be_snapshot
+function will use by default if it is not given a snapshot name to use.
+It returns
+.Dv true
+if the name matches the format, and
+.Dv false
+if it does not.
+.Pp
+The
.Fn be_create
function creates a boot environment with the given name.
The new boot environment will be created from a recursive snapshot of the