Merge pull request #7 from bdrewery/update-manpage

Update manpage
This commit is contained in:
vermaden 2012-05-14 22:07:10 -07:00
commit 3664586858
1 changed files with 19 additions and 7 deletions

20
beadm.1
View File

@ -40,13 +40,17 @@ destroy
.Ao Ar beName@snapshot Ac .Ao Ar beName@snapshot Ac
.Nm .Nm
list list
.Nm
rename
.Ao Ar origBeName Ac
.Ao Ar newBeName Ac
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
command is used to setup and interact with Boot Environments with ZFS. command is used to setup and interact with Boot Environments with ZFS.
.Pp .Pp
.Em Boot Environments .Em Boot Environments
allow you to upgrade your system, while preserving your old environment in a separate ZFS dataset. allows the system to be upgraded, while preserving the old system environment in a separate ZFS dataset.
.Pp .Pp
.Sh COMMANDS .Sh COMMANDS
The following commands are supported by The following commands are supported by
@ -88,6 +92,13 @@ snapshot.
.Pp .Pp
Displays all boot environments. Displays all boot environments.
.Pp .Pp
.It Ic rename Ao Ar origBeName Ac Ao Ar newBeName Ac
.Pp
Renames the given
.Ar origBeName
to the given
.Ar newBeName
.Pp
.El .El
.Sh EXAMPLES .Sh EXAMPLES
.Bl -bullet .Bl -bullet
@ -105,8 +116,9 @@ Set mountpoint for new jail to
.Pp .Pp
.Dl zfs set mountpoint=/usr/jails/jailed zroot/ROOT/jailed .Dl zfs set mountpoint=/usr/jails/jailed zroot/ROOT/jailed
.Pp .Pp
Your current boot environment is now replicated into the jailed system. The currently active boot environment is now replicated into the jailed system and ready for upgrade.
Startup the jail, login and perform the normal upgrade process. Once this is done, stop the jail and disable it in Startup the jail, login and perform the normal upgrade process.
Once this is done, stop the jail and disable it in
.Pa /etc/rc.conf. .Pa /etc/rc.conf.
.Pp .Pp
Now activate the boot environment for the next boot Now activate the boot environment for the next boot
@ -134,4 +146,4 @@ originally appeared in Solaris.
.Sh AUTHORS .Sh AUTHORS
.An Slawomir Wojciech Wojtczak (vermaden) Aq vermaden@interia.pl .An Slawomir Wojciech Wojtczak (vermaden) Aq vermaden@interia.pl
.An Bryan Drewery Aq bryan@shatow.net .An Bryan Drewery Aq bryan@shatow.net
Wrote the initial manual page, mostly from forum post. wrote this manual page and contributed child dataset fixes