Index: head/usr.bin/man/man.1
===================================================================
--- head/usr.bin/man/man.1	(revision 274719)
+++ head/usr.bin/man/man.1	(revision 274720)
@@ -1,356 +1,365 @@
 .\"-
 .\"  Copyright (c) 2010 Gordon Tetlow
 .\"  All rights reserved.
 .\"
 .\"  Redistribution and use in source and binary forms, with or without
 .\"  modification, are permitted provided that the following conditions
 .\"  are met:
 .\"  1. Redistributions of source code must retain the above copyright
 .\"     notice, this list of conditions and the following disclaimer.
 .\"  2. Redistributions in binary form must reproduce the above copyright
 .\"     notice, this list of conditions and the following disclaimer in the
 .\"     documentation and/or other materials provided with the distribution.
 .\"
 .\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 .\"  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 .\"  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 .\"  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 .\"  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 .\"  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 .\"  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 .\"  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 .\"  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 .\"  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\"  SUCH DAMAGE.
 .\"
 .\" $FreeBSD$
 .\"
 .Dd September 26, 2014
 .Dt MAN 1
 .Os
 .Sh NAME
 .Nm man
 .Nd display online manual documentation pages
 .Sh SYNOPSIS
 .Nm
 .Op Fl adho
 .Op Fl t | w
 .Op Fl M Ar manpath
 .Op Fl P Ar pager
 .Op Fl S Ar mansect
 .Op Fl m Ar arch Ns Op : Ns Ar machine
 .Op Fl p Op Ar eprtv
 .Op Ar mansect
 .Ar page ...
 .Nm
 .Fl f
 .Ar keyword ...
 .Nm
 .Fl k
 .Ar keyword ...
 .Sh DESCRIPTION
 The
 .Nm
 utility finds and displays online manual documentation pages.
 If
 .Ar mansect
 is provided,
 .Nm
 restricts the search to the specific section of the manual.
 .Pp
 The sections of the manual are:
 .Bl -enum -offset indent -compact
 .It
-.Fx General Commands Manual
+.Fx
+General Commands Manual
 .It
-.Fx System Calls Manual
+.Fx
+System Calls Manual
 .It
-.Fx Library Functions Manual
+.Fx
+Library Functions Manual
 .It
-.Fx Kernel Interfaces Manual
+.Fx
+Kernel Interfaces Manual
 .It
-.Fx File Formats Manual
+.Fx
+File Formats Manual
 .It
-.Fx Games Manual
+.Fx
+Games Manual
 .It
-.Fx Miscellaneous Information Manual
+.Fx
+Miscellaneous Information Manual
 .It
-.Fx System Manager's Manual
+.Fx
+System Manager's Manual
 .It
-.Fx Kernel Developer's Manual
+.Fx
+Kernel Developer's Manual
 .El
 .Pp
 Options that
 .Nm
 understands:
 .Bl -tag -width indent
 .It Fl M Ar manpath
 Forces a specific colon separated manual path instead of the default
 search path.
 See
 .Xr manpath 1 .
 Overrides the
 .Ev MANPATH
 environment variable.
 .It Fl P Ar pager
 Use specified pager.
 Defaults to
 .Dq Li "less -sR"
 if color support is enabled, or
 .Dq Li "more -s" .
 Overrides the
 .Ev MANPAGER
 environment variable, which in turn overrides the
 .Ev PAGER
 environment variable.
 .It Fl S Ar mansect
 Restricts manual sections searched to the specified colon delimited list.
 Defaults to
 .Dq Li 1:8:2:3:n:4:5:6:7:9:l .
 Overrides the
 .Ev MANSECT
 environment variable.
 .It Fl a
 Display all manual pages instead of just the first found for each
 .Ar page
 argument.
 .It Fl d
 Print extra debugging information.
 Repeat for increased verbosity.
 Does not display the manual page.
 .It Fl f
 Emulate
 .Xr whatis 1 .
 .It Fl h
 Display short help message and exit.
 .It Fl k
 Emulate
 .Xr apropos 1 .
 .It Fl m Ar arch Ns Op : Ns Ar machine
 Override the default architecture and machine settings allowing lookup of
 other platform specific manual pages.
 See
 .Sx IMPLEMENTATION NOTES
 for how this option changes the default behavior.
 Overrides the
 .Ev MACHINE_ARCH
 and
 .Ev MACHINE
 environment variables.
 .It Fl o
 Force use of non-localized manual pages.
 See
 .Sx IMPLEMENTATION NOTES
 for how locale specific searches work.
 Overrides the
 .Ev LC_ALL , LC_CTYPE ,
 and
 .Ev LANG
 environment variables.
 .It Fl p Op Cm eprtv
 Use the list of given preprocessors before running
 .Xr nroff 1
 or
 .Xr troff 1 .
 Valid preprocessors arguments:
 .Pp
 .Bl -tag -width indent -compact
 .It Cm e
 .Xr eqn 1
 .It Cm p
 .Xr pic 1
 .It Cm r
 .Xr refer 1
 .It Cm t
 .Xr tbl 1
 .It Cm v
 .Xr vgrind 1
 .El
 .Pp
 Overrides the
 .Ev MANROFFSEQ
 environment variable.
 .It Fl t
 Send manual page source through
 .Xr troff 1
 allowing transformation of the manual pages to other formats.
 .It Fl w
 Display the location of the manual page instead of the contents of
 the manual page.
 .El
 .Sh IMPLEMENTATION NOTES
 .Ss Locale Specific Searches
 The
 .Nm
 utility supports manual pages in different locales.
 The search behavior is dictated by the first of three
 environment variables with a nonempty string:
 .Ev LC_ALL , LC_CTYPE ,
 or
 .Ev LANG .
 If set,
 .Nm
 will search for locale specific manual pages using the following logic:
 .Pp
 .Bl -item -offset indent -compact
 .It
 .Va lang Ns _ Ns Va country Ns . Ns Va charset
 .It
 .Va lang Ns . Ns Va charset
 .It
 .Li en Ns . Ns Va charset
 .El
 .Pp
 For example, if
 .Ev LC_ALL
 is set to
 .Dq Li ja_JP.eucJP ,
 .Nm
 will search the following paths when considering section 1 manual pages in
 .Pa /usr/share/man :
 .Pp
 .Bl -item -offset indent -compact
 .It
 .Pa /usr/share/man/ja_JP.eucJP/man1
 .It
 .Pa /usr/share/man/ja.eucJP/man1
 .It
 .Pa /usr/share/man/en.eucJP/man1
 .It
 .Pa /usr/share/man/man1
 .El
 .Ss Platform Specific Searches
 The
 .Nm
 utility supports platform specific manual pages.
 The search behavior is dictated by the
 .Fl m
 option or the
 .Ev MACHINE_ARCH
 and
 .Ev MACHINE
 environment variables.
 For example, if
 .Ev MACHINE_ARCH
 is set to
 .Dq Li i386
 and
 .Ev MACHINE
 is set to
 .Dq Li pc98 ,
 .Nm
 will search the following paths when considering section 4 manual pages in
 .Pa /usr/share/man :
 .Pp
 .Bl -item -offset indent -compact
 .It
 .Pa /usr/share/man/man4/pc98
 .It
 .Pa /usr/share/man/man4/i386
 .It
 .Pa /usr/share/man/man4
 .El
 .Ss Displaying Specific Manual Files
 The
 .Nm
 utility also supports displaying a specific manual page if passed a path
 to the file as long as it contains a
 .Ql /
 character.
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev MANROFFSEQ"
 .It Ev LC_ALL , LC_CTYPE , LANG
 Used to find locale specific manual pages.
 Valid values can be found by running the
 .Xr locale 1
 command.
 See
 .Sx IMPLEMENTATION NOTES
 for details.
 Influenced by the
 .Fl o
 option.
 .It Ev MACHINE_ARCH , MACHINE
 Used to find platform specific manual pages.
 If unset, the output of
 .Dq Li "sysctl hw.machine_arch"
 and
 .Dq Li "sysctl hw.machine"
 is used respectively.
 See
 .Sx IMPLEMENTATION NOTES
 for details.
 Corresponds to the
 .Fl m
 option.
 .It Ev MANPATH
 Used to find the location of the manual files.
 See
 .Xr manpath 1
 for additional information.
 Corresponds to the
 .Fl M
 option.
 .It Ev MANROFFSEQ
 Used to determine the preprocessors for the manual source before running
 .Xr nroff 1
 or
 .Xr troff 1 .
 If unset, defaults to
 .Xr tbl 1 .
 Corresponds to the
 .Fl p
 option.
 .It Ev MANSECT
 Restricts manual sections searched to the specified colon delimited list.
 Corresponds to the
 .Fl S
 option.
 .It Ev MANWIDTH
 If set to a numeric value, used as the width manpages should be displayed.
 Otherwise, if set to a special value
 .Dq Li tty ,
 and output is to a terminal,
 the pages may be displayed over the whole width of the screen.
 .It Ev MANCOLOR
 If set, enables color support.
 .It Ev MANPAGER
 Program used to display files.
 .Pp
 If unset, and color support is enabled,
 .Dq Li "less -sR"
 is used.
 .Pp
 If unset, and color support is disabled, then
 .Ev PAGER
 is used.
 If that has no value either,
 .Dq Li "more -s"
 is used.
 .El
 .Sh FILES
 .Bl -tag -width indent -compact
 .It Pa /etc/man.conf
 System configuration file.
 .It Pa /usr/local/etc/man.d/*.conf
 Local configuration files.
 .El
 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr intro 1 ,
 .Xr intro 2 ,
 .Xr intro 3 ,
 .Xr intro 4 ,
 .Xr intro 5 ,
 .Xr intro 6 ,
 .Xr intro 7 ,
 .Xr intro 8 ,
 .Xr intro 9 ,
 .Xr locale 1 ,
 .Xr manpath 1 ,
 .Xr nroff 1 ,
 .Xr troff 1 ,
 .Xr whatis 1 ,
 .Xr man.conf 5
Index: head/usr.sbin/bhyve/bhyve.8
===================================================================
--- head/usr.sbin/bhyve/bhyve.8	(revision 274719)
+++ head/usr.sbin/bhyve/bhyve.8	(revision 274720)
@@ -1,321 +1,322 @@
 .\" Copyright (c) 2013 Peter Grehan
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" 1. Redistributions of source code must retain the above copyright
 .\"    notice, this list of conditions and the following disclaimer.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD$
 .\"
 .Dd September 17, 2014
 .Dt BHYVE 8
 .Os
 .Sh NAME
 .Nm bhyve
 .Nd "run a guest operating system inside a virtual machine"
 .Sh SYNOPSIS
 .Nm
 .Op Fl abehwxACHPWY
 .Op Fl c Ar numcpus
 .Op Fl g Ar gdbport
 .Op Fl l Ar lpcdev Ns Op , Ns Ar conf
 .Op Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
 .Op Fl p Ar vcpu:hostcpu
 .Op Fl s Ar slot,emulation Ns Op , Ns Ar conf
 .Op Fl U Ar uuid
 .Ar vmname
 .Sh DESCRIPTION
 .Nm
 is a hypervisor that runs guest operating systems inside a
 virtual machine.
 .Pp
 Parameters such as the number of virtual CPUs, amount of guest memory, and
 I/O connectivity can be specified with command-line parameters.
 .Pp
 The guest operating system must be loaded with
 .Xr bhyveload 4
 or a similar boot loader before running
 .Nm .
 .Pp
 .Nm
 runs until the guest operating system reboots or an unhandled hypervisor
 exit is detected.
 .Sh OPTIONS
 .Bl -tag -width 10n
 .It Fl a
 The guest's local APIC is configured in xAPIC mode.
 The xAPIC mode is the default setting so this option is redundant. It will be
 deprecated in a future version.
 .It Fl A
 Generate ACPI tables.
 Required for
 .Fx Ns /amd64
 guests.
 .It Fl b
 Enable a low-level console device supported by
-.Fx kernels compiled with
+.Fx
+kernels compiled with
 .Cd "device bvmconsole" .
 This option will be deprecated in a future version.
 .It Fl c Ar numcpus
 Number of guest virtual CPUs.
 The default is 1 and the maximum is 16.
 .It Fl C
 Include guest memory in core file.
 .It Fl e
 Force
 .Nm
 to exit when a guest issues an access to an I/O port that is not emulated.
 This is intended for debug purposes.
 .It Fl g Ar gdbport
 For
 .Fx
 kernels compiled with
 .Cd "device bvmdebug" ,
 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
 via a local IPv4 address and this port.
 This option will be deprecated in a future version.
 .It Fl h
 Print help message and exit.
 .It Fl H
 Yield the virtual CPU thread when a HLT instruction is detected.
 If this option is not specified, virtual CPUs will use 100% of a host CPU.
 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
 Allow devices behind the LPC PCI-ISA bridge to be configured.
 The only supported devices are the TTY-class devices,
 .Li com1
 and
 .Li com2 .
 .It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
 Guest physical memory size in bytes.
 This must be the same size that was given to
 .Xr bhyveload 8 .
 .Pp
 The size argument may be suffixed with one of K, M, G or T (either upper
 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
 or terabytes.
 If no suffix is given, the value is assumed to be in megabytes.
 .It Fl p Ar vcpu:hostcpu
 Pin guest's virtual CPU
 .Em vcpu
 to
 .Em hostcpu .
 .It Fl P
 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
 Configure a virtual PCI slot and function.
 .Pp
 .Nm bhyve
 provides PCI bus emulation and virtual devices that can be attached to
 slots on the bus.
 There are 32 available slots, with the option of providing up to 8 functions
 per slot.
 .Bl -tag -width 10n
 .It Ar slot
 .Ar pcislot[:function]
 .Ar bus:pcislot:function
 .Pp
 The
 .Ar pcislot
 value is 0 to 31. The optional function value is 0 to 7. The optional
 .Ar bus
 value is 0 to 255.
 If not specified, the function value defaults to 0.
 If not specified, the bus value defaults to 0.
 .It Ar emulation
 .Bl -tag -width 10n
 .It Li hostbridge | Li amd_hostbridge
 .Pp
 Provide a simple host bridge.
 This is usually configured at slot 0, and is required by most guest
 operating systems.
 The
 .Li amd_hostbridge
 emulation is identical but uses a PCI vendor ID of
 .Li AMD .
 .It Li passthru
 PCI pass-through device.
 .It Li virtio-net
 Virtio network interface.
 .It Li virtio-blk
 Virtio block storage interface.
 .It Li virtio-rnd
 Virtio RNG interface.
 .It Li ahci-cd
 AHCI controller attached to an ATAPI CD/DVD.
 .It Li ahci-hd
 AHCI controller attached to a SATA hard-drive.
 .It Li uart
 PCI 16550 serial device.
 .It Li lpc
 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports. The LPC bridge
 emulation can only be configured on bus 0.
 .El
 .It Op Ar conf
 This optional parameter describes the backend for device emulations.
 If
 .Ar conf
 is not specified, the device emulation has no backend and can be
 considered unconnected.
 .Pp
 Network devices:
 .Bl -tag -width 10n
 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 .Pp
 If
 .Ar mac
 is not specified, the MAC address is derived from a fixed OUI and the
 remaining bytes from an MD5 hash of the slot and function numbers and
 the device name.
 .Pp
 The MAC address is an ASCII string in
 .Xr ethers 5
 format.
 .El
 .Pp
 Block storage devices:
 .Bl -tag -width 10n
 .It Pa /filename Ns Oo , Ns Li nocache Oc Ns Oo , Ns Li direct Oc Ns Oo , Ns Li ro Oc
 .It Pa /dev/xxx Ns Oo , Ns Ar nocache Oc Ns Oo , Ns Ar direct Oc Ns Oo , Ns Ar ro Oc
 .Bl -tag -width 8n
 .It Li nocache
 Open the file with
 .Dv O_DIRECT .
 .It Li direct
 Open the file using
 .Dv O_SYNC .
 .It Li ro
 Force the file to be opened read-only.
 .El
 .Pp
 The
 .Li nocache ,
 .Li direct ,
 and
 .Li ro
 options are not available for virtio block devices.
 .El
 .Pp
 TTY devices:
 .Bl -tag -width 10n
 .It Li stdio
 Connect the serial port to the standard input and output of
 the bhyve process.
 .It Pa /dev/xxx
 Use the host TTY device for serial port I/O.
 .El
 .Pp
 Pass-through devices:
 .Bl -tag -width 10n
 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 Connect to a PCI device on the host at the selector described by
 .Ar slot ,
 .Ar bus ,
 and
 .Ar function
 numbers.
 .El
 .Pp
 The host device must have been reserved at boot-time using the
 .Va pptdev
 loader variable as described in
 .Xr vmm 4 .
 .El
 .It Fl U Ar uuid
 Set the universally unique identifier
 .Pq UUID
 in the guest's System Management BIOS System Information structure.
 By default a UUID is generated from the host's hostname and
 .Ar vmname .
 .It Fl w
 Ignore accesses to unimplemented Model Specific Registers (MSRs). This is intended for debug purposes.
 .It Fl W
 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 interrupts.
 .It Fl x
 The guest's local APIC is configured in x2APIC mode.
 .It Fl Y
 Disable MPtable generation.
 .It Ar vmname
 Alphanumeric name of the guest.
 This should be the same as that created by
 .Xr bhyveload 8 .
 .El
 .Sh EXAMPLES
 The guest operating system must have been loaded with
 .Xr bhyveload 4
 or a similar boot loader before
 .Xr bhyve 4
 can be run.
 .Pp
 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 block device backed by the
 .Pa /my/image
 filesystem image, and a serial port for the console:
 .Bd -literal -offset indent
 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
   -l com1,stdio -A -H -P -m 1G vm1
 .Ed
 .Pp
 Run a 24GB single-CPU virtual machine with three network ports, one of which
 has a MAC address specified:
 .Bd -literal -offset indent
 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
   -s 2:1,virtio-net,tap1 \\
   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
   -s 3,virtio-blk,/my/image -l com1,stdio \\
   -A -H -P -m 24G bigvm
 .Ed
 .Pp
 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 port connected to an
 .Xr nmdm 4
 null-model device.
 .Bd -literal -offset indent
 bhyve -c 4 \e\
   -s 0,amd_hostbridge -s 1,lpc \\
   -s 1:0,ahci-hd,/images/disk.1 \\
   -s 1:1,ahci-hd,/images/disk.2 \\
   -s 1:2,ahci-hd,/images/disk.3 \\
   -s 1:3,ahci-hd,/images/disk.4 \\
   -s 1:4,ahci-hd,/images/disk.5 \\
   -s 1:5,ahci-hd,/images/disk.6 \\
   -s 1:6,ahci-hd,/images/disk.7 \\
   -s 1:7,ahci-hd,/images/disk.8 \\
   -s 2,ahci-cd,/images.install.iso \\
   -s 3,virtio-net,tap0 \\
   -l com1,/dev/nmdm0A \\
   -A -H -P -m 8G
 .Ed
 .Sh SEE ALSO
 .Xr bhyve 4 ,
 .Xr nmdm 4 ,
 .Xr vmm 4 ,
 .Xr ethers 5 ,
 .Xr bhyvectl 8 ,
 .Xr bhyveload 8
 .Sh HISTORY
 .Nm
 first appeared in
 .Fx 10.0 .
 .Sh AUTHORS
 .An Neel Natu Aq Mt neel@freebsd.org
 .An Peter Grehan Aq Mt grehan@freebsd.org