bhyve.8: Sort the options in the OPTIONS section

No content change intended. Just moving the option descriptions around
to follow the order suggested by style(9).

MFC after:	2 weeks
This commit is contained in:
Mateusz Piotrowski 2021-04-18 20:26:04 +02:00
parent b6a572d03f
commit ccb1c87a6a

View File

@ -95,15 +95,17 @@ runs until the guest operating system reboots or an unhandled hypervisor
exit is detected. exit is detected.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width 10n .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 .It Fl A
Generate ACPI tables. Generate ACPI tables.
Required for Required for
.Fx Ns /amd64 .Fx Ns /amd64
guests. guests.
.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 C
Include guest memory in core file.
.It Fl c Op Ar setting ... .It Fl c Op Ar setting ...
Number of guest virtual CPUs Number of guest virtual CPUs
and/or the CPU topology. and/or the CPU topology.
@ -128,8 +130,6 @@ and
If a If a
.Ar setting .Ar setting
is specified more than once the last one has precedence. is specified more than once the last one has precedence.
.It Fl C
Include guest memory in core file.
.It Fl D .It Fl D
Destroy the VM on guest initiated power-off. Destroy the VM on guest initiated power-off.
.It Fl e .It Fl e
@ -150,11 +150,11 @@ begins with
.Sq w , .Sq w ,
.Nm .Nm
will pause execution at the first instruction waiting for a debugger to attach. will pause execution at the first instruction waiting for a debugger to attach.
.It Fl h
Print help message and exit.
.It Fl H .It Fl H
Yield the virtual CPU thread when a HLT instruction is detected. 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. If this option is not specified, virtual CPUs will use 100% of a host CPU.
.It Fl h
Print help message and exit.
.It Fl k Ar file .It Fl k Ar file
Set configuration variables from a simple, key-value config file. Set configuration variables from a simple, key-value config file.
Each line of the config file is expected to consist of a config variable Each line of the config file is expected to consist of a config variable
@ -196,13 +196,13 @@ Set the configuration variable
.Ar var .Ar var
to to
.Ar value . .Ar value .
.It Fl P
Force the guest virtual CPU to exit when a PAUSE instruction is detected.
.It Fl p Ar vcpu:hostcpu .It Fl p Ar vcpu:hostcpu
Pin guest's virtual CPU Pin guest's virtual CPU
.Em vcpu .Em vcpu
to to
.Em hostcpu . .Em hostcpu .
.It Fl P
Force the guest virtual CPU to exit when a PAUSE instruction is detected.
.It Fl r Ar file .It Fl r Ar file
Resume a guest from a snapshot. Resume a guest from a snapshot.
The guest memory contents are restored from The guest memory contents are restored from
@ -218,6 +218,8 @@ and
.Op Fl l .Op Fl l
options. options.
The count of vCPUs and memory configuration are read from the snapshot. The count of vCPUs and memory configuration are read from the snapshot.
.It Fl S
Wire guest memory.
.It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
Configure a virtual PCI slot and function. Configure a virtual PCI slot and function.
.Pp .Pp
@ -591,22 +593,20 @@ Recording device, typically
.Ar /dev/dsp0 . .Ar /dev/dsp0 .
.El .El
.El .El
.It Fl S
Wire guest memory.
.It Fl u
RTC keeps UTC time.
.It Fl U Ar uuid .It Fl U Ar uuid
Set the universally unique identifier Set the universally unique identifier
.Pq UUID .Pq UUID
in the guest's System Management BIOS System Information structure. in the guest's System Management BIOS System Information structure.
By default a UUID is generated from the host's hostname and By default a UUID is generated from the host's hostname and
.Ar vmname . .Ar vmname .
.It Fl w .It Fl u
Ignore accesses to unimplemented Model Specific Registers (MSRs). RTC keeps UTC time.
This is intended for debug purposes.
.It Fl W .It Fl W
Force virtio PCI device emulations to use MSI interrupts instead of MSI-X Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
interrupts. interrupts.
.It Fl w
Ignore accesses to unimplemented Model Specific Registers (MSRs).
This is intended for debug purposes.
.It Fl x .It Fl x
The guest's local APIC is configured in x2APIC mode. The guest's local APIC is configured in x2APIC mode.
.It Fl Y .It Fl Y