Sort command flags in usage output and the manpages.
This commit is contained in:
parent
5491e63797
commit
63fdb1686c
@ -35,10 +35,10 @@
|
||||
.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 l Ar lpcdev Ns Op , Ns Ar conf
|
||||
.Op Fl U Ar uuid
|
||||
.Ar vmname
|
||||
.Sh DESCRIPTION
|
||||
@ -78,9 +78,11 @@ 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 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 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
|
||||
@ -89,6 +91,26 @@ kernels compiled with
|
||||
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
|
||||
@ -96,9 +118,6 @@ to
|
||||
.Em hostcpu .
|
||||
.It Fl P
|
||||
Force the guest virtual CPU to exit when a PAUSE instruction is detected.
|
||||
.It Fl W
|
||||
Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
|
||||
interrupts.
|
||||
.It Fl s Ar slot,emulation Ns Op , Ns Ar conf
|
||||
Configure a virtual PCI slot and function.
|
||||
.Pp
|
||||
@ -219,26 +238,6 @@ The host device must have been reserved at boot-time using the
|
||||
loader variable as described in
|
||||
.Xr vmm 4 .
|
||||
.El
|
||||
.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 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 U Ar uuid
|
||||
Set the universally unique identifier
|
||||
.Pq UUID
|
||||
@ -247,12 +246,13 @@ 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 Fl h
|
||||
Print help message and exit.
|
||||
.It Ar vmname
|
||||
Alphanumeric name of the guest.
|
||||
This should be the same as that created by
|
||||
|
@ -129,26 +129,26 @@ usage(int code)
|
||||
{
|
||||
|
||||
fprintf(stderr,
|
||||
"Usage: %s [-abehwxACHPWY] [-g <gdb port>] [-s <pci>] [-c vcpus]\n"
|
||||
" %*s [-p vcpu:hostcpu] [-m mem] [-l <lpc>] [-U uuid] <vm>\n"
|
||||
"Usage: %s [-abehwxACHPWY] [-c vcpus] [-g <gdb port>] [-l <lpc>]\n"
|
||||
" %*s [-m mem] [-p vcpu:hostcpu] [-s <pci>] [-U uuid] <vm>\n"
|
||||
" -a: local apic is in xAPIC mode (deprecated)\n"
|
||||
" -A: create ACPI tables\n"
|
||||
" -g: gdb port\n"
|
||||
" -c: # cpus (default 1)\n"
|
||||
" -C: include guest memory in core file\n"
|
||||
" -p: pin 'vcpu' to 'hostcpu'\n"
|
||||
" -H: vmexit from the guest on hlt\n"
|
||||
" -P: vmexit from the guest on pause\n"
|
||||
" -W: force virtio to use single-vector MSI\n"
|
||||
" -e: exit on unhandled I/O access\n"
|
||||
" -g: gdb port\n"
|
||||
" -h: help\n"
|
||||
" -s: <slot,driver,configinfo> PCI slot config\n"
|
||||
" -H: vmexit from the guest on hlt\n"
|
||||
" -l: LPC device configuration\n"
|
||||
" -m: memory size in MB\n"
|
||||
" -p: pin 'vcpu' to 'hostcpu'\n"
|
||||
" -P: vmexit from the guest on pause\n"
|
||||
" -s: <slot,driver,configinfo> PCI slot config\n"
|
||||
" -U: uuid\n"
|
||||
" -w: ignore unimplemented MSRs\n"
|
||||
" -W: force virtio to use single-vector MSI\n"
|
||||
" -x: local apic is in x2APIC mode\n"
|
||||
" -Y: disable MPtable generation\n"
|
||||
" -U: uuid\n",
|
||||
" -Y: disable MPtable generation\n",
|
||||
progname, (int)strlen(progname), "");
|
||||
|
||||
exit(code);
|
||||
|
@ -35,11 +35,11 @@
|
||||
guest inside a bhyve virtual machine
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl m Ar mem-size
|
||||
.Op Fl d Ar disk-path
|
||||
.Op Fl h Ar host-path
|
||||
.Op Fl e Ar name=value
|
||||
.Op Fl c Ar cons-dev
|
||||
.Op Fl d Ar disk-path
|
||||
.Op Fl e Ar name=value
|
||||
.Op Fl h Ar host-path
|
||||
.Op Fl m Ar mem-size
|
||||
.Ar vmname
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
@ -62,6 +62,32 @@ and will be created if it does not already exist.
|
||||
.Sh OPTIONS
|
||||
The following options are available:
|
||||
.Bl -tag -width indent
|
||||
.It Fl c Ar cons-dev
|
||||
.Ar cons-dev
|
||||
is a
|
||||
.Xr tty 4
|
||||
device to use for
|
||||
.Nm
|
||||
terminal I/O.
|
||||
.Pp
|
||||
The text string "stdio" is also accepted and selects the use of
|
||||
unbuffered standard I/O. This is the default value.
|
||||
.It Fl d Ar disk-path
|
||||
The
|
||||
.Ar disk-path
|
||||
is the pathname of the guest's boot disk image.
|
||||
.It Fl e Ar name=value
|
||||
Set the FreeBSD loader environment variable
|
||||
.Ar name
|
||||
to
|
||||
.Ar value .
|
||||
.Pp
|
||||
The option may be used more than once to set more than one environment
|
||||
variable.
|
||||
.It Fl h Ar host-path
|
||||
The
|
||||
.Ar host-path
|
||||
is the directory at the top of the guest's boot filesystem.
|
||||
.It Fl m Ar mem-size Xo
|
||||
.Sm off
|
||||
.Op Cm K | k | M | m | G | g | T | t
|
||||
@ -85,32 +111,6 @@ respectively.
|
||||
The default value of
|
||||
.Ar mem-size
|
||||
is 256M.
|
||||
.It Fl d Ar disk-path
|
||||
The
|
||||
.Ar disk-path
|
||||
is the pathname of the guest's boot disk image.
|
||||
.It Fl h Ar host-path
|
||||
The
|
||||
.Ar host-path
|
||||
is the directory at the top of the guest's boot filesystem.
|
||||
.It Fl e Ar name=value
|
||||
Set the FreeBSD loader environment variable
|
||||
.Ar name
|
||||
to
|
||||
.Ar value .
|
||||
.Pp
|
||||
The option may be used more than once to set more than one environment
|
||||
variable.
|
||||
.It Fl c Ar cons-dev
|
||||
.Ar cons-dev
|
||||
is a
|
||||
.Xr tty 4
|
||||
device to use for
|
||||
.Nm
|
||||
terminal I/O.
|
||||
.Pp
|
||||
The text string "stdio" is also accepted and selects the use of
|
||||
unbuffered standard I/O. This is the default value.
|
||||
.El
|
||||
.Sh EXAMPLES
|
||||
To create a virtual machine named
|
||||
|
@ -629,8 +629,8 @@ usage(void)
|
||||
{
|
||||
|
||||
fprintf(stderr,
|
||||
"usage: %s [-m mem-size] [-d <disk-path>] [-h <host-path>]\n"
|
||||
" %*s [-e <name=value>] [-c <console-device>] <vmname>\n",
|
||||
"usage: %s [-c <console-device>] [-d <disk-path>] [-e <name=value>]\n"
|
||||
" %*s [-h <host-path>] [-m mem-size] <vmname>\n",
|
||||
progname,
|
||||
(int)strlen(progname), "");
|
||||
exit(1);
|
||||
|
Loading…
Reference in New Issue
Block a user