mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-12-04 08:09:08 +00:00
Fix typos per PR 15649. Also did some rewording for clarity.
PR: docs/15649 Submitted by: Kazuo Horikawa <horikawa@jp.FreeBSD.org>
This commit is contained in:
Archie Cobbs
parent
e54ca68cb8
commit
0f9183be1b
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=55348
@ -56,9 +56,9 @@ hook represents the uncompressed side of the node, while the
|
||||
.Dv vjuncomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes represent the compressed side of the node. Packets received on the
|
||||
hooks represent the compressed side of the node. Packets received on the
|
||||
.Dv ip
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
on the other three hooks will be uncompressed as appropriate.
|
||||
This node also supports
|
||||
.Dq always pass through
|
||||
@ -70,7 +70,7 @@ Only
|
||||
(i.e., common case) TCP packets are actually compressed.
|
||||
These are output on the
|
||||
.Dv vjcomp
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
compressed; these appear on the
|
||||
.Dv vjuncomp
|
||||
hook.
|
||||
@ -85,7 +85,7 @@ node, the
|
||||
.Dv vjcomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes should be connected to the
|
||||
hooks should be connected to the
|
||||
.Xr ng_ppp 8
|
||||
node's
|
||||
.Dv vjc_ip ,
|
||||
@ -93,7 +93,7 @@ node's
|
||||
.Dv vjc_vjuncomp ,
|
||||
and
|
||||
.Dv vjc_ip
|
||||
nodes, respectively.
|
||||
hooks, respectively.
|
||||
.Sh HOOKS
|
||||
This node type supports the following hooks:
|
||||
.Pp
|
||||
@ -113,7 +113,7 @@ This node type supports the generic control messages, plus the following:
|
||||
This command resets the compression state and configures it according
|
||||
to the supplied
|
||||
.Dv "struct ngm_vjc_config"
|
||||
argument. This structure contains the following fields:
|
||||
argument. This structure contains the following fields:
|
||||
.Bd -literal -offset 4n
|
||||
struct ngm_vjc_config {
|
||||
u_char enableComp; /* Enable compression */
|
||||
@ -149,21 +149,22 @@ mode.
|
||||
When enabling compression,
|
||||
.Dv maxChannel
|
||||
should be set to the number of outgoing compression channels minus one,
|
||||
and is a value between 3 and 15, inclusive. Also, the
|
||||
and is a value between 3 and 15, inclusive. The
|
||||
.Dv compressCID
|
||||
field indicates whether it is OK to compress the CID field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
field indicates whether it is OK to compress the CID header field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it is not possible for an outgoing frame to be lost, or
|
||||
(b) lost frames can be reliably detected and immediately
|
||||
reported to the peer's decompression engine (see
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
message is immediately sent whenever this occurs.
|
||||
below).
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
structure, which is defined in
|
||||
.Pa net/slcompress.h .
|
||||
.It Dv NGM_VJC_CLR_STATS
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
.Dv enableComp
|
||||
or
|
||||
.Dv enableDecomp
|
||||
@ -171,11 +172,12 @@ fields are changed from zero to one by a
|
||||
.Dv NGM_VJC_SET_CONFIG
|
||||
control message.
|
||||
.It Dv NGM_VJC_RECV_ERROR
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
When the peer has CID header field compression enabled,
|
||||
this message must be sent to the local
|
||||
.Nm vjc
|
||||
node immediately
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
This node shuts down upon receipt of a
|
||||
|
||||
@ -56,9 +56,9 @@ hook represents the uncompressed side of the node, while the
|
||||
.Dv vjuncomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes represent the compressed side of the node. Packets received on the
|
||||
hooks represent the compressed side of the node. Packets received on the
|
||||
.Dv ip
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
on the other three hooks will be uncompressed as appropriate.
|
||||
This node also supports
|
||||
.Dq always pass through
|
||||
@ -70,7 +70,7 @@ Only
|
||||
(i.e., common case) TCP packets are actually compressed.
|
||||
These are output on the
|
||||
.Dv vjcomp
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
compressed; these appear on the
|
||||
.Dv vjuncomp
|
||||
hook.
|
||||
@ -85,7 +85,7 @@ node, the
|
||||
.Dv vjcomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes should be connected to the
|
||||
hooks should be connected to the
|
||||
.Xr ng_ppp 8
|
||||
node's
|
||||
.Dv vjc_ip ,
|
||||
@ -93,7 +93,7 @@ node's
|
||||
.Dv vjc_vjuncomp ,
|
||||
and
|
||||
.Dv vjc_ip
|
||||
nodes, respectively.
|
||||
hooks, respectively.
|
||||
.Sh HOOKS
|
||||
This node type supports the following hooks:
|
||||
.Pp
|
||||
@ -113,7 +113,7 @@ This node type supports the generic control messages, plus the following:
|
||||
This command resets the compression state and configures it according
|
||||
to the supplied
|
||||
.Dv "struct ngm_vjc_config"
|
||||
argument. This structure contains the following fields:
|
||||
argument. This structure contains the following fields:
|
||||
.Bd -literal -offset 4n
|
||||
struct ngm_vjc_config {
|
||||
u_char enableComp; /* Enable compression */
|
||||
@ -149,21 +149,22 @@ mode.
|
||||
When enabling compression,
|
||||
.Dv maxChannel
|
||||
should be set to the number of outgoing compression channels minus one,
|
||||
and is a value between 3 and 15, inclusive. Also, the
|
||||
and is a value between 3 and 15, inclusive. The
|
||||
.Dv compressCID
|
||||
field indicates whether it is OK to compress the CID field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
field indicates whether it is OK to compress the CID header field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it is not possible for an outgoing frame to be lost, or
|
||||
(b) lost frames can be reliably detected and immediately
|
||||
reported to the peer's decompression engine (see
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
message is immediately sent whenever this occurs.
|
||||
below).
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
structure, which is defined in
|
||||
.Pa net/slcompress.h .
|
||||
.It Dv NGM_VJC_CLR_STATS
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
.Dv enableComp
|
||||
or
|
||||
.Dv enableDecomp
|
||||
@ -171,11 +172,12 @@ fields are changed from zero to one by a
|
||||
.Dv NGM_VJC_SET_CONFIG
|
||||
control message.
|
||||
.It Dv NGM_VJC_RECV_ERROR
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
When the peer has CID header field compression enabled,
|
||||
this message must be sent to the local
|
||||
.Nm vjc
|
||||
node immediately
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
This node shuts down upon receipt of a
|
||||
|
||||
@ -56,9 +56,9 @@ hook represents the uncompressed side of the node, while the
|
||||
.Dv vjuncomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes represent the compressed side of the node. Packets received on the
|
||||
hooks represent the compressed side of the node. Packets received on the
|
||||
.Dv ip
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
will be compressed or passed through as appropriate. Packets received
|
||||
on the other three hooks will be uncompressed as appropriate.
|
||||
This node also supports
|
||||
.Dq always pass through
|
||||
@ -70,7 +70,7 @@ Only
|
||||
(i.e., common case) TCP packets are actually compressed.
|
||||
These are output on the
|
||||
.Dv vjcomp
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
hook. Other TCP packets are run through the state machine but not
|
||||
compressed; these appear on the
|
||||
.Dv vjuncomp
|
||||
hook.
|
||||
@ -85,7 +85,7 @@ node, the
|
||||
.Dv vjcomp ,
|
||||
and
|
||||
.Dv vjip
|
||||
nodes should be connected to the
|
||||
hooks should be connected to the
|
||||
.Xr ng_ppp 8
|
||||
node's
|
||||
.Dv vjc_ip ,
|
||||
@ -93,7 +93,7 @@ node's
|
||||
.Dv vjc_vjuncomp ,
|
||||
and
|
||||
.Dv vjc_ip
|
||||
nodes, respectively.
|
||||
hooks, respectively.
|
||||
.Sh HOOKS
|
||||
This node type supports the following hooks:
|
||||
.Pp
|
||||
@ -113,7 +113,7 @@ This node type supports the generic control messages, plus the following:
|
||||
This command resets the compression state and configures it according
|
||||
to the supplied
|
||||
.Dv "struct ngm_vjc_config"
|
||||
argument. This structure contains the following fields:
|
||||
argument. This structure contains the following fields:
|
||||
.Bd -literal -offset 4n
|
||||
struct ngm_vjc_config {
|
||||
u_char enableComp; /* Enable compression */
|
||||
@ -149,21 +149,22 @@ mode.
|
||||
When enabling compression,
|
||||
.Dv maxChannel
|
||||
should be set to the number of outgoing compression channels minus one,
|
||||
and is a value between 3 and 15, inclusive. Also, the
|
||||
and is a value between 3 and 15, inclusive. The
|
||||
.Dv compressCID
|
||||
field indicates whether it is OK to compress the CID field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
field indicates whether it is OK to compress the CID header field for
|
||||
outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it is not possible for an outgoing frame to be lost, or
|
||||
(b) lost frames can be reliably detected and immediately
|
||||
reported to the peer's decompression engine (see
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
message is immediately sent whenever this occurs.
|
||||
below).
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
structure, which is defined in
|
||||
.Pa net/slcompress.h .
|
||||
.It Dv NGM_VJC_CLR_STATS
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
Clears the node statistics counters. Statistics are also cleared whenever the
|
||||
.Dv enableComp
|
||||
or
|
||||
.Dv enableDecomp
|
||||
@ -171,11 +172,12 @@ fields are changed from zero to one by a
|
||||
.Dv NGM_VJC_SET_CONFIG
|
||||
control message.
|
||||
.It Dv NGM_VJC_RECV_ERROR
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
When the peer has CID header field compression enabled,
|
||||
this message must be sent to the local
|
||||
.Nm vjc
|
||||
node immediately
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
This node shuts down upon receipt of a
|
||||
|
||||
Loading…
Reference in New Issue
Block a user