summaryrefslogtreecommitdiff
path: root/ares_inet_pton.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2013-02-17 16:56:21 +0100
committerDaniel Stenberg <daniel@haxx.se>2013-02-17 17:44:02 +0100
commitee9a1c2457c3238ee5cdae90fe18440d44377adc (patch)
treee59c12a694726877468b0a3b8e8cbdb148d34757 /ares_inet_pton.3
parent8d013420a0b84cf0ffb7d7cd507f0cf83eff61a4 (diff)
downloadc-ares-ee9a1c2457c3238ee5cdae90fe18440d44377adc.tar.gz
c-ares-ee9a1c2457c3238ee5cdae90fe18440d44377adc.tar.bz2
c-ares-ee9a1c2457c3238ee5cdae90fe18440d44377adc.zip
ares_inet_ntop/ares_inet_pton: added man pages
Diffstat (limited to 'ares_inet_pton.3')
-rw-r--r--ares_inet_pton.343
1 files changed, 43 insertions, 0 deletions
diff --git a/ares_inet_pton.3 b/ares_inet_pton.3
new file mode 100644
index 0000000..a8bc139
--- /dev/null
+++ b/ares_inet_pton.3
@@ -0,0 +1,43 @@
+.\"
+.\" Copyright (C) 2013 by Daniel Stenberg
+.\"
+.\" Permission to use, copy, modify, and distribute this
+.\" software and its documentation for any purpose and without
+.\" fee is hereby granted, provided that the above copyright
+.\" notice appear in all copies and that both that copyright
+.\" notice and this permission notice appear in supporting
+.\" documentation, and that the name of M.I.T. not be used in
+.\" advertising or publicity pertaining to distribution of the
+.\" software without specific, written prior permission.
+.\" M.I.T. makes no representations about the suitability of
+.\" this software for any purpose. It is provided "as is"
+.\" without express or implied warranty.
+.\"
+.TH ARES_INET_PTON 3 "17 Feb 2013"
+.SH NAME
+ares_inet_pton \- convert an IPv4 or IPv6 address from text to binary form
+.SH SYNOPSIS
+.nf
+.B #include <ares.h>
+.PP
+.B const char *ares_inet_pton(int af, const char *src, void *dst);
+.fi
+.SH DESCRIPTION
+This is a portable version with the identical functionality of the commonly
+available \fIinet_pton\fP.
+
+The ares_inet_pton() function converts the address in its standard text
+presentation form into its numeric binary form. The \fBaf\fP argument shall
+specify the family of the address. The AF_INET and AF_INET6 address families
+shall be supported. The \fBsrc\fP argument points to the string being passed
+in. The \fBdst\fP argument points to a buffer into which the function stores
+the numeric address; this shall be large enough to hold the numeric address
+(32 bits for AF_INET, 128 bits for AF_INET6).
+.SH SEE ALSO
+.BR ares_init(3),
+.BR ares_net_ntop(3)
+.SH AVAILABILITY
+made properly publicly available in c-ares for real in version 1.10.0
+.SH AUTHOR
+Daniel Stenberg
+