Module Name: src
Committed By: ginsbach
Date: Fri Jul 20 13:40:58 UTC 2012
Modified Files:
src/lib/libc/inet: inet_net.3
Log Message:
- Use .Vt for variable types outside the SYNOPSIS section rather than .Ft
- Use .Fn for function names outside the NAME section rather than .Nm
- Mark NULL as a defined value (.Dv)
- New sentence new line
- Don't start sentences with an arugment name
- Use \- rather than a bare - for a minus sign
- Spelling: rightmost
- Stray whitespace
(Most changes from FreeBSD)
To generate a diff of this commit:
cvs rdiff -u -r1.2 -r1.3 src/lib/libc/inet/inet_net.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/inet/inet_net.3
diff -u src/lib/libc/inet/inet_net.3:1.2 src/lib/libc/inet/inet_net.3:1.3
--- src/lib/libc/inet/inet_net.3:1.2 Wed Apr 30 13:10:50 2008
+++ src/lib/libc/inet/inet_net.3 Fri Jul 20 13:40:58 2012
@@ -1,4 +1,4 @@
-.\" $NetBSD: inet_net.3,v 1.2 2008/04/30 13:10:50 martin Exp $
+.\" $NetBSD: inet_net.3,v 1.3 2012/07/20 13:40:58 ginsbach Exp $
.\"
.\" Copyright (c) 1997 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -48,14 +48,17 @@
The
.Fn inet_net_ntop
function converts an Internet network number from network format (usually a
-.Ft struct in_addr
+.Vt struct in_addr
or some other binary form, in network byte order) to CIDR presentation format
(suitable for external display purposes).
+The
.Fa bits
-is the number of bits in
+argument is the number of bits in
.Fa src
that are the network number.
-It returns NULL if a system error occurs (in which case,
+It returns
+.Dv NULL
+if a system error occurs (in which case,
.Va errno
will have been set), or it returns a pointer to the destination string.
.Pp
@@ -63,10 +66,10 @@ The
.Fn inet_net_pton
function converts a presentation format Internet network number (that is,
printable form as held in a character string) to network format (usually a
-.Ft struct in_addr
+.Vt struct in_addr
or some other internal binary representation, in network byte order).
It returns the number of bits (either computed based on the class, or
-specified with /CIDR), or -1 if a failure occurred
+specified with /CIDR), or \-1 if a failure occurred
(in which case
.Va errno
will have been set.
@@ -80,8 +83,9 @@ are
.Dv AF_INET
and
.Dv AF_INET6 .
+The
.Fa size
-is the size of the result buffer
+argument is the size of the result buffer
.Fa dst .
.Sh NETWORK NUMBERS (IP VERSION 4)
Internet network numbers may be specified in one of the following forms:
@@ -95,11 +99,11 @@ 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
-.Tn Intel 386, 486
+.Tn Intel 386 , 486 ,
and
.Tn Pentium
processors) the bytes referred to above appear as
@@ -108,14 +112,14 @@ That is, little-endian bytes are ordered
.Pp
When a three part number is specified, the last
part is interpreted as a 16-bit quantity and placed
-in the right-most two bytes of the Internet network number.
+in the rightmost two bytes of the Internet network number.
This makes the three part number format convenient
for specifying Class B network numbers as
.Dq Li 128.net.host .
.Pp
When a two part number is supplied, the last part
is interpreted as a 24-bit quantity and placed in
-the right most three bytes of the Internet network number.
+the rightmost three bytes of the Internet network number.
This makes the two part number format convenient
for specifying Class A network numbers as
.Dq Li net.host .
@@ -127,7 +131,7 @@ rearrangement.
All numbers supplied as
.Dq parts
in a
-.Ql \&.
+.Ql \&.
notation
may be decimal, octal, or hexadecimal, as specified
in the C language (i.e., a leading 0x or 0X implies
@@ -143,9 +147,9 @@ otherwise, the number is interpreted as
.Xr networks 5
.Sh HISTORY
The
-.Nm inet_net_ntop
+.Fn inet_net_ntop
and
-.Nm inet_net_pton
+.Fn inet_net_pton
functions appeared in BIND 4.9.4 and thence
.Nx 1.3 .
Support for
