summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-09 07:26:15 +0000
committerru <ru@FreeBSD.org>2004-07-09 07:26:15 +0000
commit4f3bf456c259d542040a34d38b8d548229753e5c (patch)
tree2567b89cc7fbbb6f5375f76040d71ce471159f87 /share
parent6a3f3bc6495f85df35192c9b4a9697f4b3a772d7 (diff)
downloadFreeBSD-src-4f3bf456c259d542040a34d38b8d548229753e5c.zip
FreeBSD-src-4f3bf456c259d542040a34d38b8d548229753e5c.tar.gz
Fixed markup and punctuation.
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/ng_atm.4182
-rw-r--r--share/man/man4/ng_atmllc.427
-rw-r--r--share/man/man4/ng_atmpif.449
-rw-r--r--share/man/man4/ng_sppp.4109
-rw-r--r--share/man/man4/ng_sscfu.467
-rw-r--r--share/man/man4/ng_sscop.4235
-rw-r--r--share/man/man4/ng_uni.4128
7 files changed, 455 insertions, 342 deletions
diff --git a/share/man/man4/ng_atm.4 b/share/man/man4/ng_atm.4
index afdd34c..174d603 100644
--- a/share/man/man4/ng_atm.4
+++ b/share/man/man4/ng_atm.4
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" Author: Hartmut Brandt <harti@freebsd.org>
+.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\"
.\" $FreeBSD$
.\"
@@ -37,11 +37,11 @@
.Nm ng_atm
.Nd netgraph ATM node type
.Sh SYNOPSIS
-.Fd #include <net/if_atm.h>
-.Fd #include <netgraph/ng_atm.h>
+.In net/if_atm.h
+.In netgraph/ng_atm.h
.Sh DESCRIPTION
The
-.Nm
+.Nm atm
netgraph node type allows
.Xr natm 4
ATM drivers to be connected to the
@@ -49,20 +49,22 @@ ATM drivers to be connected to the
networking subsystem.
When the
.Nm
-module is loaded a node is automatically create for each
+module is loaded a node is automatically created for each
.Xr natm 4
ATM interface.
The nodes are named with the same name as the
interface.
-Nodes are also created, if a driver for an ATM
+Nodes are also created if a driver for an ATM
card is loaded after
.Nm
was loaded.
.Pp
-.Nm
+The
+.Nm atm
nodes are persistent.
They are removed when the interface is removed.
-SHUTDOWN messages are ignored by the node.
+.Dv NGM_SHUTDOWN
+messages are ignored by the node.
.Sh HOOKS
Four special hooks with fixed names and an unlimited number of hooks with user
defined names are supported.
@@ -74,37 +76,37 @@ The fourth fixed hook behaves like the other
user hooks, but a number of management messages are sent along the hook.
The other hooks can be attached to VCIs dynamically by means of
control messages to the
-.Nm
+.Nm atm
node and can be written and read.
.Pp
The four fixed hooks are:
-.Bl -tag -width orphans
-.It Dv input
+.Bl -tag -width ".Va orphans"
+.It Va input
This is a connection to the raw input stream from the network.
If this hook is connected, all incoming packets are delivered out to
this hook.
-Note, that this redirects ALL input.
+Note that this redirects ALL input.
Neither
.Xr natm 4
nor the user hooks will see any input if
-.Dv input
+.Va input
is connected.
An
-.Dv atm_pseudohdr
+.Vt atm_pseudohdr
(see
.Xr natm 4 )
is prepended to the actual data.
-.It Dv output
+.It Va output
This is a connection to the raw output stream to the network device.
If this hook is connected, all outgoing packets are handed over to
the netgraph system and delivered to the hook instead of being delivered
to the ATM driver.
An
-.Dv atm_pseudohdr
+.Vt atm_pseudohdr
(see
.Xr natm 4 )
is prepended to the actual data.
-.It Dv orphans
+.It Va orphans
This hook receives all packets that are unrecognized, i.e., do not belong to
either a
.Xr natm 4
@@ -118,15 +120,15 @@ when someone initiates this VCI, packets should never be orphaned.
There is
however one exception: if you use
.Xr natm 4
-IP with LLC/SNAP encapsulation packets with don't have the IP protocol
+IP with LLC/SNAP encapsulation packets with do not have the IP protocol
indicated in the packet header are delivered out of this hook.
An
-.Dv atm_pseudohdr
+.Vt atm_pseudohdr
(see
.Xr natm 4 )
is prepended to the actual data send out to the hook.
-.It Dv manage
-This hook behaves exactly like a normal user hook (see below) except, that
+.It Va manage
+This hook behaves exactly like a normal user hook (see below) except that
the node at the other hand will receive management messages.
.El
.Pp
@@ -142,13 +144,15 @@ To terminate sending and receiving one must send a
.Dv NGM_ATM_CPCS_TERM
message (see
.Sx CONTROL MESSAGES ) .
-The data send and received on these hooks has no additional
+The data sent and received on these hooks has no additional
headers.
.Sh CONTROL MESSAGES
This node type supports the generic messages plus the following:
-.Bl -tag -width xxx
+.Bl -tag -width 4n
.It Dv NGM_ATM_GET_IFNAME
-Return the name of the interface as a NUL-terminated string.
+Return the name of the interface as a
+.Dv NUL Ns
+-terminated string.
This is normally the same name as that of the node.
.It Dv NGM_ATM_GET_CONFIG
Returns a structure defining the configuration of the interface:
@@ -164,7 +168,7 @@ struct ng_atm_config {
.It Dv NGM_ATM_GET_VCCS
Returns the table of open VCCs from the driver.
This table consists of
-a header and a variable sized array of entries, one for each open vcc:
+a header and a variable sized array of entries, one for each open VCC:
.Bd -literal
struct atmio_vcctable {
uint32_t count; /* number of vccs */
@@ -196,45 +200,63 @@ struct atmio_tparam {
};
.Ed
.Pp
-Note, that this is the driver's table, so all VCCs opened via
+Note that this is the driver's table, so all VCCs opened via
.Xr natm 4
sockets and IP are also shown.
They can, however, be distinguished by
their flags.
The
-.Dv flags
+.Va flags
field contains the following flags:
-.Bl -column ATM_PH_LLCSNAP -offset indent
-.It Dv ATM_PH_AAL5 Ta use AAL5 instead of AAL0
-.It Dv ATM_PH_LLCSNAP Ta if AAL5 use LLC SNAP encapsulation
-.It Dv ATM_FLAG_NG Ta this is a netgraph VCC
-.It Dv ATM_FLAG_HARP Ta this is a HARP VCC
-.It Dv ATM_FLAG_NORX Ta transmit only VCC
-.It Dv ATM_FLAG_NOTX Ta receive only VCC
-.It Dv ATMIO_FLAG_PVC Ta treat channel as a PVC
+.Pp
+.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact
+.It Dv ATM_PH_AAL5
+use AAL5 instead of AAL0
+.It Dv ATM_PH_LLCSNAP
+if AAL5 use LLC SNAP encapsulation
+.It Dv ATM_FLAG_NG
+this is a netgraph VCC
+.It Dv ATM_FLAG_HARP
+this is a HARP VCC
+.It Dv ATM_FLAG_NORX
+transmit only VCC
+.It Dv ATM_FLAG_NOTX
+receive only VCC
+.It Dv ATMIO_FLAG_PVC
+treat channel as a PVC
.El
.Pp
If the
.Dv ATM_FLAG_NG
flag is set, then
-.Dv traffic
+.Va traffic
and
-.Dv tparam
+.Va tparam
contain meaningful information.
.Pp
-.Dv aal
+The
+.Va aal
+field
contains one of the following values:
-.Bl -column ATM_PH_LLCSNAP -offset indent
-.It Dv ATMIO_AAL_0 Ta AAL 0 (raw cells)
-.It Dv ATMIO_AAL_34 Ta AAL 3 or AAL 4
-.It Dv ATMIO_AAL_5 Ta AAL 5
-.It Dv ATMIO_AAL_RAW Ta device specific raw cells
+.Pp
+.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact
+.It Dv ATMIO_AAL_0
+AAL 0 (raw cells)
+.It Dv ATMIO_AAL_34
+AAL 3 or AAL 4
+.It Dv ATMIO_AAL_5
+AAL 5
+.It Dv ATMIO_AAL_RAW
+device specific raw cells
.El
.Pp
-.Dv traffic
+The
+.Va traffic
+field
can have one of the following values (not all drivers support
all traffic types however):
-.Bl -column ATM_PH_LLCSNAP -offset indent
+.Pp
+.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact
.It Dv ATMIO_TRAFFIC_UBR
.It Dv ATMIO_TRAFFIC_CBR
.It Dv ATMIO_TRAFFIC_ABR
@@ -268,22 +290,28 @@ struct ng_atm_cpcs_init {
};
.Ed
.Pp
-.Dv name
+The
+.Va name
+field
is the name of the hook for which sending and receiving should be enabled.
This hook must already be connected.
-.Dv vpi
+The
+.Va vpi
and
-.Dv vci
+.Va vci
+fields
are the respective VPI and VCI values to use for the ATM cells.
They must be
within the range, given by the
-.Dv maxvpi
+.Va maxvpi
and
-.Dv maxvci
+.Va maxvci
fields of the
-.Dv ng_atm_config
+.Vt ng_atm_config
structure.
-.Dv flags
+The
+.Va flags
+field
contains the flags (see above) and the other fields describe the
type of traffic.
.It Dv NGM_ATM_CPCS_TERM
@@ -297,12 +325,12 @@ struct ng_atm_cpcs_term {
.El
.Sh MANAGEMENT MESSAGES
If the
-.Dv manage
-hook is connected certain messages are sent along the hook.
+.Va manage
+hook is connected, certain messages are sent along the hook.
They are
received by the peer node with a cookie of
.Dv NG_ATM_COOKIE .
-.Bl -tag -width xxx
+.Bl -tag -width 4n
.It Dv NGM_ATM_CARRIER_CHANGE
The carrier state of the ATM physical interface has changed.
The message has the following structure:
@@ -313,17 +341,21 @@ struct ng_atm_carrier_change {
};
.Ed
.Pp
-.Dv node
-is the node Id of the ATM node.
+The
+.Va node
+field
+is the node ID of the ATM node.
This can be used by the managing entity
(for example
.Xr ilmid 8 )
to manage several interfaces at the same time through the same node.
-.Dv state is 1 if the carrier was detected and 0 if it was lost.
+The
+.Va state
+field is 1 if the carrier was detected, and 0 if it was lost.
.It Dv NGM_ATM_VCC_CHANGE
A permanent VCC has been added, deleted or changed.
This is used by
-.Xr ilmid
+.Xr ilmid 8
to generate the appropriate ILMI traps.
The structure of the message is:
.Bd -literal
@@ -335,39 +367,43 @@ struct ng_atm_vcc_change {
};
.Ed
Where
-.Dv state
-is 0 if the PVC was deleted and 1 if it was added or modified.
+.Va state
+is 0 if the PVC was deleted, and 1 if it was added or modified.
.El
.Sh FLOW CONTROL
-If the hardware driver supports it the node can emit flow control messages
+If the hardware driver supports it, the node can emit flow control messages
along a user hook.
The format of these messages is described in
-.Pa netgraph/ng_message.h .
+.In netgraph/ng_message.h .
The
-.Nm
+.Nm atm
node may generate
-.Dv NGM_HIGH_WATER_PASSED and NGM_LOW_WATER_PASSED
+.Dv NGM_HIGH_WATER_PASSED
+and
+.Dv NGM_LOW_WATER_PASSED
messages.
The first one indicates that the hardware driver has stopped output
on the channel and drops new packets, the second one reports that
output was reenabled.
-Currently the structures are not filled with
+Currently, the structures are not filled with
information.
.Sh SHUTDOWN
The nodes are persistent as long as the corresponding interface exists.
Upon receipt of a
.Dv NGM_SHUTDOWN
-messages all hooks are disconnected and the node is reinitialized.
+messages, all hooks are disconnected and the node is reinitialized.
All
-VCCs opened via netgraph are closed.
-When the ATM interface is unloaded
+VCCs opened via
+.Xr netgraph 4
+are closed.
+When the ATM interface is unloaded,
the node disappears.
If the node is compiled with
.Dv NGATM_DEBUG
there is a sysctl
-.Cm net.graph.atm.allow_shutdown
-which when set to a non-zero values allows the nodes to shut down.
-Note, that this is intended for development only and may lead to kernel
+.Va net.graph.atm.allow_shutdown
+which, when set to a non-zero value, allows the nodes to shut down.
+Note that this is intended for development only and may lead to kernel
panics if set.
.Sh SEE ALSO
.Xr natm 4 ,
@@ -375,4 +411,4 @@ panics if set.
.Xr ng_ether 4 ,
.Xr ngctl 8
.Sh AUTHORS
-.An Harti Brandt Aq harti@freebsd.org
+.An Harti Brandt Aq harti@FreeBSD.org
diff --git a/share/man/man4/ng_atmllc.4 b/share/man/man4/ng_atmllc.4
index 8dc67d5..81768b5 100644
--- a/share/man/man4/ng_atmllc.4
+++ b/share/man/man4/ng_atmllc.4
@@ -43,37 +43,36 @@ SubNetwork Attachment Point (SNAP) header.
This node currently handles the Ethernet and FDDI protocols.
.Pp
The node transmits and receives ATM PDUs on the
-.Dv atm
+.Va atm
hook.
Received PDUs are decoded and forwarded to the
-.Dv ether
+.Va ether
or
-.Dv fddi
+.Va fddi
hooks as appropriate.
Data received on the
-.Dv ether
+.Va ether
or
-.Dv fddi
-hooks are assumed to be full ethernet or fddi packets as appropriate and are
+.Va fddi
+hooks are assumed to be full Ethernet or FDDI packets as appropriate and are
encapsulated into a PDU and transmitted via the
-.Dv atm
+.Va atm
hook.
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -width foobar
-.It Dv atm
+.Bl -tag -width indent
+.It Va atm
ATM connection.
-Typically this hook would be connected to a
+Typically, this hook would be connected to a
.Xr ng_atm 4
node, which handles transmission of ATM PDUs over an ATM device.
-.It Dv ether
+.It Va ether
Ethernet connection.
-This hook sends and receives ethernet frames.
+This hook sends and receives Ethernet frames.
This would normally be connected to an
.Xr ng_eiface 4
node if in use.
-.It Dv fddi
+.It Va fddi
FDDI connection.
This hook sends and receives FDDI frames.
.El
diff --git a/share/man/man4/ng_atmpif.4 b/share/man/man4/ng_atmpif.4
index 8e73e0e..b98eb9d 100644
--- a/share/man/man4/ng_atmpif.4
+++ b/share/man/man4/ng_atmpif.4
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" Author: Hartmut Brandt <harti@freebsd.org>
+.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\" Author: Vincent Jardin <vjardin@free.fr>
.\"
.\" $FreeBSD$
@@ -39,17 +39,17 @@
.Nm ng_atmpif
.Nd netgraph HARP/ATM Virtual Physical Interface
.Sh SYNOPSIS
-.Fd #include <netgraph/netgraph.h>
-.Fd #include <netgraph/atm/ng_atmpif.h>
+.In netgraph/netgraph.h
+.In netgraph/atm/ng_atmpif.h
.Sh DESCRIPTION
The
-.Nm
+.Nm atmpif
netgraph node type allows the emulation of
.Xr atm 8
(netatm/HARP) Physical devices (PIF) to be connected to the
.Xr netgraph 4
networking subsystem.
-Moreover it includes protection of the PDU against duplication and
+Moreover, it includes protection of the PDU against duplication and
desequencement.
It supports up to 65535 VCs and up to 255 VPs.
AAL0, AAL3/4 and AAL5
@@ -61,13 +61,14 @@ stack when one does not have an ATM board or when the available boards do not
have enough features.
.Pp
When a node
-.Nm
is created, a PIF is created automatically.
-It is named hvaX.
+It is named
+.Li hvaX .
It has the same features as any other HARP devices.
The PIF is removed when the node is removed.
.Sh HOOKS
-There is only one hook: link.
+There is only one hook:
+.Va link .
This hook can be connected to any other
Netgraph node.
For example, in order
@@ -76,12 +77,15 @@ to test the HARP stack over UDP, it can be connected on a
node.
.Sh CONTROL MESSAGES
This node type supports the generic messages plus the following:
-.Bl -tag -width xxx
-.It Dv NGM_ATMPIF_SET_CONFIG Ta setconfig
+.Pp
+.Bl -tag -width indent -compact
+.It Dv NGM_ATMPIF_SET_CONFIG Pq Li setconfig
Configures the debugging features of the node and a virtual
Peak Cell Rate (PCR).
-It uses the same structure as NGM_ATMPIF_GET_CONFIG.
-.It Dv NGM_ATMPIF_GET_CONFIG Ta getconfig
+It uses the same structure as
+.Dv NGM_ATMPIF_GET_CONFIG .
+.Pp
+.It Dv NGM_ATMPIF_GET_CONFIG Pq Li getconfig
Returns a structure defining the configuration of the interface:
.Bd -literal
struct ng_vatmpif_config {
@@ -91,12 +95,15 @@ struct ng_vatmpif_config {
};
.Ed
Note that the following debugging flags can be used:
-.Bl -column ATM_PH_LLCSNAP -offset indent
-.It Dv VATMPIF_DEBUG_NONE Ta disable debugging
-.It Dv VATMPIF_DEBUG_PACKET Ta enable debugging
+.Pp
+.Bl -tag -width ".Dv VATMPIF_DEBUG_PACKET" -offset indent -compact
+.It Dv VATMPIF_DEBUG_NONE
+disable debugging
+.It Dv VATMPIF_DEBUG_PACKET
+enable debugging
.El
.Pp
-.It Dv NGM_ATMPIF_GET_LINK_STATUS Ta getlinkstatus
+.It Dv NGM_ATMPIF_GET_LINK_STATUS Pq Li getlinkstatus
Returns the last received sequence number, the last sent sequence
number and the current total PCR that is reserved among all the VCCs
of the interface.
@@ -108,10 +115,10 @@ struct ng_atmpif_link_status {
};
.Ed
.Pp
-.It Dv NGM_ATMPIF_GET_STATS Ta getstats
-.It Dv NGM_ATMPIF_CLR_STATS Ta clrstats
-.It Dv NGM_ATMPIF_GETCLR_STATS Ta getclrstats
-It returns the node's statistics, it clears them or it returns and reset
+.It Dv NGM_ATMPIF_GET_STATS Pq Li getstats
+.It Dv NGM_ATMPIF_CLR_STATS Pq Li clrstats
+.It Dv NGM_ATMPIF_GETCLR_STATS Pq Li getclrstats
+It returns the node's statistics, it clears them or it returns and resets
their values to 0.
The following stats are provided.
.Bd -literal
@@ -149,5 +156,5 @@ struct hva_stats_aal5 {
.Xr ng_ksocket 4 ,
.Xr ngctl 8
.Sh AUTHORS
-.An Harti Brandt Aq harti@freebsd.org
+.An Harti Brandt Aq harti@FreeBSD.org
.An Vincent Jardin Aq vjardin@wanadoo.fr
diff --git a/share/man/man4/ng_sppp.4 b/share/man/man4/ng_sppp.4
index 0257d28..572cc52 100644
--- a/share/man/man4/ng_sppp.4
+++ b/share/man/man4/ng_sppp.4
@@ -22,79 +22,88 @@
.In netgraph/ng_sppp.h
.Sh DESCRIPTION
An
-.Nm ng_sppp
+.Nm sppp
node is a
.Xr netgraph 4
interface to the original
.Xr sppp 4
network module for synchronous lines.
-Currently
+Currently,
.Xr sppp 4
-supports PPP and Cisco HDLC protocol.
+supports PPP and Cisco HDLC protocols.
An
-.Nm ng_sppp
-node could be considered as an alternative kernel mode ppp
+.Nm sppp
+node could be considered as an alternative kernel mode PPP
implementation to
-.Xr mpd ports +
-.Xr ng_ppp 4
+.Pa net/mpd
+port +
+.Xr ng_ppp 4 ,
and as an alternative to
.Xr ng_cisco 4
node.
-While having less features than mpd +
+While having less features than
+.Pa net/mpd
++
.Xr ng_ppp 4 ,
-it is significantly easier to use in the majority of simple configurations
-and allows the administrator to not install the mpd port.
+it is significantly easier to use in the majority of simple configurations,
+and allows the administrator to not install the
+.Pa net/mpd
+port.
With
-.Nm ng_sppp
-you don't need any other nodes, not even an
+.Nm sppp
+you do not need any other nodes, not even an
.Xr ng_iface 4
node.
When an
-.Nm ng_sppp
+.Nm sppp
node is created, a new interface appears which is accessible via
.Xr ifconfig 8 .
-.Nm ng_sppp
-node interfaces are named
-.Dv sppp0 ,
-.Dv sppp1 ,
+Network interfaces corresponding to
+.Nm sppp
+nodes are named
+.Li sppp0 , sppp1 ,
etc.
-When a node is shutdown, the corresponding interface is removed
+When a node is shut down, the corresponding interface is removed,
and the interface name becomes available for reuse by future
-.Nm ng_sppp
+.Nm sppp
nodes.
New nodes always take the first unused interface.
The node itself is assigned the same name as its interface, unless the name
already exists, in which case the node remains unnamed.
The
-.Nm ng_sppp
-node allows drivers written to the old sppp interface to be rewritten using the
+.Nm sppp
+node allows drivers written to the old
+.Xr sppp 4
+interface to be rewritten using the
newer more powerful
.Xr netgraph 4
-interface and still behave in a compatible manner without supporting both
+interface, and still behave in a compatible manner without supporting both
network modules.
.Pp
An
-.Nm ng_sppp
-node has a single hook named downstream.
+.Nm sppp
+node has a single hook named
+.Va downstream .
Usually it is connected directly to
a device driver hook.
.Pp
-.Nm ng_sppp
-nodes support the Berkeley Packet Filter (BPF).
+The
+.Nm sppp
+nodes support the Berkeley Packet Filter,
+.Xr bpf 4 .
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -width abcdefghijklmnop
-.It Dv downstream
+.Bl -tag -width ".Va downstream"
+.It Va downstream
The connection to the synchronous line.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width foo
+.Bl -tag -width indent
.It Dv NGM_IFACE_GET_IFNAME
Returns the name of the interface corresponding to this node in a
-.Dv "struct ng_iface_ifname" :
-.Bd -literal -offset 4n
+.Vt "struct ng_iface_ifname" :
+.Bd -literal -offset indent
struct ng_iface_ifname {
char ngif_name[NG_SPPP_IFACE_NAME_MAX + 1];
};
@@ -106,29 +115,38 @@ This node shuts down upon receipt of a
control message.
The associated interface is removed and becomes available
for use by future
-.Nm ng_sppp
+.Nm sppp
nodes.
.Pp
Unlike most other node types and like
.Xr ng_iface 4
does, an
-.Nm ng_sppp
+.Nm sppp
node does
.Em not
-go away when all hooks have been disconnected; rather, and explicit
+go away when all hooks have been disconnected; rather, an explicit
.Dv NGM_SHUTDOWN
control message is required.
.Sh EXAMPLES
-For example, if you have
-.Xr cx 4 device, you could run PPP over it with just one command:
+For example, if you have the
+.Xr cx 4
+device, you could run PPP over it with just one command:
.Pp
-ngctl mkpeer cx0: sppp rawdata downstream
+.Dl "ngctl mkpeer cx0: sppp rawdata downstream"
.Pp
-Now you have sppp0 interface (if this is a first sppp node) which can be
-managed via
-.Xr ifconfig 4 as a usual network interface,
+Now you have the
+.Li sppp0
+interface (if this was the first
+.Nm sppp
+node) which can be
+accessed via
+.Xr ifconfig 8
+as a normal network interface,
or via
-.Xr spppcontrol 8 as a sppp interface.
+.Xr spppcontrol 8
+as an
+.Xr sppp 4
+interface.
.Sh SEE ALSO
.Xr bpf 4 ,
.Xr cx 4 ,
@@ -146,10 +164,11 @@ For complex networking topologies you may want to look at
port.
.Sh HISTORY
The
-.Nm ng_sppp
+.Nm sppp
node type was implemented for
.Fx 5.0 .
It was included to the system since
.Fx 5.3 .
-.Sh AUTHOR
-.An Copyright (C) 2003-2004 Roman Kurakin Aq rik@cronyx.ru
+.Sh AUTHORS
+Copyright (C) 2003-2004
+.An Roman Kurakin Aq rik@cronyx.ru .
diff --git a/share/man/man4/ng_sscfu.4 b/share/man/man4/ng_sscfu.4
index 286c52a..0679d58 100644
--- a/share/man/man4/ng_sscfu.4
+++ b/share/man/man4/ng_sscfu.4
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" Author: Hartmut Brandt <harti@freebsd.org>
+.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\"
.\" $FreeBSD$
.\"
@@ -37,13 +37,13 @@
.Nm ng_sscfu
.Nd netgraph SSCF at the UNI node type
.Sh SYNOPSIS
-.Fd #include <netnatm/saal/sscopdef.h>
-.Fd #include <netnatm/saal/sscfudef.h>
-.Fd #include <netgraph/atm/ng_sscfu.h>
+.In netnatm/saal/sscopdef.h
+.In netnatm/saal/sscfudef.h
+.In netgraph/atm/ng_sscfu.h
.Sh DESCRIPTION
The
-.Nm
-netgraph node implements ITU-T recommendation Q.2130.
+.Nm sscfu
+netgraph node type implements ITU-T recommendation Q.2130.
This recommendation specifies the Service Specific Coordination
Function at the UNI.
This is a thin sub-layer between the SSCOP (see
@@ -51,29 +51,31 @@ This is a thin sub-layer between the SSCOP (see
and the UNI signalling.
This node does not really implement a protocol but
provides a mapping between the signals at the upper layer of the SSCOP and
-the signals, the UNI expects at its lower layer.
+the signals the UNI expects at its lower layer.
It also provides default values for the parameters of the SSCOP.
.Pp
After creation of the node, the SSCF instance must be created by sending
-an enable message to the node.
+an
+.Dq enable
+message to the node.
If the node is enabled, default SSCOP parameters
-can be retrieved and and set in the corresponding SSCOP instance.
+can be retrieved and set in the corresponding SSCOP instance.
.Pp
-The node is shutdown either by a
+The node is shut down either by a
.Dv NGM_SHUTDOWN
-message or when all hooks are disconnected.
+message, or when all hooks are disconnected.
.Sh HOOKS
Each
-.Nm
+.Nm sscfu
node has two hooks with fixed names:
-.Bl -tag -width upper
-.It Dv lower
+.Bl -tag -width ".Va upper"
+.It Va lower
This hook is the interface to the SSCOP.
The interface expected here is exactly
that which is exported by the
.Xr ng_sscop 4
node type.
-.It Dv upper
+.It Va upper
This is the interface to the UNI.
It uses the following message format:
.Bd -literal
@@ -83,7 +85,9 @@ struct sscfu_arg {
};
.Ed
.Pp
-.Fa sig
+The
+.Va sig
+field
is one of the following signals:
.Bd -literal
enum saal_sig {
@@ -100,29 +104,29 @@ enum saal_sig {
};
.Ed
.Pp
-The arrows in the comment show the direction of the signal whether it
+The arrows in the comment show the direction of the signal, whether it
is a signal that comes out of the node
-.Ql ->
+.Pq Ql -> ,
or is sent by the node user to the node
-.Ql <- .
-The type of data expected for the signal is specified in parentheses.
+.Pq Ql <- .
+The type of the data expected for the signal is specified in parentheses.
This data starts at the
-.Fa data
+.Va data
field of the message structure.
.El
.Pp
If the
-.Dv lower
+.Va lower
hook is disconnected and the node is enabled, the protocol state is
reset.
.Sh CONTROL MESSAGES
The
-.Nm
+.Nm sscfu
node understands the generic messages plus the following:
-.Bl -tag -width xxx
+.Bl -tag -width indent
.It Dv NGM_SSCFU_GETDEFPARAM
This message returns a
-.Fa sscop_param
+.Vt sscop_param
structure, which contains the default parameters for the SSCOP at the
UNI.
This structure should be used for a
@@ -130,20 +134,21 @@ This structure should be used for a
message to the SSCOP node below the SSCF.
.It Dv NGM_SSCFU_ENABLE
This message creates the actual SSCF instance and initializes it.
-Until this is done, parameters may not be retrieved not set and all message
+Until this is done, parameters may neither be retrieved nor set,
+and all messages
received on any hook are discarded.
.It Dv NGM_SSCFU_DISABLE
Destroy the SSCF instance.
-After this all messages on any hooks are discarded.
+After this, all messages on any hooks are discarded.
.It Dv NGM_SSCFU_GETDEBUG
-Retrieve the debugging flags in an
+Retrieve the debugging flags in a
.Vt uint32_t .
.It Dv NGM_SSCFU_SETDEBUG
Set debugging flags.
-The argument must be an
+The argument must be a
.Vt uint32_t .
.It Dv NGM_SSCFU_GETSTATE
-Retrieve the current state of the SSCFU instance in an
+Retrieve the current state of the SSCFU instance in a
.Vt uint32_t .
If the node has not been enabled, 0 is returned.
.El
@@ -153,4 +158,4 @@ If the node has not been enabled, 0 is returned.
.Xr ng_sscop 4 ,
.Xr ngctl 8
.Sh AUTHORS
-.An Harti Brandt Aq harti@freebsd.org
+.An Harti Brandt Aq harti@FreeBSD.org
diff --git a/share/man/man4/ng_sscop.4 b/share/man/man4/ng_sscop.4
index 08d6908..86d9c2a 100644
--- a/share/man/man4/ng_sscop.4
+++ b/share/man/man4/ng_sscop.4
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" Author: Hartmut Brandt <harti@freebsd.org>
+.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\"
.\" $FreeBSD$
.\"
@@ -37,54 +37,56 @@
.Nm ng_sscop
.Nd netgraph SSCOP node type
.Sh SYNOPSIS
-.Fd #include <netnatm/saal/sscopdef.h>
-.Fd #include <netgraph/atm/ng_sscop.h>
+.In netnatm/saal/sscopdef.h
+.In netgraph/atm/ng_sscop.h
.Sh DESCRIPTION
The
-.Nm
-netgraph node implements the ITU-T standard Q.2110.
+.Nm sscop
+netgraph node type implements the ITU-T standard Q.2110.
This standard describes
the so called Service Specific Connection Oriented Protocol (SSCOP) that
is used to carry signalling messages over the private and public UNIs and
the public NNI.
This protocol is a transport protocol with selective
-acknowledgements and can be tailored to the environment.
+acknowledgements, and can be tailored to the environment.
This implementation is a full implementation of that standard.
.Pp
After creation of the node, the SSCOP instance must be created by sending
-an enable message to the node.
+an
+.Dq enable
+message to the node.
If the node is enabled, the SSCOP parameters
can be retrieved and modified and the protocol can be started.
.Pp
-The node is shutdown either by a
+The node is shut down either by a
.Dv NGM_SHUTDOWN
-message or when all hooks are disconnected.
+message, or when all hooks are disconnected.
.Sh HOOKS
Each
-.Nm
+.Nm sscop
node has three hooks with fixed names:
-.Bl -tag -width manage
-.It Dv lower
-This hook is the hook that must be connected to a node that ensures
+.Bl -tag -width ".Va manage"
+.It Va lower
+This hook must be connected to a node that ensures
transport of packets to and from the remote peer node.
Normally this is a
.Xr ng_atm 4
node with an AAL5 hook, but the
-.Nm
+.Nm sscop
node is able to work on any packet-transporting layer, like, for example,
IP or UDP.
The node handles flow control messages received on
this hook: if it receives a
.Dv NGM_HIGH_WATER_PASSED
-message it declares the
-.Ql lower layer busy
+message, it declares the
+.Dq "lower layer busy"
state.
If a
.Dv NGM_LOW_WATER_PASSED
-message is received the busy state is cleared.
-Note, that the node does not
+message is received, the busy state is cleared.
+Note that the node does not
look at the message contents of these flow control messages.
-.It Dv upper
+.It Va upper
This is the interface to the SSCOP user.
This interface uses the following message format:
.Bd -literal
@@ -95,7 +97,9 @@ struct sscop_arg {
};
.Ed
.Pp
-.Fa sig
+The
+.Va sig
+field
is one of the signals defined in the standard:
.Bd -literal
enum sscop_aasig {
@@ -128,33 +132,41 @@ enum sscop_aasig {
};
.Ed
.Pp
-The arrows in the comment show the direction of the signal whether it
+The arrows in the comment show the direction of the signal, whether it
is a signal that comes out of the node
-.Ql ->
+.Pq Ql -> ,
or is sent by the node user to the node
-.Ql <- .
+.Pq Ql <- .
The
-.Fa arg
+.Va arg
field contains the argument to some of the signals: it is either a PDU
-sequence number or the
+sequence number, or the
.Dv CLEAR-BUFFER
flag.
There are a number of special sequence numbers for some operations:
-.Bl -column SSCOP_RETRIEVE_UNKNOWN -offset indent
-.It Dv SSCOP_MAXSEQNO Ta maximum legal sequence number
-.It Dv SSCOP_RETRIEVE_UNKNOWN Ta retrieve transmission queue
-.It Dv SSCOP_RETRIEVE_TOTAL Ta retrieve transmission buffer and queue
+.Pp
+.Bl -tag -width ".Dv SSCOP_RETRIEVE_UNKNOWN" -offset indent -compact
+.It Dv SSCOP_MAXSEQNO
+maximum legal sequence number
+.It Dv SSCOP_RETRIEVE_UNKNOWN
+retrieve transmission queue
+.It Dv SSCOP_RETRIEVE_TOTAL
+retrieve transmission buffer and queue
.El
.Pp
For signals that carry user data (as, for example,
.Dv SSCOP_DATA_request )
these two fields are followed by the variable sized user data.
.Pp
-If the upper hook is disconnected and the SSCOP instance is not in the idle
-state and the lower hook is still connected, an
+If the
+.Va upper
+hook is disconnected and the SSCOP instance is not in the idle
+state, and the
+.Va lower
+hook is still connected, an
.Dv SSCOP_RELEASE_request
is executed to release the SSCOP connection.
-.It Dv manage
+.It Va manage
This is the management interface defined in the standard.
The data structure used here is:
.Bd -literal
@@ -165,7 +177,7 @@ struct sscop_marg {
.Ed
.Pp
Here
-.Dv sig
+.Va sig
is one of
.Bd -literal
enum sscop_maasig {
@@ -187,13 +199,14 @@ struct sscop_merr {
uint32_t cnt; /* error count */
};
.Ed
+.El
.Sh CONTROL MESSAGES
The
-.Nm
-node understands the generic messages plus the following:
-.Bl -tag -width xxx
+.Nm sscop
+node understands the generic control messages, plus the following:
+.Bl -tag -width indent
.It Dv NGM_SSCOP_SETPARAM
-Set operational parameters of the SSCOP instance and takes the
+Sets operational parameters of the SSCOP instance and takes the
following structure:
.Bd -literal
struct ng_sscop_setparam {
@@ -203,10 +216,10 @@ struct ng_sscop_setparam {
.Ed
.Pp
The sub-structure
-.Dv param
-contains the parameters to set and the
-.Dv mask
-field contains a bit mask, telling which of the parameters to set and which
+.Va param
+contains the parameters to set, and the
+.Va mask
+field contains a bit mask, telling which of the parameters to set, and which
to ignore.
If a bit is set, the corresponding parameter is set.
The parameters are:
@@ -228,28 +241,57 @@ struct sscop_param {
.Ed
.Pp
The
-.Dv flags
+.Va flags
field contains the following flags influencing SSCOP operation:
-.Bl -column SSCOP_POLLREX -offset indent
-.It Dv SSCOP_ROBUST Ta enable atmf/97-0216 robustness enhancement
-.It Dv SSCOP_POLLREX Ta send POLL after each retransmission
+.Pp
+.Bl -tag -width ".Dv SSCOP_POLLREX" -offset indent -compact
+.It Dv SSCOP_ROBUST
+enable atmf/97-0216 robustness enhancement
+.It Dv SSCOP_POLLREX
+send POLL after each retransmission
.El
.Pp
The bitmap has the following bits:
-.Bl -column SSCOP_POLLREXx -offset indent
-.It Dv SSCOP_SET_TCC Ta set Dv timer_cc
-.It Dv SSCOP_SET_TPOLL Ta set Dv timer_poll
-.It Dv SSCOP_SET_TKA Ta set Dv timer_keep_alive
-.It Dv SSCOP_SET_TNR Ta set Dv timer_no_response
-.It Dv SSCOP_SET_TIDLE Ta set Dv timer_idle
-.It Dv SSCOP_SET_MAXK Ta set Dv maxk
-.It Dv SSCOP_SET_MAXJ Ta set Dv maxj
-.It Dv SSCOP_SET_MAXCC Ta set Dv maxcc
-.It Dv SSCOP_SET_MAXPD Ta set Dv maxpd
-.It Dv SSCOP_SET_MAXSTAT Ta set Dv maxstat
-.It Dv SSCOP_SET_MR Ta set the initial window
-.It Dv SSCOP_SET_ROBUST Ta set or clear Dv SSCOP_ROBUST
-.It Dv SSCOP_SET_POLLREX Ta set or clear Dv SSCOP_POLLREX
+.Pp
+.Bl -tag -width ".Dv SSCOP_SET_POLLREX" -offset indent -compact
+.It Dv SSCOP_SET_TCC
+set
+.Va timer_cc
+.It Dv SSCOP_SET_TPOLL
+set
+.Va timer_poll
+.It Dv SSCOP_SET_TKA
+set
+.Va timer_keep_alive
+.It Dv SSCOP_SET_TNR
+set
+.Va timer_no_response
+.It Dv SSCOP_SET_TIDLE
+set
+.Va timer_idle
+.It Dv SSCOP_SET_MAXK
+set
+.Va maxk
+.It Dv SSCOP_SET_MAXJ
+set
+.Va maxj
+.It Dv SSCOP_SET_MAXCC
+set
+.Va maxcc
+.It Dv SSCOP_SET_MAXPD
+set
+.Va maxpd
+.It Dv SSCOP_SET_MAXSTAT
+set
+.Va maxstat
+.It Dv SSCOP_SET_MR
+set the initial window
+.It Dv SSCOP_SET_ROBUST
+set or clear
+.Dv SSCOP_ROBUST
+.It Dv SSCOP_SET_POLLREX
+set or clear
+.Dv SSCOP_POLLREX
.El
.Pp
The node responds to the
@@ -263,98 +305,99 @@ struct ng_sscop_setparam_resp {
.Ed
.Pp
Here
-.Dv mask
-contains the a bitmask of the parameters that the user requested to set,
+.Va mask
+contains a bitmask of the parameters that the user requested to set,
but that could not be set and
-.Dv error
+.Va error
is an
.Xr errno 3
code describing why the parameter could not be set.
.It Dv NGM_SSCOP_GETPARAM
This message returns the current operational parameters of the SSCOP
instance in a
-.Fa sscop_param
+.Vt sscop_param
structure.
.It Dv NGM_SSCOP_ENABLE
This message creates the actual SSCOP instance and initializes it.
-Until this is done, parameters may neither be retrieved not set and all
-message received on any hook are discarded.
+Until this is done, parameters may neither be retrieved nor set, and all
+messages received on any hook are discarded.
.It Dv NGM_SSCOP_DISABLE
Destroy the SSCOP instance.
-After this all messages on any hooks are
+After this, all messages on any hooks are
discarded.
.It Dv NGM_SSCOP_SETDEBUG
Set debugging flags.
-The argument is an
+The argument is a
.Vt uint32_t .
.It Dv NGM_SSCOP_GETDEBUG
Retrieve the actual debugging flags.
-Needs no arguments and responds with an
+Needs no arguments and responds with a
.Vt uint32_t .
.It Dv NGM_SSCOP_GETSTATE
-Responds with the current state of the SSCOP instance in an
+Responds with the current state of the SSCOP instance in a
.Vt uint32_t .
-If the node is not enabled the retrieved state is 0.
+If the node is not enabled, the retrieved state is 0.
.El
.Sh FLOW CONTROL
Flow control works on the upper and on the lower layer interface.
At the lower
-layer interface the two messages
+layer interface, the two messages,
.Dv NGM_HIGH_WATER_PASSED
and
-.Dv NGM_LOW_WATER_PASSED
+.Dv NGM_LOW_WATER_PASSED ,
are used to declare or clear the
-.Ql lower layer busy
+.Dq "lower layer busy"
state of the protocol.
.Pp
-At the upper layer interface the
-.Nm
+At the upper layer interface, the
+.Nm sscop
node handles three types of flow control messages:
-.Bl -tag -width xxx
+.Bl -tag -width indent
.It Dv NGM_HIGH_WATER_PASSED
-If this message is received the SSCOP stops moving the receive window.
-Each time a data message is handed over to the upper layer the receive
+If this message is received, the SSCOP stops moving the receive window.
+Each time a data message is handed over to the upper layer, the receive
window is moved by one message.
Stopping these updates
means that the window will start to close and if the peer has sent
all messages allowed by the current window, it stops transmission.
-This means, that the upper layer must be able to receive still a full window
+This means that the upper layer must be able to still receive a full window
amount of messages.
.It Dv NGM_LOW_WATER_PASSED
-This will re-enable the automatic window updates and if the space indicated
+This will re-enable the automatic window updates, and if the space indicated
in the message is larger than the current window, the window will be opened
by that amount.
The space is computed as the difference of the
-.Fa max_queuelen_packets
+.Va max_queuelen_packets
and
-.Fa current
+.Va current
members of the
-.Fa ngm_queue_state
+.Vt ngm_queue_state
structure.
.It Dv NGM_SYNC_QUEUE_STATE
-If the upper layer buffer filling state as indicated by
-.Fa current
-is equal too or higher than
-.Fa high_watermark
-than the message is ignored.
-If this is not the case the amount
+If the upper layer buffer filling state, as indicated by
+.Va current ,
+is equal to or greater than
+.Va high_watermark
+then the message is ignored.
+If this is not the case, the amount
of receiver space is computed as the difference of
-.Fa max_queuelen_packets
+.Va max_queuelen_packets
and
-.Fa current ,
-if automatic window updates are currently allowed and as the difference of
-.Fa high_water_mark
+.Va current
+if automatic window updates are currently allowed, and as the difference of
+.Va high_water_mark
and
-.Fa current ,
+.Va current
if window updates are disabled.
If the resulting value is larger than the current window, the current window
is opened up to this value.
-Automatic window updates are enabled, if they
+Automatic window updates are enabled if they
were disabled.
+.El
.Sh SEE ALSO
.Xr netgraph 4 ,
.Xr ng_atm 4 ,
.Xr ng_sscfu 4 ,
.Xr ngctl 8
.Sh AUTHORS
-.An Harti Brandt Aq harti@freebsd.org
+.An Harti Brandt Aq harti@FreeBSD.org
diff --git a/share/man/man4/ng_uni.4 b/share/man/man4/ng_uni.4
index 73bfc7b..b1d3118 100644
--- a/share/man/man4/ng_uni.4
+++ b/share/man/man4/ng_uni.4
@@ -3,7 +3,7 @@
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
.\" All rights reserved.
.\"
-.\" Author: Hartmut Brandt <harti@freebsd.org>
+.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -39,31 +39,33 @@
.In netgraph/atm/ng_uni.h
.Sh DESCRIPTION
The
-.Nm
-netgraph node implements ATM Forum signalling 4.0.
+.Nm uni
+netgraph node type implements ATM Forum signalling 4.0.
.Pp
After creation of the node, the UNI instance must be created by sending
-an enable message to the node.
+an
+.Dq enable
+message to the node.
If the node is enabled, the UNI parameters
-can be retrieved and modified and the protocol can be started.
+can be retrieved and modified, and the protocol can be started.
.Pp
-The node is shutdown either by a
+The node is shut down either by an
.Dv NGM_SHUTDOWN
-message or when all hooks are disconnected.
+message, or when all hooks are disconnected.
.Sh HOOKS
Each
-.Nm
+.Nm uni
node has three hooks with fixed names:
-.Bl -tag -width xxx
-.It Dv lower
+.Bl -tag -width ".Va upper"
+.It Va lower
This hook is the interface of the UNI protocol to the transport layer of
the ATM control plane.
The node expects the interface exported by
.Xr ng_sscfu 4
at this hook.
-.It Dv upper
+.It Va upper
This hook is the
-.Ql user
+.Dq user
interface of the UNI protocol.
Because there is no standardized interface
at this point, this implementation follows more or less the interface
@@ -72,18 +74,18 @@ Normally either a
.Xr ng_ccatm 4
or a switch CAC should be stacked at this interface.
The message format at the
-.Dv upper
+.Va upper
hook is described below.
Because
-.Xt netgraph 4
+.Xr netgraph 4
is functional, it makes sometimes sense to switch this hook to queueing mode
from the peer node upon connection.
.El
.Pp
The
-.Dv upper
+.Va upper
interface of the
-.Nm
+.Nm uni
node is loosely modelled after the interface specified in the ITU-T signalling
standards.
There is however one derivation from this: normally there exists
@@ -91,40 +93,40 @@ four kinds of signals: requests, responses, indications and confirmations.
These signals are usually triggered either by external events (receiving a
message) or internal events (a timer or another signal).
This scheme works
-fine for user APIs that are entirely asynchronous and in cases, where
+fine for user APIs that are entirely asynchronous, and in cases where
error handling is not taken into account.
With synchronous APIs and error
-handling, however there is a problem.
+handling however, there is a problem.
If, for example, the application
-issues a request to setup a connection.
-It may do it by sending a
+issues a request to set up a connection,
+it may do it by sending a
.Dv SETUP.request
signal to the UNI.
-Normally the UNI stack will send a SETUP message and
+Normally, the UNI stack will send a SETUP message and
receive a message from the switch (a RELEASE, CONNECT, CALL PROCEEDING or
-ALERTING) or a timer in the UNI stack will time out.
-In any of these cases
-the UNI stack is supposed to report an event back to the application and
+ALERTING), or a timer in the UNI stack will time out.
+In any of these cases,
+the UNI stack is supposed to report an event back to the application, and
the application will unblock (in the case of a synchronous API) and handle
the event.
-The problem occurs, when an error happens.
+The problem occurs when an error happens.
Suppose there is no
memory to send the SETUP message and to start the timer.
-In this case the
-application will block forever, because no received message and no timer
+In this case, the
+application will block forever because no received message and no timer
will wake it up.
For this reason this implementation uses an additional message:
for each signal sent from the application to the stack, the stack will
respond with an error code.
If this code is zero, the stack has accepted
-the signal and the application may block, if the code is non-zero, the signal
-is effectively ignored and the code describes, what was wrong.
+the signal and the application may block; if the code is non-zero, the signal
+is effectively ignored and the code describes what was wrong.
This system
makes it very easy to make a blocking interface out of the message based
netgraph interface.
.Pp
The
-.Dv upper
+.Va upper
interface uses the following structure:
.Bd -literal
struct uni_arg {
@@ -134,17 +136,17 @@ struct uni_arg {
};
.Ed
The
-.Fa sig
-field contains the actual signal that is sent from the user to UNI or the
+.Va sig
+field contains the actual signal that is sent from the user to UNI or from
UNI to the user.
The
-.Fa cookie
+.Va cookie
can be used by the user to correlate requests with events and responses.
If an error response, a confirmation or an indication was triggered by
a request or response, the cookie from that request or response is carried in
the message from the stack to the user.
The
-.Fa cookie
+.Va cookie
field is followed by the actual data for the signal.
.Pp
The signal is one of the following:
@@ -209,7 +211,7 @@ enum uni_sig {
.Pp
The meaning of most of the signals can be deduced from the ITU-T SDLs.
A number of signals, however, is unique to this implementation:
-.Bl -tag -width xxx
+.Bl -tag -width indent
.It Dv UNIAPI_ERROR
This is the error response, mentioned earlier.
It carries an error code or
@@ -220,7 +222,7 @@ from the user requesting an outgoing SETUP.
This may be used to synchronize
the creation and destroying of call data between the UNI stack and the user.
.It Dv UNIAPI_CALL_DESTROYED
-An call instance has been destroyed and all resources have been freed.
+A call instance has been destroyed and all resources have been freed.
.It Dv UNIAPI_PARTY_CREATED
A new party has been created for an existing point-to-multipoint call.
This may be used to synchronize the creation and destroying of party data
@@ -228,7 +230,8 @@ between the UNI stack and the user.
.It Dv UNIAPI_PARTY_DESTROYED
A party has been destroyed and all resources have been freed.
.It Dv UNIAPI_ABORT_CALL_request
-The requests the stack to destroy the call instance and free all it's resources
+This requests the stack to destroy the call instance
+and free all its resources,
without sending any messages to the network.
.It Dv UNIAPI_MAXSIG
This is not a signal, but rather a definition to get the number of defined
@@ -236,12 +239,12 @@ signals.
.El
.Pp
Each of the signals is followed by a fixed size structure defined in
-.Pa unidef.h .
+.In netnatm/sig/unidef.h .
.Sh CONTROL MESSAGES
The
-.Nm
-node understands the standard control messages plus the following:
-.Bl -tag -width xxx
+.Nm uni
+node understands the standard control messages, plus the following:
+.Bl -tag -width indent
.It Dv NGM_UNI_SETDEBUG
Set debugging facility levels.
The UNI stack defines a number of debugging
@@ -256,13 +259,13 @@ struct ngm_uni_debug {
.Ed
.It Dv NGM_UNI_SETDEBUG
Get debugging facility levels.
-This returns a
-.Fa ngm_uni_debug
+This returns an
+.Vt ngm_uni_debug
structure.
.It Dv NGM_UNI_GET_CONFIG
Retrieve the current configuration of the UNI instance.
This message returns a
-.Fa uni_config
+.Vt uni_config
structure:
.Bd -literal
struct uni_config {
@@ -289,7 +292,7 @@ struct uni_config {
.Ed
.Pp
The field
-.Fa proto
+.Va proto
specifies one of the following protocols:
.Bd -literal
enum uni_proto {
@@ -300,7 +303,7 @@ enum uni_proto {
.Ed
.Pp
Some protocols may have options which can be set in
-.Fa popt :
+.Va popt :
.Bd -literal
enum uni_popt {
UNIPROTO_GFP, /* enable GFP */
@@ -308,7 +311,7 @@ enum uni_popt {
.Ed
.Pp
The
-.Fa option
+.Va option
field controls parsing and checking of messages:
.Bd -literal
enum uni_option {
@@ -321,7 +324,7 @@ enum uni_option {
All timer values are given in milliseconds.
Note, however, that the actual
resolution of the timers depend on system configuration (see
-.Xr timeout 9 ).
+.Xr timeout 9 ) .
.It Dv NGM_UNI_SET_CONFIG
Change the UNI configuration.
This takes a
@@ -338,17 +341,17 @@ struct ngm_uni_config_mask {
.Ed
.Pp
The fields of the
-.Fa ngm_uni_config_mask
+.Vt ngm_uni_config_mask
specify which configuration parameter to change.
The
-.Fa mask
+.Va mask
field contains bit definitions for all timers, retransmission counters
and the
-.Fa proto
+.Va proto
field,
-.Fa popt_mask
-selects which of the protocol options to change and
-.Fa option_mask
+.Va popt_mask
+selects which of the protocol options to change, and
+.Va option_mask
specifies which options should be changed.
The following bits are defined:
.Bd -literal
@@ -373,14 +376,14 @@ enum uni_config_mask {
};
.Ed
.Pp
-For the
-.Fa popt_mask
+For
+.Va popt_mask
and
-.Fa option_mask
+.Va option_mask ,
the definitions from
-.Fa "enum uni_popt"
+.Vt "enum uni_popt"
and
-.Fa "enum uni_option"
+.Vt "enum uni_option"
should be used.
.It Dv NGM_UNI_ENABLE
Create the UNI instance and enable processing.
@@ -407,9 +410,10 @@ More testing needed.
PNNI not yet implemented.
.It
Need to implement connection modification and the Q.2931 amendments.
+.El
.Sh AUTHORS
The
-.Nm
+.Nm uni
netgraph node
-and this manual page was written by
-.An Harti Brandt Aq harti@freebsd.org
+and this manual page were written by
+.An Harti Brandt Aq harti@FreeBSD.org
OpenPOWER on IntegriCloud