d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bhyve.8: Clean up network backends section

Browse Source 
- Reformat the format lists, use appropriate mdoc macros for
  readability.
- Add a missing Oxford comma.

MFC after:	2 weeks
This commit is contained in:
Mateusz Piotrowski 2021-04-18 23:29:30 +02:00
parent 7014cb2393
commit 7fb2272981
1 changed files with 39 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
usr.sbin/bhyve/bhyve.8
View File

@ -339,14 +339,34 @@ If
is not specified, the device emulation has no backend and can be is not specified, the device emulation has no backend and can be
considered unconnected. considered unconnected.
.Pp .Pp
Network backends: Network backends formats for
.Bl -tag -width 10n .Ar conf :
.It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc .Sm off
.It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc .Bl -bullet
.It Ar netgraph,path=ADDRESS,peerhook=HOOK Ns Oo , Ns Ar socket=NAME Oc Ns Oo , Ns Ar hook=HOOK Oc Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc .It
.Pp .Xo
.Cm tap Ar N
.Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
.Op Cm \&,mtu= Ar N
.Xc
.It
.Xo
.Cm vmnet Ar N
.Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
.Op Cm \&,mtu= Ar N
.Xc
.It
.Xo
.Cm netgraph,path= Ar ADDRESS Cm \&,peerhook= Ar HOOK
.Op Cm \&,socket= Ar NAME
.Op Cm \&,hook= Ar HOOK
.Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
.Op Cm \&,mtu= Ar N
.Xc
.El
.Sm on
If If
.Ar mac .Cm mac
is not specified, the MAC address is derived from a fixed OUI and the 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 remaining bytes from an MD5 hash of the slot and function numbers and
the device name. the device name.
@ -355,32 +375,35 @@ The MAC address is an ASCII string in
.Xr ethers 5 .Xr ethers 5
format. format.
.Pp .Pp
With virtio-net devices, the With
.Ar mtu .Cm virtio-net
devices, the
.Cm mtu
parameter can be specified to inform the guest about the largest MTU parameter can be specified to inform the guest about the largest MTU
that should be allowed, expressed in bytes. that should be allowed, expressed in bytes.
.Pp .Pp
With netgraph backend, the With
.Ar path .Cm netgraph
backend, the
.Cm path
and and
.Ar peerhook .Cm peerhook
parameters must be specified to set the destination node and corresponding hook. parameters must be specified to set the destination node and corresponding hook.
The optional parameters The optional parameters
.Ar socket .Cm socket
and and
.Ar hook .Cm hook
may be used to set the may be used to set the
.Xr ng_socket 4 .Xr ng_socket 4
node name and source hook. node name and source hook.
The The
.Ar ADDRESS , .Ar ADDRESS ,
.Ar HOOK .Ar HOOK ,
and and
.Ar NAME .Ar NAME
must comply with must comply with
.Xr netgraph 4 .Xr netgraph 4
addressing rules. addressing rules.
.El
.Pp .Pp
Block storage devices: Block storage devices:
.Bl -tag -width 10n .Bl -tag -width 10n