Merge pull request #9 from bdrewery/update-manpage

Update manpage
This commit is contained in:
vermaden 2012-06-26 22:48:39 -07:00
commit 30da27e5de
1 changed files with 44 additions and 12 deletions

56
beadm.1
View File

@ -15,7 +15,7 @@
.\" @(#)beadm.1 .\" @(#)beadm.1
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd April 26, 2012 .Dd June 26, 2012
.Dt BEADM 1 .Dt BEADM 1
.Os FreeBSD .Os FreeBSD
.Sh NAME .Sh NAME
@ -27,23 +27,31 @@ activate
.Ao Ar beName Ac .Ao Ar beName Ac
.Nm .Nm
create create
.Op Fl e Ar nonActiveBe | Ar beName@snapshot .Op Fl e Ar nonActiveBe | Fl e Ar beName@snapshot
.Ao Ar beName Ac .Ao Ar beName Ac
.Nm .Nm
create create
.Ao Ar beName@snapshot Ac .Ao Ar beName@snapshot Ac
.Nm .Nm
destroy destroy
.Ao Ar beName Ac .Op Fl F
.Nm .Ao Ar beName | beName@snapshot Ac
destroy
.Ao Ar beName@snapshot Ac
.Nm .Nm
list list
.Nm .Nm
mount
.Nm
mount
.Ao Ar beName Ac
.Op mountpoint
.Nm
rename rename
.Ao Ar origBeName Ac .Ao Ar origBeName Ac
.Ao Ar newBeName Ac .Ao Ar newBeName Ac
.Nm
{ umount | unmount }
.Op Fl f
.Ao Ar beName Ac
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
@ -63,7 +71,7 @@ Activate the given
for the next boot. for the next boot.
.Pp .Pp
.It Ic create .It Ic create
.Op Fl e Ar nonActiveBe | Ar beName@snapshot .Op Fl e Ar nonActiveBe | Fl e Ar beName@snapshot
.Ao Ar beName Ac .Ao Ar beName Ac
.Pp .Pp
Creates a new boot environment named Creates a new boot environment named
@ -77,20 +85,35 @@ If the -e param is specified, the new environment will be cloned from the given
Creates a snapshot of the existing boot environment named Creates a snapshot of the existing boot environment named
.Ar beName . .Ar beName .
.Pp .Pp
.It Ic destroy Ao Ar beName Ac .It
.Ic destroy Op Fl F
.Ao Ar beName | beName@snapshot Ac
.Pp .Pp
Destroys the given Destroys the given
.Ar beName .Ar beName
boot environment. boot environment or
.It Ic destroy Ao Ar beName@snapshot Ac
.Pp
Destroys the given
.Ar beName@snapshot .Ar beName@snapshot
snapshot. snapshot.
Specifying
.Fl F
will automatically unmount without confirmation.
.Pp .Pp
.It Ic list .It Ic list
.Pp .Pp
Displays all boot environments. Displays all boot environments.
.PP
.It Ic mount
.Pp
List all mounted datasets for the current boot environment.
.Pp
.It Ic mount
.Ao Ar beName Ac
.Op mountpoint
.Pp
Temporarily mount the boot environment.
Mount at the specified
.Ar mountpoint
if provided.
.Pp .Pp
.It Ic rename Ao Ar origBeName Ac Ao Ar newBeName Ac .It Ic rename Ao Ar origBeName Ac Ao Ar newBeName Ac
.Pp .Pp
@ -99,6 +122,15 @@ Renames the given nonactive
to the given to the given
.Ar newBeName .Ar newBeName
.Pp .Pp
.It Ic umount
.Op Fl f
.Ao Ar beName Ac
.Pp
Unmount the given boot environment, if it is mounted.
Specifying
.Fl f
will force the unmount if busy.
.Pp
.El .El
.Sh EXAMPLES .Sh EXAMPLES
.Bl -bullet .Bl -bullet