aboutsummaryrefslogtreecommitdiff
path: root/usr.sbin
diff options
context:
space:
mode:
authorMateusz Piotrowski <0mp@FreeBSD.org>2020-04-22 06:32:51 +0000
committerMateusz Piotrowski <0mp@FreeBSD.org>2020-04-22 06:32:51 +0000
commit77d208a3ae2fc6a4b46228be7632b7a2ca48da60 (patch)
tree0264c0fd5c7953930cd291ac39ac3d5bf0529571 /usr.sbin
parenta269a14ff070423894c9eef19ef4501b45f72366 (diff)
downloadsrc-77d208a3ae2fc6a4b46228be7632b7a2ca48da60.tar.gz
src-77d208a3ae2fc6a4b46228be7632b7a2ca48da60.zip
Improve formatting of synopsis section
This patch is about sorting the arguments and using proper mdoc(7) macros to stylize arguments and command modifiers for much better readability. Further style fixes in other sections within the bhyve manual page are going to be worked on in upcoming patches. Reviewed by: rgrimes MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D24526
Notes
Notes: svn path=/head/; revision=360187
Diffstat (limited to 'usr.sbin')
-rw-r--r--usr.sbin/bhyve/bhyve.845
1 files changed, 31 insertions, 14 deletions
diff --git a/usr.sbin/bhyve/bhyve.8 b/usr.sbin/bhyve/bhyve.8
index efab395a95d0..5d329a54491e 100644
--- a/usr.sbin/bhyve/bhyve.8
+++ b/usr.sbin/bhyve/bhyve.8
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 13, 2019
+.Dd April 22, 2020
.Dt BHYVE 8
.Os
.Sh NAME
@@ -32,23 +32,40 @@
.Nd "run a guest operating system inside a virtual machine"
.Sh SYNOPSIS
.Nm
-.Op Fl abehuwxACHPSWY
+.Op Fl AabCeHhPSuWwxY
.Oo
-.Fl c\~ Ns
+.Sm off
+.Fl c\~
.Oo
-.Op Ar cpus= Ns
-.Ar numcpus Ns
-.Oc Ns
-.Op Ar ,sockets=n Ns
-.Op Ar ,cores=n Ns
-.Op Ar ,threads=n
+.Op Cm cpus=
+.Ar numcpus
.Oc
-.Op Fl g Ar gdbport
-.Op Fl l Ar help|lpcdev Ns Op , Ns Ar conf
-.Op Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
-.Op Fl p Ar vcpu:hostcpu
-.Op Fl s Ar help|slot,emulation Ns Op , Ns Ar conf
+.Op Cm ,sockets= Ar n
+.Op Cm ,cores= Ar n
+.Op Cm ,threads= Ar n
+.Oc
+.Sm on
.Op Fl G Ar port
+.Op Fl g Ar gdbport
+.Oo Fl l
+.Sm off
+.Cm help | Ar lpcdev Op Cm \&, Ar conf
+.Sm on
+.Oc
+.Oo Fl m
+.Sm off
+.Ar memsize
+.Oo
+.Cm K No | Cm k No | Cm M No | Cm m No | Cm G No | Cm g No | Cm T No | Cm t
+.Oc
+.Sm on
+.Oc
+.Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
+.Oo Fl s
+.Sm off
+.Cm help | Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
+.Sm on
+.Oc
.Op Fl U Ar uuid
.Ar vmname
.Sh DESCRIPTION