(split) Apply minor changes from v3.32 to v3.35 in the upstream.

[linuxjm/LDP_man-pages.git] / draft / man3 / inet_pton.3

.\" Copyright 2000 Sam Varshavchik <mrsam@courier-mta.com>
.\" and Copyright (c) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References: RFC 2553
.\"
.\" Japanese Version Copyright (c) 2001 NAKANO Takeo all rights reserved.
.\" Translated 2001-01-14, NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Updated 2008-08-08, Akihiro MOTOKI, LDP v3.05
.\"
.TH INET_PTON 3  2008-06-18 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.\"O inet_pton \- convert IPv4 and IPv6 addresses from text to binary form
.SH ̾Á°
inet_pton \- IPv4/IPv6 ¥¢¥É¥ì¥¹¤ò¥Æ¥­¥¹¥È·Á¼°¤«¤é¥Ð¥¤¥Ê¥ê·Á¼°¤ËÊÑ´¹¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.B #include <arpa/inet.h>

.BI "int inet_pton(int " "af" ", const char *" "src" ", void *" "dst" );
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O This function converts the character string
.\"O .I src
.\"O into a network address structure in the
.\"O .I af
.\"O address family, then
.\"O copies
.\"O the network address structure to
.\"O .IR dst .
¤³¤Î´Ø¿ô¤Ïʸ»úÎó
.I src
¤ò¡¢¥¢¥É¥ì¥¹¥Õ¥¡¥ß¥ê¡¼
.I af
¤Î¥Í¥Ã¥È¥ï¡¼¥¯¥¢¥É¥ì¥¹¹½Â¤ÂΤËÊÑ´¹¤·¡¢
.I dst
¤Ë¥³¥Ô¡¼¤¹¤ë¡£
.\"O The
.\"O .I af
.\"O argument must be either
.\"O .B AF_INET
.\"O or
.\"O .BR AF_INET6 .
.I af
°ú¤­¿ô¤Ï
.B AF_INET
¤«
.B AF_INET6
¤Î¤É¤Á¤é¤«¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.PP
.\"O The following address families are currently supported:
¸½ºß¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤ë¥¢¥É¥ì¥¹¥Õ¥¡¥ß¥ê¡¼¤Ï°Ê²¼¤ÎÄ̤ê¤Ç¤¢¤ë¡£
.TP
.B AF_INET
.\"O .I src
.\"O points to a character string containing an IPv4 network address in
.\"O dotted-decimal format, "\fIddd.ddd.ddd.ddd\fP", where
.\"O .I ddd
.\"O is a decimal number of up to three digits in the range 0 to 255.
.\"O The address is converted to a
.\"O .I struct in_addr
.\"O and copied to
.\"O .IR dst ,
.\"O which must be
.\"O .I sizeof(struct in_addr)
.\"O (4) bytes (32 bits) long.
.I src
¤Ï¥É¥Ã¥È¶èÀÚ¤ê¤Î 10 ¿Ê¿ô·Á¼° "\fIddd.ddd.ddd.ddd\fP"
¤Î IPv4 ¥Í¥Ã¥È¥ï¡¼¥¯¥¢¥É¥ì¥¹Ê¸»úÎó¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
.I ddd
¤Ï 0 ¤«¤é 255 ¤Þ¤Ç¤ÎÈϰϤκÇÂç 3 ·å¤Î 10 ¿Ê¿ô¤Ç¤¢¤ë¡£
¤³¤Î¥¢¥É¥ì¥¹¤Ï
.I "struct in_addr"
¤ËÊÑ´¹¤µ¤ì¤Æ
.I dst
¤Ë¥³¥Ô¡¼¤µ¤ì¤ë¡£
.I dst
¤ÎŤµ¤Ï
.I "sizeof(struct in_addr)"
(4) ¥Ð¥¤¥È (32¥Ó¥Ã¥È) ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.TP
.B AF_INET6
.\"O .I src
.\"O points to a character string containing an IPv6 network address.
.\"O The address is converted to a
.\"O .I struct in6_addr
.\"O and copied to
.\"O .IR dst ,
.\"O which must be
.\"O .I sizeof(struct in6_addr)
.\"O (16) bytes (128 bits) long.
.I src
¤Ï IPv6 ¥Í¥Ã¥È¥ï¡¼¥¯¥¢¥É¥ì¥¹¤¬³ÊǼ¤µ¤ì¤¿Ê¸»úÎó¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
¤³¤Î¥¢¥É¥ì¥¹¤Ï
.I "struct in6_addr"
¤ËÊÑ´¹¤µ¤ì¤Æ
.I dst
¤Ë¥³¥Ô¡¼¤µ¤ì¤ë¡£
.I dst
¤ÎŤµ¤Ï
.I "sizeof(struct in6_addr)"
(16) ¥Ð¥¤¥È (128 ¥Ó¥Ã¥È) ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.\"O The allowed formats for IPv6 addresses follow these rules:
°Ê²¼¤Î 3 ¤Ä¤Î¥ë¡¼¥ë¤Ë¤·¤¿¤¬¤Ã¤¿·Á¼°¤¬ IPv6 ¥¢¥É¥ì¥¹¤È¤·¤ÆÆþÎϤǤ­¤ë¡£
.RS
.IP 1. 3
.\"O The preferred format is
.\"O .IR x:x:x:x:x:x:x:x .
.\"O This form consists of eight hexadecimal numbers,
.\"O each of which expresses a 16-bit value (i.e., each
.\"O .I x
.\"O can be up to 4 hex digits).
¿ä¾©·Á¼°¤Ï
.I x:x:x:x:x:x:x:x
¤Ç¤¢¤ë¡£¤³¤Î·Á¼°¤Ï 8 ¸Ä¤Î 16 ¿Ê¿ô¤«¤é¹½À®¤µ¤ì¡¢
³Æ¡¹¤Î 16 ¿Ê¿ô¤Ï 16 ¥Ó¥Ã¥ÈÃͤòɽ¤¹
.RI ( x
¤ÏºÇÂç 4 ·å¤Î 16 ¿Ê¿ô¤Ç¤¢¤ë)¡£
.IP 2.
.\"O A series of contiguous zero values in the preferred format
.\"O can be abbreviated to
.\"O .IR :: .
.\"O Only one instance of
.\"O .I ::
.\"O can occur in an address.
.\"O For example, the loopback address
.\"O .I 0:0:0:0:0:0:0:1
.\"O can be abbreviated as
.\"O .IR ::1 .
.\"O The wildcard address, consisting of all zeros, can be written as
.\"O .IR :: .
¿ä¾©·Á¼°¤ÎÃæ¤ÎϢ³¤¹¤ë 0 ¤ÎÎó¤Ï
.I ::
¤Ëû½Ì¤Ç¤­¤ë¡£¥¢¥É¥ì¥¹Ãæ¤Ç»ÈÍѤǤ­¤ë
.I ::
¤Ï 1 ¸Ä¤À¤±¤Ç¤¢¤ë¡£
Î㤨¤Ð¡¢¥ë¡¼¥×¥Ð¥Ã¥¯¥¢¥É¥ì¥¹
.I 0:0:0:0:0:0:0:1
¤Ï
.I ::1
¤Èû½Ì¤Ç¤­¤ë¡£
Á´¥Ó¥Ã¥È¤¬ 0 ¤Ç¹½À®¤µ¤ì¤ë¥ï¥¤¥ë¥É¥«¡¼¥É¥¢¥É¥ì¥¹¤Ï
.I ::
¤Èµ­ºÜ¤Ç¤­¤ë¡£
.IP 3.
.\"O An alternate format is useful for expressing IPv4-mapped IPv6 addresses.
.\"O This form is written as
.\"O .IR x:x:x:x:x:x:d.d.d.d ,
.\"O where the six leading
.\"O .IR x s
.\"O are hexadecimal values that define the six most-significant
.\"O 16-bit pieces of the address (i.e., 96 bits), and the
.\"O .IR d s
.\"O express a value in dotted-decimal notation that
.\"O defines the least significant 32 bits of the address.
.\"O An example of such an address is
.\"O .IR ::FFFF:204.152.189.116 .
IPv4 ¤ò¥Þ¥Ã¥Ô¥ó¥°¤·¤¿ IPv6 ¥¢¥É¥ì¥¹¤òɽµ­¤¹¤ë¤Ë¤ÏÊ̤ηÁ¼°¤¬ÊØÍø¤Ç¤¢¤ë¡£
¤³¤ÎÊ̤ηÁ¼°¤Ï
.I x:x:x:x:x:x:d.d.d.d
¤È½ñ¤¯¤³¤È¤¬¤Ç¤­¤ë¡£
ºÇ½é¤Î 6 ¸Ä¤Î
.I x
¤Ï¥¢¥É¥ì¥¹¤ò 16 ¥Ó¥Ã¥Èñ°Ì¤Ë¶èÀڤ俤Ȥ­¤Î¾å°Ì¦ 6 ¸Äʬ (¤Ä¤Þ¤ê 96 ¥Ó¥Ã¥Èʬ)
¤òÄêµÁ¤¹¤ë 16 ¿Ê¿ô¤Ç¤¢¤ê¡¢
.I d
¤ÎÉôʬ¤Ï¥¢¥É¥ì¥¹¤Î²¼°Ì 32 ¥Ó¥Ã¥È¤ò¥É¥Ã¥È¶èÀÚ¤ê¤Î 10 ¿Ê¿ôɽµ­¤Çɽ¤·¤¿¤â¤Î¤Ç¤¢¤ë¡£
.I ::FFFF:204.152.189.116
¤Ï¤³¤Î·Á¼°¤ÎÎã¤Ç¤¢¤ë¡£
.RE
.IP
.\"O See RFC 2373 for further details on the representation of IPv6 addresses.
IPv6 ¥¢¥É¥ì¥¹¤Îɽ¸½ÊýË¡¤Î¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï RFC 2373 ¤ò»²¾È¤Î¤³¤È¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O .BR inet_pton ()
.\"O returns 1 on success (network address was successfully converted).
.\"O 0 is returned if
.\"O .I src
.\"O does not contain a character string representing a valid network
.\"O address in the specified address family.
.\"O If
.\"O .I af
.\"O does not contain a valid address family, \-1 is returned and
.\"O .I errno
.\"O is set to
.\"O .BR EAFNOSUPPORT .
À®¸ù¤¹¤ë (¥Í¥Ã¥È¥ï¡¼¥¯¥¢¥É¥ì¥¹¤¬Àµ¾ï¤ËÊÑ´¹¤µ¤ì¤ë) ¤È¡¢
.BR inet_pton ()
¤Ï 1 ¤òÊÖ¤¹¡£
.I src
¤¬»ØÄꤵ¤ì¤¿¥¢¥É¥ì¥¹¥Õ¥¡¥ß¥ê¡¼¤ËÂФ¹¤ë
Àµ¤·¤¤¥Í¥Ã¥È¥ï¡¼¥¯¥¢¥É¥ì¥¹É½µ­¤Ç¤Ê¤¤¾ì¹ç¤Ë¤Ï¡¢
0 ¤òÊÖ¤¹¡£
.I af
¤¬¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤ë¥¢¥É¥ì¥¹¥Õ¥¡¥ß¥ê¡¼¤Ç¤Ê¤¤¾ì¹ç¤Ë¤Ï¡¢
\-1 ¤òÊÖ¤·¡¢
.I errno
¤Ë
.B EAFNOSUPPORT
¤òÀßÄꤹ¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.
.\"O .SH NOTES
.SH Ãí°Õ
.\"O Unlike
.\"O .BR inet_aton (3)
.\"O and
.\"O .BR inet_addr (3),
.\"O .BR inet_pton ()
.\"O supports IPv6 addresses.
.BR inet_aton (3)
¤ä
.BR inet_addr (3)
¤È°Û¤Ê¤ê¡¢
.BR inet_pton ()
¤Ï IPv6 ¥¢¥É¥ì¥¹¤ËÂбþ¤·¤Æ¤¤¤ë¡£
.\"O On the other hand,
.\"O .BR inet_pton ()
.\"O only accepts IPv4 addresses in dotted-decimal notation, whereas
.\"O .BR inet_aton (3)
.\"O and
.\"O .BR inet_addr (3)
.\"O allow the more general numbers-and-dots notation (hexadecimal
.\"O and octal number formats, and formats that don't require all
.\"O four bytes to be explicitly written).
.\"O For an interface that handles both IPv6 addresses, and IPv4
.\"O addresses in numbers-and-dots notation, see
.\"O .BR getaddrinfo (3).
°ìÊý¤Ç¡¢
.BR inet_pton ()
¤¬¼õ¤±ÉÕ¤±¤ë IPv4 ¥¢¥É¥ì¥¹¤Ï¥É¥Ã¥È¶èÀÚ¤ê¤Î 10 ¿Ê¿ôɽµ­¤À¤±¤Ç¤¢¤ë¡£
¤³¤ì¤ËÂФ·¡¢
.BR inet_aton (3)
¤ä
.BR inet_addr (3)
¤Ç¤Ï¤â¤Ã¤È°ìÈÌŪ¤Ê¥É¥Ã¥È¶èÀÚ¤ê¤Î¿ô»úɽµ­ (16 ¿Ê¿ô¤ä 8 ¿Ê¿ô¤Î·Á¼°¤ä¡¢
4 ¥Ð¥¤¥ÈÁ´¤Æ¤òÌÀ¼¨Åª¤Ë½ñ¤«¤Ê¤¯¤Æ¤â¤è¤¤·Á¼°) ¤¬»ÈÍѤǤ­¤ë¡£
¥É¥Ã¥È¶èÀÚ¤ê¤Î¿ô»úɽµ­¤Ç IPv6 ¥¢¥É¥ì¥¹¤È IPv4 ¥¢¥É¥ì¥¹¤ÎξÊý¤ò°·¤¨¤ë
¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.BR getaddrinfo (3)
¤ò»²¾È¤Î¤³¤È¡£
.\"O .SH BUGS
.SH ¥Ð¥°
.\"O .B AF_INET6
.\"O does not recognize IPv4 addresses.
.\"O An explicit IPv4-mapped IPv6 address must be supplied in
.\"O .I src
.\"O instead.
.B AF_INET6
¤Ï IPv4 ¥¢¥É¥ì¥¹¤òǧ¼±¤·¤Ê¤¤¡£
Âå¤ï¤ê¤Ë IPv4 ¥¢¥É¥ì¥¹¤ò¥Þ¥Ã¥Ô¥ó¥°¤·¤¿ IPv6 ¥¢¥É¥ì¥¹¤ò
.I src
¤ËÍ¿¤¨¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.\"O .SH EXAMPLE
.SH Îã
.\"O The program below demonstrates the use of
.\"O .BR inet_pton ()
.\"O and
.\"O .BR inet_ntop (3).
.\"O Here are some example runs:
°Ê²¼¤Î¥×¥í¥°¥é¥à¤Ï
.BR inet_pton ()
¤È
.BR inet_ntop (3)
¤Î»ÈÍÑÎã¤ò¼¨¤¹¤â¤Î¤Ç¤¢¤ë¡£
¼Â¹Ô¤¹¤ë¤È°Ê²¼¤Î¤è¤¦¤Ë¤Ê¤ë¡£
.in +4n
.nf

.RB "$" " ./a.out i6 0:0:0:0:0:0:0:0"
::
.RB "$" " ./a.out i6 1:0:0:0:0:0:0:8"
1::8
.RB "$" " ./a.out i6 0:0:0:0:0:FFFF:204.152.189.116"
::ffff:204.152.189.116
.fi
.in
.\"O .SS Program source
.SS ¥×¥í¥°¥é¥à¤Î¥½¡¼¥¹
\&
.nf
#include <arpa/inet.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

int
main(int argc, char *argv[])
{
    unsigned char buf[sizeof(struct in6_addr)];
    int domain, s;
    char str[INET6_ADDRSTRLEN];

    if (argc != 3) {
        fprintf(stderr, "Usage: %s {i4|i6|<num>} string\\n", argv[0]);
        exit(EXIT_FAILURE);
    }

    domain = (strcmp(argv[1], "i4") == 0) ? AF_INET :
             (strcmp(argv[1], "i6") == 0) ? AF_INET6 : atoi(argv[1]);

    s = inet_pton(domain, argv[2], buf);
    if (s <= 0) {
        if (s == 0)
            fprintf(stderr, "Not in presentation format");
        else
            perror("inet_pton");
        exit(EXIT_FAILURE);
    }

    if (inet_ntop(domain, buf, str, INET6_ADDRSTRLEN) == NULL) {
        perror("inet_ntop");
        exit(EXIT_FAILURE);
    }

    printf("%s\\n", str);

    exit(EXIT_SUCCESS);
}
.fi
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR getaddrinfo (3),
.BR inet (3),
.BR inet_ntop (3)