diff options
Diffstat (limited to 'lib/libbe/libbe.3')
-rw-r--r-- | lib/libbe/libbe.3 | 81 |
1 files changed, 43 insertions, 38 deletions
diff --git a/lib/libbe/libbe.3 b/lib/libbe/libbe.3 index 7d7f646c27ab..c7ae23768fb4 100644 --- a/lib/libbe/libbe.3 +++ b/lib/libbe/libbe.3 @@ -25,11 +25,6 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" This manual page is based on the mp(3X) manual page from Sun Release -.\" 4.1, dated 7 September 1989. It's an old, crufty, and relatively ugly -.\" manual page, but it does document what appears to be the "traditional" -.\" libmp interface. -.\" .\" $FreeBSD$ .\" .Dd August 10, 2018 @@ -37,16 +32,19 @@ .Os .Sh NAME .Nm libbe -.Nd library for creating, destroying and modifying ZFS boot environments. +.Nd library for creating, destroying and modifying ZFS boot environments +.Sh LIBRARY +.Lb be .Sh SYNOPSIS .In be.h .Pp -Function prototypes are given in the main body of the text. +Function prototypes are given in the +.Sx FUNCTION OVERVIEW +section. .Pp Applications using this interface must be linked with .Fl l Ns Ar be .Sh DESCRIPTION -.Pp .Nm interfaces with libzfs to provide a set of functions for various operations regarding ZFS boot environments including "deep" boot environments in which @@ -55,43 +53,51 @@ a boot environments has child datasets. A context structure is passed to each function, allowing for a small amount of state to be retained, such as errors from previous operations. .\" TODO: describe break on err functionality -.Pp +.Sh FUNCTION OVERVIEW .Ft "libbe_handle_t *" Ns -.Fn libbe_init "void" ; +.Fn libbe_init void ; .Pp .Ft void .Fn libbe_close "libbe_handle_t *" ; .Pp -.Ft "const char *" Ns +.Ft const char * Ns .Fn be_active_name "libbe_handle_t *" ; .Pp -.Ft "const char *" Ns +.Ft const char * Ns .Fn be_active_path "libbe_handle_t *" ; .Pp -.Ft "const char *" Ns +.Ft const char * Ns +.Fn be_nextboot_name "libbe_handle_t *" ; +.Pp +.Ft const char * Ns +.Fn be_nextboot_path "libbe_handle_t *" ; +.Pp +.Ft const char * Ns .Fn be_root_path "libbe_handle_t *" ; .Pp -.Ft "nvlist_t *" Ns -.Fn libbe_handle_t "libbe_handle_t " ; +.Ft int +.Fn be_create "libbe_handle_t *" "const char *" ; .Pp .Ft int -.Fn be_create "libbe_handle_t *, const char *" ; +.Fn be_create_from_existing "libbe_handle_t *" "const char *" "const char *" ; .Pp .Ft int -.Fn be_create_from_existing "libbe_handle_t *, const char *, const char *" ; +.Fn be_create_from_existing_snap "libbe_handle_t *" "const char *" "const char *" ; .Pp .Ft int -.Fn be_rename "libbe_handle_t *, const char *, const char *" ; +.Fn be_rename "libbe_handle_t *" "const char *" "const char *" ; .Pp +.Ft int +.Fn be_activate "libbe_handle_t *" "const char *" "bool" ; .\" TODO: Write up of destroy options .\" typedef enum { .\" BE_DESTROY_FORCE = 1 << 0, .\" } be_destroy_opt_t; .Ft int -.Fn be_destroy "libbe_handle_t *, const char *, int" ; +.Fn be_destroy "libbe_handle_t *" "const char *" "int" ; .Pp .Ft void -.Fn be_nicenum "uint64_t, char *, size_t" ; +.Fn be_nicenum uint64_t" "char *" "size_t" ; .Pp .\" TODO: Write up of mount options .\" typedef enum { @@ -99,52 +105,52 @@ of state to be retained, such as errors from previous operations. .\" BE_MNT_DEEP = 1 << 1, .\" } be_mount_opt_t; .Ft int -.Fn be_mount "libbe_handle_t *, char *, char *, int" ; +.Fn be_mount "libbe_handle_t *" "char *" "char *" "int" ; .Pp .Ft int -.Fn be_mounted_at "libbe_handle_t *, const char *, nvlist_t" ; +.Fn be_mounted_at "libbe_handle_t *" "const char *" "nvlist_t" ; .Pp .Ft int -.Fn be_unmount "libbe_handle_t *, char *, int" ; +.Fn be_unmount "libbe_handle_t *" "char *" "int" ; .Pp .Ft int .Fn libbe_errno "libbe_handle_t *" ; .Pp -.Ft "const char *" Ns +.Ft const char * Ns .Fn libbe_error_description "libbe_handle_t *" ; .Pp .Ft void -.Fn libbe_print_on_error "libbe_handle_t *, bool" ; +.Fn libbe_print_on_error "libbe_handle_t *" "bool" ; .Pp .Ft int -.Fn be_root_concat "libbe_handle_t *, const char *, char *" ; +.Fn be_root_concat "libbe_handle_t *" "const char *" "char *" ; .Pp .Ft int -.Fn be_validate_name "libbe_handle_t *, const char *" ; +.Fn be_validate_name "libbe_handle_t *" "const char *" ; .Pp .Ft int -.Fn be_validate_snap "libbe_handle_t *, const char *" ; +.Fn be_validate_snap "libbe_handle_t *" "const char *" ; .Pp .Ft bool -.Fn be_exists "libbe_handle_t *, char *" ; +.Fn be_exists "libbe_handle_t *" "char *" ; .Pp .Ft int -.Fn be_export "libbe_handle_t *, const char *, int fd" ; +.Fn be_export "libbe_handle_t *" "const char *" "int fd" ; .Pp .Ft int -.Fn be_import "libbe_handle_t *, const char *, int fd" ; +.Fn be_import "libbe_handle_t *" "const char *" "int fd" ; .Pp .Ft int .Fn be_prop_list_alloc "nvlist_t **" ; .Pp .Ft int -.Fn be_get_bootenv_props "libbe_handle_t *, nvlist_t *" ; +.Fn be_get_bootenv_props "libbe_handle_t *" "nvlist_t *" ; .Pp .Ft int -.Fn be_get_dataset_props "libbe_handle_t *, const char *, nvlist_t *" ; +.Fn be_get_dataset_props "libbe_handle_t *" "const char *" "nvlist_t *" ; .Pp .Ft int -.Fn be_get_dataset_snapshots "libbe_handle_t *, const char *, nvlist_t *" ; +.Fn be_get_dataset_snapshots "libbe_handle_t *" "const char *" "nvlist_t *" ; .Pp .Ft void .Fn be_prop_list_free "nvlist_t *" ; @@ -174,13 +180,12 @@ BE_ERR_NOMEM, BE_ERR_UNKNOWN .Ed .Sh SEE ALSO -.Xr be 1 , +.Xr be 1 .Sh HISTORY .Nm -and it's corresponding command, -.Xr be 3 , +and its corresponding command, +.Xr bectl 8 , were written as a 2017 Google Summer of Code project with Allan Jude serving as a mentor. .\" TODO: update when implementation complete. .\" .Sh BUGS - |