The inet(3) man page has always felt messy to me, where the words
"function" and "routine" are used interchangeably to describe the
various functions in inconsistent ways.  This extra verbiage makes it
somewhat harder to look up the descriptions of functions.

Since it is understood that this man page describes functions, I have
created a diff that removes those words to make it easier and quicker
for programmers to find the info they need.

Comments? Ok?

Lawrence


Index: inet.3
===================================================================
RCS file: /cvs/src/lib/libc/net/inet.3,v
retrieving revision 1.23
diff -u -p -r1.23 inet.3
--- inet.3      20 Apr 2012 07:00:21 -0000      1.23
+++ inet.3      31 May 2012 03:39:50 -0000
@@ -68,7 +68,6 @@
 .Ft in_addr_t
 .Fn inet_lnaof "struct in_addr in"
 .Sh DESCRIPTION
-The routines
 .Fn inet_aton ,
 .Fn inet_addr ,
 and
@@ -78,27 +77,24 @@ numbers expressed in the Internet standa
 .Dq dot
 notation.
 .Pp
-The
 .Fn inet_aton
-routine interprets the specified character string as an Internet address,
+interprets the specified character string as an Internet address,
 placing the address into the structure provided.
 It returns 1 if the string was successfully interpreted,
 or 0 if the string was invalid.
 .Pp
-The
 .Fn inet_addr
 and
 .Fn inet_network
-functions return numbers suitable for use
+return numbers suitable for use
 as Internet addresses and Internet network
 numbers, respectively.
 Both functions return the constant
 .Dv INADDR_NONE
 if the specified character string is malformed.
 .Pp
-The
 .Fn inet_pton
-function converts a presentation format address (that is, printable form
+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).
@@ -112,7 +108,6 @@ This function is presently valid for
 and
 .Dv AF_INET6 .
 .Pp
-The function
 .Fn inet_ntop
 converts an address from network format (usually a
 .Li struct in_addr
@@ -125,18 +120,15 @@ error occurs (in which case,
 .Va errno
 will have been set), or it returns a pointer to the destination string.
 .Pp
-The routine
 .Fn inet_ntoa
 takes an Internet address and returns an
 ASCII string representing the address in dot notation.
 .Pp
-The routine
 .Fn inet_makeaddr
 takes an Internet network number and a local
 network address and constructs an Internet address
 from it.
 .Pp
-The routines
 .Fn inet_netof
 and
 .Fn inet_lnaof

Reply via email to