summaryrefslogtreecommitdiffstats
path: root/lib/libc/net
diff options
context:
space:
mode:
authoreadler <eadler@FreeBSD.org>2012-03-29 05:02:12 +0000
committereadler <eadler@FreeBSD.org>2012-03-29 05:02:12 +0000
commit1ef5fe44d364187e492b6a152c0176186161b44f (patch)
treebc9e037fdf2ed91d8f914cfe43bade2553a869c2 /lib/libc/net
parent0b5862156580ae2abf520982aca1e1085730d500 (diff)
downloadFreeBSD-src-1ef5fe44d364187e492b6a152c0176186161b44f.zip
FreeBSD-src-1ef5fe44d364187e492b6a152c0176186161b44f.tar.gz
Remove trailing whitespace per mdoc lint warning
Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
Diffstat (limited to 'lib/libc/net')
-rw-r--r--lib/libc/net/sctp_bindx.34
-rw-r--r--lib/libc/net/sctp_connectx.38
-rw-r--r--lib/libc/net/sctp_freepaddrs.34
-rw-r--r--lib/libc/net/sctp_getaddrlen.32
-rw-r--r--lib/libc/net/sctp_getassocid.32
-rw-r--r--lib/libc/net/sctp_getpaddrs.32
-rw-r--r--lib/libc/net/sctp_opt_info.34
-rw-r--r--lib/libc/net/sctp_recvmsg.334
-rw-r--r--lib/libc/net/sctp_send.338
-rw-r--r--lib/libc/net/sctp_sendmsg.334
-rw-r--r--lib/libc/net/sourcefilter.32
11 files changed, 67 insertions, 67 deletions
diff --git a/lib/libc/net/sctp_bindx.3 b/lib/libc/net/sctp_bindx.3
index d047126..403cf7d 100644
--- a/lib/libc/net/sctp_bindx.3
+++ b/lib/libc/net/sctp_bindx.3
@@ -55,7 +55,7 @@ This allows a user to bind a subset of
addresses.
The
.Fn sctp_bindx
-call operates similarly to
+call operates similarly to
.Fn bind
but allows a list of addresses and also allows a bind or an
unbind.
@@ -98,7 +98,7 @@ This value is returned if the
field is not one of the allowed values (see above).
.It Bq Er ENOMEM
This value is returned if the number of addresses
-being added causes a memory allocation failure in
+being added causes a memory allocation failure in
the call.
.It Bq Er EBADF
The argument
diff --git a/lib/libc/net/sctp_connectx.3 b/lib/libc/net/sctp_connectx.3
index d454bb9..1851d4a 100644
--- a/lib/libc/net/sctp_connectx.3
+++ b/lib/libc/net/sctp_connectx.3
@@ -58,18 +58,18 @@ This allows a fault tolerant method
of initiating an association.
When one of the peers addresses
is unreachable, the subsequent listed addresses will also be used
-to set up the association with the peer.
+to set up the association with the peer.
.Pp
-The user also needs to consider that any address listed in an
+The user also needs to consider that any address listed in an
.Fn sctp_connectx
call is also considered "confirmed".
A confirmed address is one in
which the SCTP transport will trust is a part of the association
and it will not send a confirmation heartbeat to it with
-a random nonce.
+a random nonce.
.Pp
If the peer SCTP stack does not list one or more of
-the provided addresses in its response message then
+the provided addresses in its response message then
the extra addresses sent in the
.Fn sctp_connectx
call will be silently discarded from the association.
diff --git a/lib/libc/net/sctp_freepaddrs.3 b/lib/libc/net/sctp_freepaddrs.3
index a6815f4..77a8488 100644
--- a/lib/libc/net/sctp_freepaddrs.3
+++ b/lib/libc/net/sctp_freepaddrs.3
@@ -46,9 +46,9 @@
.In sys/socket.h
.In netinet/sctp.h
.Ft void
-.Fn sctp_freepaddrs "struct sockaddr *"
+.Fn sctp_freepaddrs "struct sockaddr *"
.Ft void
-.Fn sctp_freeladdrs "struct sockaddr *"
+.Fn sctp_freeladdrs "struct sockaddr *"
.Sh DESCRIPTION
The
.Fn sctp_freepaddrs
diff --git a/lib/libc/net/sctp_getaddrlen.3 b/lib/libc/net/sctp_getaddrlen.3
index 762e32d..7259635 100644
--- a/lib/libc/net/sctp_getaddrlen.3
+++ b/lib/libc/net/sctp_getaddrlen.3
@@ -62,7 +62,7 @@ system calls.
If for some reason a SCTP socket cannot
be created or the
.Fn getsockopt
-call fails, an error will be returned
+call fails, an error will be returned
with
.Va errno
set as specified in the
diff --git a/lib/libc/net/sctp_getassocid.3 b/lib/libc/net/sctp_getassocid.3
index 27ae324..f347a13 100644
--- a/lib/libc/net/sctp_getassocid.3
+++ b/lib/libc/net/sctp_getassocid.3
@@ -50,7 +50,7 @@ The
.Fn sctp_getassocid
call attempts to look up the specified socket address
.Fa addr
-and find the respective association identification.
+and find the respective association identification.
.Sh RETURN VALUES
The call returns the association id upon success and
0 is returned upon failure.
diff --git a/lib/libc/net/sctp_getpaddrs.3 b/lib/libc/net/sctp_getpaddrs.3
index 6ad5ea0..8bdf2cc 100644
--- a/lib/libc/net/sctp_getpaddrs.3
+++ b/lib/libc/net/sctp_getpaddrs.3
@@ -53,7 +53,7 @@
The
.Fn sctp_getpaddrs
function is used to get the list of the peers addresses.
-The
+The
.Fn sctp_getladdrs
function is used to get the list of the local addresses.
The association of interest is identified by the
diff --git a/lib/libc/net/sctp_opt_info.3 b/lib/libc/net/sctp_opt_info.3
index df8faa6..02b0f85 100644
--- a/lib/libc/net/sctp_opt_info.3
+++ b/lib/libc/net/sctp_opt_info.3
@@ -50,7 +50,7 @@
The
.Fn sctp_opt_info
call provides a multi-os compatible method for getting
-specific
+specific
.Fn getsockopt
data where an association identification needs to be passed
into the operating system.
@@ -70,7 +70,7 @@ who wish to write portable code amongst multiple operating systems
this call should be used for the following SCTP
socket options.
.Pp
-.Dv SCTP_RTOINFO
+.Dv SCTP_RTOINFO
.Pp
.Dv SCTP_ASSOCINFO
.Pp
diff --git a/lib/libc/net/sctp_recvmsg.3 b/lib/libc/net/sctp_recvmsg.3
index 8ddbeb8..37323c8 100644
--- a/lib/libc/net/sctp_recvmsg.3
+++ b/lib/libc/net/sctp_recvmsg.3
@@ -56,11 +56,11 @@ is used to receive a message from another SCTP endpoint.
The
.Fn sctp_recvmsg
call is used by one-to-one (SOCK_STREAM) type sockets after a
-successful
+successful
.Fn connect
-call or after the application has performed a
-.Fn listen
-followed by a successful
+call or after the application has performed a
+.Fn listen
+followed by a successful
.Fn accept .
For a one-to-many (SOCK_SEQPACKET) type socket, an endpoint may call
.Fn sctp_recvmsg
@@ -77,7 +77,7 @@ with a positive backlog to enable the reception of new associations.
.Pp
The address of the sender is held in the
.Fa from
-argument with
+argument with
.Fa fromlen
specifying its size.
At the completion of a successful
@@ -88,16 +88,16 @@ will hold the address of the peer and
.Fa fromlen
will hold the length of that address.
Note that
-the address is bounded by the initial value of
+the address is bounded by the initial value of
.Fa fromlen
which is used as an in/out variable.
.Pp
-The length of the message
+The length of the message
.Fa msg
to be received is bounded by
.Fa len .
If the message is too long to fit in the users
-receive buffer, then the
+receive buffer, then the
.Fa flags
argument will
.Em not
@@ -105,16 +105,16 @@ have the
.Dv MSG_EOF
flag applied.
If the message is a complete message then
-the
+the
.Fa flags
argument will have
.Dv MSG_EOF
set.
-Locally detected errors are
+Locally detected errors are
indicated by a return value of -1 with
.Va errno
set accordingly.
-The
+The
.Fa flags
argument may also hold the value
.Dv MSG_NOTIFICATION .
@@ -141,7 +141,7 @@ The
system call may be used to determine when it is possible to
receive a message.
.Pp
-The
+The
.Fa sinfo
argument is defined as follows.
.Bd -literal
@@ -161,7 +161,7 @@ struct sctp_sndrcvinfo {
The
.Fa sinfo->sinfo_ppid
field is an opaque 32 bit value that is passed transparently
-through the stack from the peer endpoint.
+through the stack from the peer endpoint.
Note that the stack passes this value without regard to byte
order.
.Pp
@@ -182,7 +182,7 @@ was delivered in order within the stream it was received.
.Pp
The
.Fa sinfo->sinfo_stream
-field is the SCTP stream that the message was received on.
+field is the SCTP stream that the message was received on.
Streams in SCTP are reliable (or partially reliable) flows of ordered
messages.
.Pp
@@ -194,7 +194,7 @@ context with the
socket option.
Optionally a user process can use this value to index some application
specific data structure for all data coming from a specific
-association.
+association.
.Pp
The
.Fa sinfo->sinfo_ssn
@@ -230,12 +230,12 @@ sockets this value can be used to send data to the peer without
the use of an address field.
It is also quite useful in
setting various socket options on the specific association
-(see
+(see
.Xr sctp 4 ) .
.Pp
The
.Fa sinfo->info_timetolive
-field is not used by
+field is not used by
.Fn sctp_recvmsg .
.Sh RETURN VALUES
The call returns the number of bytes received, or -1
diff --git a/lib/libc/net/sctp_send.3 b/lib/libc/net/sctp_send.3
index 9acb616..d195b7a 100644
--- a/lib/libc/net/sctp_send.3
+++ b/lib/libc/net/sctp_send.3
@@ -62,14 +62,14 @@ is used to transmit a message to another SCTP endpoint.
.Fn sctp_send
may be used to send data to an existing association for both
one-to-many (SOCK_SEQPACKET) and one-to-one (SOCK_STREAM) socket types.
-The length of the message
+The length of the message
.Fa msg
is given by
.Fa len .
If the message is too long to pass atomically through the
underlying protocol,
.Va errno
-is set to
+is set to
.Er EMSGSIZE ,
-1 is returned, and
the message is not transmitted.
@@ -88,7 +88,7 @@ The
system call may be used to determine when it is possible to
send more data on one-to-one type (SOCK_STREAM) sockets.
.Pp
-The
+The
.Fa sinfo
structure is used to control various SCTP features
and has the following format:
@@ -106,7 +106,7 @@ struct sctp_sndrcvinfo {
};
.Ed
.Pp
-The
+The
.Fa sinfo->sinfo_ppid
argument is an opaque 32 bit value that is passed transparently
through the stack to the peer endpoint. It will be available on
@@ -131,7 +131,7 @@ argument may include one or more of the following:
#define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based PR-SCTP */
.Ed
.Pp
-The flag
+The flag
.Dv SCTP_EOF
is used to instruct the SCTP stack to queue this message
and then start a graceful shutdown of the association.
@@ -158,7 +158,7 @@ is used to specify that a specific address should be used.
Normally
SCTP will use only one of a multi-homed peers addresses as the primary
address to send to.
-By default, no matter what the
+By default, no matter what the
.Fa to
argument is, this primary address is used to send data.
By specifying
@@ -193,14 +193,14 @@ skipped and no longer transmitted.
Note that this policy does
not even assure that the data will ever be sent.
In times of a congestion
-with large amounts of data being queued, the
+with large amounts of data being queued, the
.Fa sinfo->sinfo_timetolive
may expire before the first transmission is ever made.
.Pp
The
.Dv SCTP_PR_SCTP_BUF
based policy transforms the
-.Fa sinfo->sinfo_timetolive
+.Fa sinfo->sinfo_timetolive
field into a total number of bytes allowed on the outbound
send queue.
If that number or more bytes are in queue, then
@@ -208,19 +208,19 @@ other buffer-based sends are looked to be removed and
skipped.
Note that this policy may also result in the data
never being sent if no buffer based sends are in queue and
-the maximum specified by
-.Fa timetolive
+the maximum specified by
+.Fa timetolive
bytes is in queue.
.Pp
The
.Dv SCTP_PR_SCTP_RTX
policy transforms the
-.Fa sinfo->sinfo_timetolive
+.Fa sinfo->sinfo_timetolive
into a number of retransmissions to allow.
This policy
always assures that at a minimum one send attempt is
made of the data.
-After which no more than
+After which no more than
.Fa sinfo->sinfo_timetolive
retransmissions will be made before the data is skipped.
.Pp
@@ -228,11 +228,11 @@ retransmissions will be made before the data is skipped.
is the SCTP stream that you wish to send the
message on.
Streams in SCTP are reliable (or partially reliable) flows of ordered
-messages.
+messages.
.Pp
The
.Fa sinfo->sinfo_assoc_id
-field is used to
+field is used to
select the association to send to on a one-to-many socket.
For a one-to-one socket, this field is ignored.
.Pp
@@ -256,16 +256,16 @@ The fields
.Fa sinfo->sinfo_ssn ,
.Fa sinfo->sinfo_tsn ,
and
-.Fa sinfo->sinfo_cumtsn
+.Fa sinfo->sinfo_cumtsn
are used only when receiving messages and are thus ignored by
.Fn sctp_send .
The function
-.Fn sctp_sendx
-has the same properties as
+.Fn sctp_sendx
+has the same properties as
.Fn sctp_send
with the additional arguments of an array of sockaddr structures
passed in.
-With the
+With the
.Fa addrs
argument being given as an array of addresses to be sent to and
the
@@ -277,7 +277,7 @@ when an implicit association is being set up.
This allows the
user the equivalent behavior as doing a
.Fn sctp_connectx
-followed by a
+followed by a
.Fn sctp_send
to the association.
Note that if the
diff --git a/lib/libc/net/sctp_sendmsg.3 b/lib/libc/net/sctp_sendmsg.3
index ddd88b4..4158932 100644
--- a/lib/libc/net/sctp_sendmsg.3
+++ b/lib/libc/net/sctp_sendmsg.3
@@ -72,10 +72,10 @@ Data sent in such an instance will result in
the data being sent on the third leg of the SCTP four-way handshake.
Note that if
the socket is a one-to-one type (SOCK_STREAM) socket then an association must
-be in existence (by use of the
+be in existence (by use of the
.Xr connect 2
system call).
-Calling
+Calling
.Fn sctp_sendmsg
or
.Fn sctp_sendmsgx
@@ -90,14 +90,14 @@ The address of the target is given by
with
.Fa tolen
specifying its size.
-The length of the message
+The length of the message
.Fa msg
is given by
.Fa len .
If the message is too long to pass atomically through the
underlying protocol,
.Va errno
-is set to
+is set to
.Er EMSGSIZE ,
-1 is returned, and
the message is not transmitted.
@@ -117,7 +117,7 @@ The
system call may be used to determine when it is possible to
send more data on one-to-one type (SOCK_STREAM) sockets.
.Pp
-The
+The
.Fa ppid
argument is an opaque 32 bit value that is passed transparently
through the stack to the peer endpoint.
@@ -143,7 +143,7 @@ argument may include one or more of the following:
#define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based PR-SCTP */
.Ed
.Pp
-The flag
+The flag
.Dv SCTP_EOF
is used to instruct the SCTP stack to queue this message
and then start a graceful shutdown of the association.
@@ -170,7 +170,7 @@ is used to specify that an specific address should be used.
Normally
SCTP will use only one of a multi-homed peers addresses as the primary
address to send to.
-By default, no matter what the
+By default, no matter what the
.Fa to
argument is, this primary address is used to send data.
By specifying
@@ -205,14 +205,14 @@ skipped and no longer transmitted.
Note that this policy does
not even assure that the data will ever be sent.
In times of a congestion
-with large amounts of data being queued, the
+with large amounts of data being queued, the
.Fa timetolive
may expire before the first transmission is ever made.
.Pp
The
.Dv SCTP_PR_SCTP_BUF
based policy transforms the
-.Fa timetolive
+.Fa timetolive
field into a total number of bytes allowed on the outbound
send queue.
If that number or more bytes are in queue, then
@@ -220,19 +220,19 @@ other buffer based sends are looked to be removed and
skipped.
Note that this policy may also result in the data
never being sent if no buffer based sends are in queue and
-the maximum specified by
-.Fa timetolive
+the maximum specified by
+.Fa timetolive
bytes is in queue.
.Pp
The
.Dv SCTP_PR_SCTP_RTX
policy transforms the
-.Fa timetolive
+.Fa timetolive
into a number of retransmissions to allow.
This policy
always assures that at a minimum one send attempt is
made of the data.
-After which no more than
+After which no more than
.Fa timetolive
retransmissions will be made before the data is skipped.
.Pp
@@ -241,7 +241,7 @@ is the SCTP stream that you wish to send the
message on.
Streams in SCTP are reliable (or partially reliable) flows of ordered
messages.
-The
+The
.Fa context
field is used only in the event the message cannot be sent.
This is an opaque
@@ -251,7 +251,7 @@ is given if that notification is enabled (see
Normally a user process can use this value to index some application
specific data structure when a send cannot be fulfilled.
.Fn sctp_sendmsgx
-is identical to
+is identical to
.Fn sctp_sendmsg
with the exception that it takes an array of sockaddr structures in the
argument
@@ -262,7 +262,7 @@ which specifies how many addresses are in the array.
This allows a
caller to implicitly set up an association passing multiple addresses
as if
-.Fn sctp_connectx
+.Fn sctp_connectx
had been called to set up the association.
.Sh RETURN VALUES
The call returns the number of characters sent, or -1
@@ -325,7 +325,7 @@ is not connected and is a one-to-one style socket.
.Xr sctp 4
.Sh BUGS
Because in the one-to-many style socket
-.Fn sctp_sendmsg
+.Fn sctp_sendmsg
or
.Fn sctp_sendmsgx
may have multiple associations under one endpoint, a
diff --git a/lib/libc/net/sourcefilter.3 b/lib/libc/net/sourcefilter.3
index 46f61a8..c7293e0 100644
--- a/lib/libc/net/sourcefilter.3
+++ b/lib/libc/net/sourcefilter.3
@@ -220,7 +220,7 @@ operation.
.Sh SEE ALSO
.Xr ip 4 ,
.Xr ip6 4 ,
-.Xr multicast 4,
+.Xr multicast 4,
.Xr ifmcstat 8
.Rs
.%A D. Thaler
OpenPOWER on IntegriCloud