Skip to content

Commit

Permalink
Manpage fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bsdlme committed May 26, 2016
1 parent 058a8dd commit a13b1f9
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions iohyve.8
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" Text automatically generated by txt2man
.TH iohyve 8 "30 April 2016" "" "FreeBSD System Manager's Manual"
.TH iohyve 8 "30 May 2016" "" "FreeBSD System Manager's Manual"
.SH NAME
\fBiohyve(8) \fP- bhyve manager/launcher v0.7.5 "Tennessee Cherry Moonshine Edition"
\fBiohyve\fP- bhyve manager/launcher
\fB
.SH SYNOPSIS
.nf
Expand Down Expand Up @@ -57,7 +57,7 @@
.fam T
.fi
.SH DESCRIPTION
The \fBiohyve\fP(8) shell script utilizes the FreeBSD hypervisor \fBbhyve\fP(8),
The \fBiohyve\fP shell script utilizes the FreeBSD hypervisor \fBbhyve\fP(8),
\fBzfs\fP(8), and \fBnmdm\fP(4) to make virtualization on FreeBSD easy and simple.
The basic idea is to store bhyve settings in zfs user properties of zfs
datasets that house important guest files like block devices and grub
Expand All @@ -70,7 +70,7 @@ kernel for virtualization.
.TP
.B
\fIversion\fP
Prints the current running \fIversion\fP of \fBiohyve\fP
Prints the current running \fIversion\fP of \fBiohyve\fP.
.TP
.B
\fIsetup\fP
Expand Down Expand Up @@ -111,7 +111,7 @@ Running, and rcboot.
\fB-l\fP is for less and pipes the final output to less.
.PP
Order of flags is not important. The proper syntax is to use
the flags contiguiously. So "\fB-ld\fP" is the correct way to display
the flags contiguously. So "\fB-ld\fP" is the correct way to display
the base output plus description, and then have the output
piped to less.
.RE
Expand Down Expand Up @@ -140,14 +140,14 @@ ISO file on the host machine.
.TP
.B
\fIrenameiso\fP
Renames an ISO
Renames an ISO.
Usage: '\fBiohyve\fP \fIrenameiso\fP <ISO> <newname>' where <ISO> is the
name of the ISO you would like to \fIrename\fP. <newname>
is a new name.
.TP
.B
\fIrmiso\fP
Removes installed ISO from /\fBiohyve\fP/ISO
Removes installed ISO from /\fBiohyve\fP/ISO.
Usage: '\fBiohyve\fP \fIrmiso\fP <ISO>' where <ISO> is the name of the ISO
you would like to \fIdelete\fP.
.TP
Expand All @@ -165,14 +165,14 @@ firmware file on the host machine.
.TP
.B
\fIrenamefw\fP
Renames a Firmware
Renames a firmware.
Usage: '\fBiohyve\fP \fIrenamefw\fP <firmware> <newname>' where <firmware>
is the name of the firmware you would like to \fIrename\fP.
<newname> is a new name.
.TP
.B
\fIrmfw\fP
Removes installed firmware from /\fBiohyve\fP/Firmware
Removes installed firmware from /\fBiohyve\fP/Firmware.
Usage: '\fBiohyve\fP \fIrmfw\fP <firmware>' where <firmware> is the name of
the firmware you would like to \fIdelete\fP.
.TP
Expand All @@ -190,14 +190,14 @@ gets added on that \fIpool\fP.
Loads and boots into ISO for guest installation.
Usage: '\fBiohyve\fP \fIinstall\fP <name> <ISO>' where <name> is the name
of the guest, and [ISO] is the name of the ISO you would
like to \fIboot\fP from in the form of: 'instal.iso'
like to \fIboot\fP from in the form of: 'install.iso'
.TP
.B
\fIload\fP
Loads the guest operating system bootloader and resources.
Usage: '\fBiohyve\fP \fIload\fP <name> <ISO>'
where [name]is the name of the guest operating system.
[bootimg] is the path to the \fIboot\fP medium
where <name> is the name of the guest operating system.
<ISO> is the path to the \fIboot\fP medium
.TP
.B
\fIboot\fP
Expand Down Expand Up @@ -248,11 +248,11 @@ Gracefully \fIstop\fP all bhyve guests. Does not \fIdestroy\fP resources.
Destroys guest resources.
Usage: '\fBiohyve\fP \fIdestroy\fP <name>' where <name> is the name
of the guest operating system. Destroying a guest does
not [\fIdelete\fP] a guest from the host, it destroys the guest in VMM.
not \fIdelete\fP a guest from the host, it destroys the guest in VMM.
.TP
.B
\fIrename\fP
Renames the guest
Renames the guest.
Usage: '\fBiohyve\fP \fIrename\fP <name> <newname>' where <name> is the
name of the guest and <newname> is the new name.
.TP
Expand All @@ -265,17 +265,17 @@ of the guest operating system. If [\fB-f\fP] is supplied before the
.TP
.B
\fIset\fP
Sets ZFS properties for guests one at a time
Sets ZFS properties for guests one at a time.
Usage: '\fBiohyve\fP \fIset\fP <name> <property=value> \.\.\.' where
<name> is the name of the guest operating system.
Properties:
ram=512M or ram=2G (M for megabytes, G for gigabtyes)
cpu=1 (number of cpu cores)
con=nmdm0 (where to attach null modem \fIconsole\fP)
tap=tap[n](,tap[n]) (tap device for virtio-net)
[n] is a generic number to specify the tap interface to use
Specify a \fIlist\fP o tap separated by comma for multiple tap
Single tap: \fBiohyve\fP \fIset\fP [name] tap=tap0
[n] is a generic number to specify the tap interface to use.
Specify a \fIlist\fP of tap devices separated by comma for multiple tap
Single tap: \fBiohyve\fP \fIset\fP [name] tap=tap0.
Multiple tap : \fBiohyve\fP \fIset\fP [name] tap=tap0,tap1,tap2,tap3
size=size of block device
mac_tap[n]=[MAC Address]
Expand All @@ -295,22 +295,22 @@ Examples: "pcidev:1=passthru,2/0/0"
.TP
.B
\fIget\fP
Gets ZFS properties for guests one at a time
Gets ZFS properties for guests one at a time.
Usage: '\fBiohyve\fP \fIget\fP <name> <prop>' where <name> is the name
of the guest operating system. <prop> is the
property you want to view. (See '\fBiohyve\fP \fIset\fP' \fIinfo\fP)
.TP
.B
\fIrmpci\fP
Removes a pcidev from the guest
Removes a pcidev from the guest.
Usage: '\fBiohyve\fP \fIrmpci\fP <name> <pcidev:N>' where <name> is the name
of the guest operating system. <pcidev:N> is the PCI
device you want removed. Ex: 'pcidev:3' If [\fB-f\fP] is supplied
before the <name>, there is no prompt to \fIremove\fP.
.TP
.B
\fIgetall\fP
Gets all the ZFS properties for a guest
Gets all the ZFS properties for a guest.
Usage: '\fBiohyve\fP \fIgetall\fP <name>' where <name> is the name
of the guest operating system.
.TP
Expand Down Expand Up @@ -394,7 +394,7 @@ This will \fIlist\fP taps that are not active as well.
.TP
.B
\fIactivetaps\fP
Lists all active taps in use
Lists all active taps in use.
.TP
.B
\fIconlist\fP
Expand Down Expand Up @@ -471,7 +471,7 @@ List all guests that have resources allocated using:
.PP
List all runnng guests using:
.PP
iohvye running
\fBiohvye\fP running
.PP
You can change guest properties by using \fIset\fP:
.PP
Expand Down

0 comments on commit a13b1f9

Please sign in to comment.