mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-24 11:29:10 +00:00
Code Issues Releases Activity

libbe(3): Bring man page back into reality

Browse Source
This commit is contained in:
Kyle Evans 2018-08-11 01:05:44 +00:00
parent 3d1a1f2caf
commit 11f2a12350
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/projects/bectl/; revision=337597
1 changed files with 8 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
lib/libbe/libbe.3
View File

@ -32,7 +32,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd August 6, 2018 .Dd August 10, 2018
.Dt LIBBE 3 .Dt LIBBE 3
.Os .Os
.Sh NAME .Sh NAME
@ -75,20 +75,20 @@ of state to be retained, such as errors from previous operations.
.Fn libbe_handle_t "libbe_handle_t " ; .Fn libbe_handle_t "libbe_handle_t " ;
.Pp .Pp
.Ft int .Ft int
.Fn be_create "libbe_handle_t *, char *" ; .Fn be_create "libbe_handle_t *, const char *" ;
.Pp .Pp
.Ft int .Ft int
.Fn be_create_from_existing "libbe_handle_t *, const char *, const char *" ; .Fn be_create_from_existing "libbe_handle_t *, const char *, const char *" ;
.Pp .Pp
.Ft int .Ft int
.Fn be_rename "libbe_handle_t *, char *, char *" ; .Fn be_rename "libbe_handle_t *, const char *, const char *" ;
.Pp .Pp
.\" TODO: Write up of destroy options .\" TODO: Write up of destroy options
.\" typedef enum { .\" typedef enum {
.\" BE_DESTROY_FORCE = 1 << 0, .\" BE_DESTROY_FORCE = 1 << 0,
.\" } be_destroy_opt_t; .\" } be_destroy_opt_t;
.Ft int .Ft int
.Fn be_destroy "libbe_handle_t *, char *, int" ; .Fn be_destroy "libbe_handle_t *, const char *, int" ;
.Pp .Pp
.Ft void .Ft void
.Fn be_nicenum "uint64_t, char *, size_t" ; .Fn be_nicenum "uint64_t, char *, size_t" ;
@ -129,13 +129,10 @@ of state to be retained, such as errors from previous operations.
.Fn be_exists "libbe_handle_t *, char *" ; .Fn be_exists "libbe_handle_t *, char *" ;
.Pp .Pp
.Ft int .Ft int
.Fn be_export "libbe_handle_t *, char *, int fd" ; .Fn be_export "libbe_handle_t *, const char *, int fd" ;
.Pp .Pp
.Ft int .Ft int
.Fn be_import "libbe_handle_t *, char *, int fd" ; .Fn be_import "libbe_handle_t *, const char *, int fd" ;
.Pp
.Ft int
.Fn be_add_child "libbe_handle_t *, char *, bool" ;
.Pp .Pp
.Ft int .Ft int
.Fn be_prop_list_alloc "nvlist_t **" ; .Fn be_prop_list_alloc "nvlist_t **" ;
@ -151,36 +148,6 @@ of state to be retained, such as errors from previous operations.
.Pp .Pp
.Ft void .Ft void
.Fn be_prop_list_free "nvlist_t *" ; .Fn be_prop_list_free "nvlist_t *" ;
.\" .Ft void
.\" .Fn mp_mfree "MINT *mp" ;
.\" .Bd -ragged -offset indent
.\" .Fn mp_itom
.\" returns an
.\" .Vt MINT
.\" with the value of
.\" .Fa n .
.\" .Fn mp_xtom
.\" returns an
.\" .Vt MINT
.\" with the value of
.\" .Fa s ,
.\" which is treated to be in hexadecimal.
.\" The return values from
.\" .Fn mp_itom
.\" and
.\" .Fn mp_xtom
.\" must be released with
.\" .Fn mp_mfree
.\" when they are no longer needed.
.\" .Fn mp_mtox
.\" returns a null-terminated hexadecimal string having the value of
.\" .Fa mp ;
.\" its return value must be released with
.\" .Fn free
.\" .Pq Xr free 3
.\" when it is no longer needed.
.\" .Ed
.\" .Pp
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
Upon error, one of the following values will be returned. Upon error, one of the following values will be returned.
.\" TODO: make each entry on its own line. .\" TODO: make each entry on its own line.
@ -202,6 +169,8 @@ BE_ERR_NOMOUNT,
BE_ERR_ZFSOPEN, BE_ERR_ZFSOPEN,
BE_ERR_ZFSCLONE, BE_ERR_ZFSCLONE,
BE_ERR_IO, BE_ERR_IO,
BE_ERR_NOPOOL,
BE_ERR_NOMEM,
BE_ERR_UNKNOWN BE_ERR_UNKNOWN
.Ed .Ed
.Sh SEE ALSO .Sh SEE ALSO