diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2016-09-04 19:03:35 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2016-09-04 19:03:35 +0000 |
commit | 984622571cfb86f4ead23739d07b9d287e594aee (patch) | |
tree | 18c4f60d5725ac3f73428af462205dc7751ded31 /share | |
parent | 379d0d3645793782123637fe47bfd0c42795cd15 (diff) |
tweaks;
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man4/switch.4 | 66 |
1 files changed, 35 insertions, 31 deletions
diff --git a/share/man/man4/switch.4 b/share/man/man4/switch.4 index 5a99d0227ab..aa98ed3d90e 100644 --- a/share/man/man4/switch.4 +++ b/share/man/man4/switch.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: switch.4,v 1.2 2016/09/04 16:49:57 yasuoka Exp $ +.\" $OpenBSD: switch.4,v 1.3 2016/09/04 19:03:34 jmc Exp $ .\" .\" Copyright (c) 2016 YASUOKA Masahiko <yasuoka@openbsd.org> .\" @@ -19,7 +19,7 @@ .Os .Sh NAME .Nm switch -.Nd Network switch pseudo device +.Nd network switch pseudo device .Sh SYNOPSIS .Cd "pseudo-device switch" .Pp @@ -33,7 +33,7 @@ The .Nm driver provides a network interface pseudo-device. The interface is the forwarding part of a network switch, -and it works along with a controller which usually is +and it works along with a controller which usually is .Xr switchd 8 or .Xr switchctl 8 through the device @@ -55,12 +55,14 @@ or by opening the character device is the OpenFlow channel of the interface .Pa switchN . It is used for exchanging OpenFlow messages. -The device grantees +The device guarantees .Xr read 2 -returns a complete OpenFlow message, it never return a message partially. +returns a complete OpenFlow message - it never return a message partially. The program which uses the .Pa /dev/switchN -must write(2) per a complete OpenFlow message. +must +.Xr write 2 +per a complete OpenFlow message. .Sh IOCTLS A .Nm @@ -70,7 +72,7 @@ calls specific to other interfaces listed in .Xr netintro 4 . .Pp The following -.Xr ioctl 2 +.Xr ioctl 2 calls are used commonly by .Nm and @@ -93,13 +95,12 @@ and .Xr bridge 4 . .Pp The following -.Xr ioctl -calls are -specific for +.Xr ioctl 2 +calls are used only by the .Nm -interface. -They are defined in -.In sys/sockio.h . +interface, +as defined in +.In sys/sockio.h : .Bl -tag -width Ds .It Dv SIOCBRDGADDL Fa "struct ifbreq *" Add the interface named in @@ -111,48 +112,51 @@ Only one .Xr vether 4 interface can be added as a local port. .It Dv SIOCSWGDPID -Retrieve the datapath_id in OpenFlow protocol of the switch named in +Retrieve the datapath_id in the OpenFlow protocol of the switch named in .Va ifbrp_name -into +into the .Va ifbrpu_datapath field. .It Dv SIOCSWSDPID Fa "struct ifbrparam" -Set the datapath_id in OpenFlow protocol of the switch named in +Set the datapath_id in the OpenFlow protocol of the switch named in .Va ifbrp_name -to the value in +to the value in the .Va ifbrpu_datapath field. .It Dv SIOCSWGFLOWMAX Fa "struct ifbrparam" -Retrieve the maximum number of flows in OpenFlow protocol of the switch named in +Retrieve the maximum number of flows in the OpenFlow protocol +of the switch named in .Va ifbrp_name -into +into the .Va ifbrp_maxflow field. .It Dv SIOCSWSFLOWMAX Fa "struct ifbrparam" -Set the maximum number of flows in OpenFlow protocol of the switch named in +Set the maximum number of flows in the OpenFlow protocol of the switch named in .Va ifbrp_name -to the value in +to the value in the .Va ifbrpu_maxflow field. .It Dv SIOCSWGMAXGROUP Fa "struct ifbrparam" -Retrieve the maximum number of groups in OpenFlow protocol of the switch named -in +Retrieve the maximum number of groups in the OpenFlow protocol +of the switch named +in .Va ifbrp_name -into +into the .Va ifbrpu_maxgroup field. .It Dv SIOCSWSMAXGROUP Fa "struct ifbrparam" -Set the maximum number of groups in OpenFlow protocol of the switch named in +Set the maximum number of groups in the OpenFlow protocol +of the switch named in .Va ifbrp_name -to the value in +to the value in the .Va ifbrpu_maxgroup field. .It Dv SIOCSWSPORTNO Fa "struct ifbreq" -Set the port_no in OpenFlow protocol of the port named in +Set the port_no in the OpenFlow protocol of the port named in .Va ifbr_ifsname of the switch named in .Va ifbr_name -to +to the .Va ifbr_portno field. .El @@ -179,9 +183,9 @@ Out of memory. .Xr vether 4 , .Xr hostname.if 5 , .Xr ifconfig 8 , -.Xr netstart 8 +.Xr netstart 8 , .Xr switchctl 8 , -.Xr switchd 8 , +.Xr switchd 8 .Sh STANDARDS .Rs .%A Open Networking Foundation (ONF) @@ -197,5 +201,5 @@ driver first appeared in .Sh AUTHORS The .Nm -driver written by +driver was written by .An Kazuya Goda Aq Mt goda@openbsd.org . |