diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-04-18 03:01:36 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-04-18 03:01:36 +0000 |
commit | c2d5d31832de35b48a0e487f90b9a58abeb3a8ea (patch) | |
tree | 3dcc33b96ac33fca8fde9f5dff0db0a5afbb6ae4 /lib/libc/net | |
parent | b6a043747e2041e97decf4b4c5a3b51c3b40b722 (diff) |
Repairs, mostly removing hard sentence breaks.
Diffstat (limited to 'lib/libc/net')
-rw-r--r-- | lib/libc/net/byteorder.3 | 15 | ||||
-rw-r--r-- | lib/libc/net/ethers.3 | 20 | ||||
-rw-r--r-- | lib/libc/net/gethostbyname.3 | 8 | ||||
-rw-r--r-- | lib/libc/net/getifaddrs.3 | 5 | ||||
-rw-r--r-- | lib/libc/net/getnameinfo.3 | 4 | ||||
-rw-r--r-- | lib/libc/net/getnetent.3 | 15 | ||||
-rw-r--r-- | lib/libc/net/getprotoent.3 | 5 | ||||
-rw-r--r-- | lib/libc/net/getservent.3 | 5 | ||||
-rw-r--r-- | lib/libc/net/inet.3 | 45 | ||||
-rw-r--r-- | lib/libc/net/inet6_rthdr_space.3 | 9 | ||||
-rw-r--r-- | lib/libc/net/inet_net.3 | 6 | ||||
-rw-r--r-- | lib/libc/net/link_addr.3 | 4 | ||||
-rw-r--r-- | lib/libc/net/net_addrcmp.3 | 9 | ||||
-rw-r--r-- | lib/libc/net/rcmd.3 | 15 |
14 files changed, 96 insertions, 69 deletions
diff --git a/lib/libc/net/byteorder.3 b/lib/libc/net/byteorder.3 index 64a13d47baf..9d8fa7221f9 100644 --- a/lib/libc/net/byteorder.3 +++ b/lib/libc/net/byteorder.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: byteorder.3,v 1.7 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: byteorder.3,v 1.8 2000/04/18 03:01:30 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -83,7 +83,8 @@ .Fn swap16 "u_int16_t val16" .Sh DESCRIPTION These routines convert 16- and 32-bit quantities between different -byte orderings. The +byte orderings. +The .Dq swap functions reverse the byte ordering of the given quantity, the others converts either from/to the native @@ -127,7 +128,8 @@ The swap functions are of the form: swap{size}. Names involving .Sq n convert quantities between network -byte order and host byte order. The last letter +byte order and host byte order. +The last letter .Pf ( Sq s or .Sq l ) @@ -136,7 +138,8 @@ for the traditional names for such quantities, .Li short and .Li long , -respectively. Today, the C concept of +respectively. +Today, the C concept of .Li short and .Li long @@ -176,5 +179,5 @@ functions appeared in .Bx 4.2 . .Sh BUGS On the vax, alpha, i386, and so far mips, -bytes are handled backwards from most everyone else in -the world. This is not expected to be fixed in the near future. +bytes are handled backwards from most everyone else in the world. +This is not expected to be fixed in the near future. diff --git a/lib/libc/net/ethers.3 b/lib/libc/net/ethers.3 index 39968f3e65e..8c5066a7602 100644 --- a/lib/libc/net/ethers.3 +++ b/lib/libc/net/ethers.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ethers.3,v 1.11 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: ethers.3,v 1.12 2000/04/18 03:01:31 aaron Exp $ .\" .\" Written by roland@frob.com. Public domain. .\" @@ -41,15 +41,15 @@ function converts this structure into an string of the form .Dq xx:xx:xx:xx:xx:xx , consisting of 6 hexadecimal numbers separated -by colons. It returns a pointer to a static buffer that is reused for -each call. +by colons. +It returns a pointer to a static buffer that is reused for each call. The .Fn ether_aton converts an .Tn ASCII string of the same form and to a structure -containing the 6 octets of the address. It returns a pointer to a -static structure that is reused for each call. +containing the 6 octets of the address. +It returns a pointer to a static structure that is reused for each call. .Pp The .Fn ether_ntohost @@ -61,13 +61,15 @@ addresses, The .Fn ether_ntohost function looks up the given Ethernet address and writes the associated -host name into the character buffer passed. This buffer should be +host name into the character buffer passed. +This buffer should be .Dv MAXHOSTNAMELEN characters in size. The .Fn ether_hostton function looks up the given host name and writes the associated -Ethernet address into the structure passed. Both functions return +Ethernet address into the structure passed. +Both functions return zero if they find the requested host name or address, and \-1 if not. .Pp Each call reads @@ -90,8 +92,8 @@ function parses a line from the .Pa /etc/ethers file and fills in the passed .Li struct ether_addr -and character buffer with the Ethernet address and host name on the line. It -returns zero if the line was successfully parsed and \-1 if not. +and character buffer with the Ethernet address and host name on the line. +It returns zero if the line was successfully parsed and \-1 if not. The character buffer should be .Dv MAXHOSTNAMELEN characters in size. diff --git a/lib/libc/net/gethostbyname.3 b/lib/libc/net/gethostbyname.3 index aced5ba6167..f1353288c51 100644 --- a/lib/libc/net/gethostbyname.3 +++ b/lib/libc/net/gethostbyname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gethostbyname.3,v 1.14 2000/04/15 02:15:22 aaron Exp $ +.\" $OpenBSD: gethostbyname.3,v 1.15 2000/04/18 03:01:31 aaron Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -166,12 +166,14 @@ connection. .Pp The .Fn herror -function prints an error message describing the failure. If its argument +function prints an error message describing the failure. +If its argument .Fa string is non-null, it is prepended to the message string and separated from it by a colon .Pq Ql \&: -and a space. The error message is printed with a trailing newline. +and a space. +The error message is printed with a trailing newline. The contents of the error message is the same as that returned by .Fn hstrerror with argument diff --git a/lib/libc/net/getifaddrs.3 b/lib/libc/net/getifaddrs.3 index fd36edb3cf6..d69e0f62f53 100644 --- a/lib/libc/net/getifaddrs.3 +++ b/lib/libc/net/getifaddrs.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getifaddrs.3,v 1.5 2000/04/16 13:48:53 itojun Exp $ +.\" $OpenBSD: getifaddrs.3,v 1.6 2000/04/18 03:01:31 aaron Exp $ .\" BSDI getifaddrs.3,v 2.5 2000/02/23 14:51:59 dab Exp .\" .\" Copyright (c) 1995, 1999 @@ -96,7 +96,8 @@ References the destination address on a P2P interface, if one exists, otherwise it is .Dv NULL . .It Fa ifa_data -References address family specific data. For +References address family specific data. +For .Dv AF_LINK addresses it contains a pointer to the .Li struct if_data diff --git a/lib/libc/net/getnameinfo.3 b/lib/libc/net/getnameinfo.3 index 8aee0716026..74690d0e416 100644 --- a/lib/libc/net/getnameinfo.3 +++ b/lib/libc/net/getnameinfo.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getnameinfo.3,v 1.5 2000/01/17 08:20:28 deraadt Exp $ +.\" $OpenBSD: getnameinfo.3,v 1.6 2000/04/18 03:01:31 aaron Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -102,7 +102,7 @@ or .Fa servlen arguments. Otherwise, the caller must provide buffers large enough to hold the -nodename and the service name, including the terminating null characters. +nodename and the service name, including the terminating null characters. .Pp Unfortunately most systems do not provide constants that specify the maximum size of either a fully-qualified domain name or a service name. diff --git a/lib/libc/net/getnetent.3 b/lib/libc/net/getnetent.3 index 05478afdfbb..fba5505fec0 100644 --- a/lib/libc/net/getnetent.3 +++ b/lib/libc/net/getnetent.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getnetent.3,v 1.8 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: getnetent.3,v 1.9 2000/04/18 03:01:31 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -84,8 +84,8 @@ A zero-terminated list of alternate names for the network. The type of the network number returned; currently only .Dv AF_INET . .It Fa n_net -The network number. Network numbers are returned in machine byte -order. +The network number. +Network numbers are returned in machine byte order. .El .Pp The @@ -96,7 +96,8 @@ reads the next line of the file, opening the file if necessary. The .Fn setnetent function -opens and rewinds the file. If the +opens and rewinds the file. +If the .Fa stayopen flag is non-zero, the net data base will not be closed after each call to @@ -146,6 +147,6 @@ functions appeared in .Sh BUGS The data space used by these functions is static; if future use requires the data, it should be copied before any subsequent calls -to these functions overwrite it. Only Internet network numbers -are currently understood. Expecting network numbers to fit in no -more than 32 bits is naive. +to these functions overwrite it. +Only Internet network numbers are currently understood. +Expecting network numbers to fit in no more than 32 bits is naive. diff --git a/lib/libc/net/getprotoent.3 b/lib/libc/net/getprotoent.3 index 01f752ad5ff..e4e7e6ec45c 100644 --- a/lib/libc/net/getprotoent.3 +++ b/lib/libc/net/getprotoent.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getprotoent.3,v 1.5 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: getprotoent.3,v 1.6 2000/04/18 03:01:32 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -92,7 +92,8 @@ reads the next line of the file, opening the file if necessary. The .Fn setprotoent function -opens and rewinds the file. If the +opens and rewinds the file. +If the .Fa stayopen flag is non-zero, the net data base will not be closed after each call to diff --git a/lib/libc/net/getservent.3 b/lib/libc/net/getservent.3 index 3ef95fb817a..21591cdcbba 100644 --- a/lib/libc/net/getservent.3 +++ b/lib/libc/net/getservent.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getservent.3,v 1.8 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: getservent.3,v 1.9 2000/04/18 03:01:32 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -96,7 +96,8 @@ reads the next line of the file, opening the file if necessary. The .Fn setservent function -opens and rewinds the file. If the +opens and rewinds the file. +If the .Fa stayopen flag is non-zero, the net data base will not be closed after each call to diff --git a/lib/libc/net/inet.3 b/lib/libc/net/inet.3 index 1e38bdc0560..eb95f6c364a 100644 --- a/lib/libc/net/inet.3 +++ b/lib/libc/net/inet.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: inet.3,v 1.8 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: inet.3,v 1.9 2000/04/18 03:01:32 aaron Exp $ .\" $NetBSD: inet.3,v 1.7 1997/06/18 02:25:24 lukem Exp $ .\" .\" Copyright (c) 1983, 1990, 1991, 1993 @@ -85,12 +85,13 @@ The function converts a presentation format address (that is, printable form as held in a character string) to network format (usually a .Li struct in_addr -or some other internal binary representation, in network byte order). It -returns 1 if the address was valid for the specified address family, or +or some other internal binary representation, in network byte order). +It returns 1 if the address was valid for the specified address family, or 0 if the address wasn't parseable in the specified address family, or \-1 if some system error occurred (in which case .Va errno -will have been set). This function is presently valid for +will have been set). +This function is presently valid for .Dv AF_INET and .Dv AF_INET6 . @@ -113,7 +114,8 @@ The function converts an address from network format (usually a .Li struct in_addr or some other binary form, in network byte order) to presentation format -(suitable for external display purposes). It returns +(suitable for external display purposes). +It returns .Dv NULL if a system error occurs (in which case, @@ -125,11 +127,13 @@ takes an Internet address and returns an .Tn ASCII string representing the address in .Ql \&. -notation. The routine +notation. +The routine .Fn inet_makeaddr takes an Internet network number and a local network address and constructs an Internet address -from it. The routines +from it. +The routines .Fn inet_netof and .Fn inet_lnaof @@ -155,8 +159,8 @@ a .Pp When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, -to the four bytes of an Internet address. Note -that when an Internet address is viewed as a 32-bit +to the four bytes of an Internet address. +Note that when an Internet address is viewed as a 32-bit integer quantity on a system that uses little-endian byte order (such as the .Tn Intel 386, 486 @@ -214,16 +218,20 @@ every field (except for the case described in 2.). .It Due to the method of allocating certain styles of IPv6 addresses, it will be common for addresses to contain long -strings of zero bits. In order to make writing addresses +strings of zero bits. +In order to make writing addresses .Pp containing zero bits easier a special syntax is available to -compress the zeros. The use of +compress the zeros. +The use of .Dq \&:\&: indicates multiple groups -of 16 bits of zeros. The +of 16 bits of zeros. +The .Dq \&:\&: can only appear once in an -address. The +address. +The .Dq \&:\&: can also be used to compress the leading and/or trailing zeros in an address. .Pp @@ -248,7 +256,8 @@ dealing with a mixed environment of IPv4 and IPv6 nodes is x:x:x:x:x:x:d.d.d.d, where the 'x's are the hexadecimal values of the six high-order 16-bit pieces of the address, and the 'd's are the decimal values of the four low-order 8-bit pieces of the -address (standard IPv4 representation). Examples: +address (standard IPv4 representation). +Examples: .Bd -literal -offset indent 0:0:0:0:0:0:13.1.68.3 0:0:0:0:0:FFFF:129.144.52.38 @@ -281,10 +290,12 @@ The and .Nm inet_pton functions conforms to the IETF IPng BSD API and address formatting -specifications. Note that +specifications. +Note that .Nm inet_pton -does not accept 1-, 2-, or 3-part dotted addresses; all four parts -must be specified. This is a narrower input set than that accepted by +does not accept 1-, 2-, or 3-part dotted addresses; all four parts +must be specified. +This is a narrower input set than that accepted by .Nm inet_aton . .Sh HISTORY The diff --git a/lib/libc/net/inet6_rthdr_space.3 b/lib/libc/net/inet6_rthdr_space.3 index 439c2703572..6c84bdee78f 100644 --- a/lib/libc/net/inet6_rthdr_space.3 +++ b/lib/libc/net/inet6_rthdr_space.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: inet6_rthdr_space.3,v 1.4 2000/01/18 21:49:01 aaron Exp $ +.\" $OpenBSD: inet6_rthdr_space.3,v 1.5 2000/04/18 03:01:32 aaron Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -70,8 +70,8 @@ .\" .Sh DESCRIPTION RFC2292 IPv6 advanced API defines eight -functions that the application calls to build and examine a Routing -header. Four functions build a Routing header: +functions that the application calls to build and examine a Routing header +Four functions build a Routing header: .Bl -hang .It Fn inet6_rthdr_space return #bytes required for ancillary data @@ -107,7 +107,8 @@ containing the specified number of .Fa segments .Pq addresses . For an IPv6 Type 0 Routing header, the number -of segments must be between 1 and 23, inclusive. The return value +of segments must be between 1 and 23, inclusive. +The return value includes the size of the cmsghdr structure that precedes the Routing header, and any required padding. .Pp diff --git a/lib/libc/net/inet_net.3 b/lib/libc/net/inet_net.3 index 1eb157c429d..12b1a4daa0e 100644 --- a/lib/libc/net/inet_net.3 +++ b/lib/libc/net/inet_net.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: inet_net.3,v 1.4 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: inet_net.3,v 1.5 2000/04/18 03:01:32 aaron Exp $ .\" $NetBSD: inet_net.3,v 1.1 1997/06/18 02:25:27 lukem Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -101,8 +101,8 @@ a .Pp When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, -to the four bytes of an Internet network number. Note -that when an Internet network number is viewed as a 32-bit +to the four bytes of an Internet network number. +Note that when an Internet network number is viewed as a 32-bit integer quantity on a system that uses little-endian byte order (such as the Intel 386, 486, and Pentium processors) the bytes referred to above appear as diff --git a/lib/libc/net/link_addr.3 b/lib/libc/net/link_addr.3 index b7ada819975..29c2449f77e 100644 --- a/lib/libc/net/link_addr.3 +++ b/lib/libc/net/link_addr.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: link_addr.3,v 1.6 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: link_addr.3,v 1.7 2000/04/18 03:01:32 aaron Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -108,7 +108,7 @@ The and .Fn link_ntoa functions appeared in -.Bx 4.3 Reno . +.Bx 4.3 Reno . .Sh BUGS The returned values for link_ntoa reside in a static memory area. diff --git a/lib/libc/net/net_addrcmp.3 b/lib/libc/net/net_addrcmp.3 index c29624dc878..8f7de8ef445 100644 --- a/lib/libc/net/net_addrcmp.3 +++ b/lib/libc/net/net_addrcmp.3 @@ -26,7 +26,8 @@ returns 0. .Pp The .Fa sa_len -fields are compared first. If they do not match, +fields are compared first. +If they do not match, .Fn net_addrcmp returns \-1 or 1 if .Li sa1->sa_len @@ -36,7 +37,8 @@ respectively. .Pp Next, the .Fa sa_family -members are compared. If they do not match, +members are compared. +If they do not match, .Fn net_addrcmp returns \-1 or 1 if .Li sa1->sa_family @@ -51,7 +53,8 @@ and fields match, the protocol-specific data (the .Fa sa_data -field) is compared. If there's a match, both +field) is compared. +If there's a match, both .Fa sa1 and .Fa sa2 diff --git a/lib/libc/net/rcmd.3 b/lib/libc/net/rcmd.3 index ea71e40d71b..04230ef7745 100644 --- a/lib/libc/net/rcmd.3 +++ b/lib/libc/net/rcmd.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rcmd.3,v 1.19 2000/04/15 11:46:02 aaron Exp $ +.\" $OpenBSD: rcmd.3,v 1.20 2000/04/18 03:01:33 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -65,7 +65,8 @@ The function is used by the superuser to execute a command on a remote machine using an authentication scheme based on reserved -port numbers. If the calling process is not setuid, the +port numbers. +If the calling process is not setuid, the .Ev RSH environment variable is set, and .Fa inport @@ -170,12 +171,12 @@ The and .Fn rresvport_af functions are used to obtain a socket with a privileged -address bound to it. This socket is suitable for use -by +address bound to it. +This socket is suitable for use by .Fn rcmd -and several other functions. Privileged Internet ports are those -in the range 0 to 1023. Only the superuser -is allowed to bind an address of this sort to a socket. +and several other functions. +Privileged Internet ports are those in the range 0 to 1023. +Only the superuser is allowed to bind an address of this sort to a socket. .Fn rresvport and .Fn rresvport_af |