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

.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\" and Copyright (c) 2008 Linux Foundation, written by 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 consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\"     libc.info (from glibc distribution)
.\" Modified Sat Jul 24 19:12:00 1993 by Rik Faith <faith@cs.unc.edu>
.\" Modified Sun Sep  3 20:29:36 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
.\" Changed network into host byte order (for inet_network),
.\"     Andreas Jaeger <aj@arthur.rhein-neckar.de>, 980130.
.\" 2008-06-19, mtk
.\"     Describe the various address forms supported by inet_aton().
.\"     Clarify discussion of inet_lnaof(), inet_netof(), and inet_makeaddr().
.\"     Add discussion of Classful Addressing, noting that it is obsolete.
.\"     Added an EXAMPLE program.
.\"
.\" Japanese Version Copyright (c) 1998 Ueyama Rui
.\"         all rights reserved.
.\" Translated 1998-05-23, Ueyama Rui <rui@linux.or.jp>
.\" Updated & Modefied 1999-02-26, Shouichi Saito
.\" Updated 1999-12-26, Kentaro Shirakata <argrath@ub32.org>
.\" Updated 2005-10-04, Kentaro Shirakata <argrath@ub32.org>
.\" Updated 2007-05-01, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.46
.\" Updated 2008-08-13, Akihiro MOTOKI, LDP v3.05
.\"
.\"WORD:        numbers-and-dots notation       数値とドットによる記法
.\"WORD:        dotted-decimal notation ドット区切りの 10 進数記法
.\"WORD:        feature test macro      機能検査マクロ
.\"
.TH INET 3  2008-06-19 "GNU" "Linux Programmer's Manual"
.\"O .SH NAME
.SH 名前
.\"O inet_aton, inet_addr, inet_network, inet_ntoa, inet_makeaddr, inet_lnaof,
.\"O inet_netof \- Internet address manipulation routines
inet_aton, inet_addr, inet_network, inet_ntoa, inet_makeaddr, inet_lnaof,
inet_netof \- インターネットアドレス操作ルーチン
.\"O .SH SYNOPSIS
.SH 書式
.nf
.B #include <sys/socket.h>
.B #include <netinet/in.h>
.B #include <arpa/inet.h>
.sp
.BI "int inet_aton(const char *" cp ", struct in_addr *" inp );
.sp
.BI "in_addr_t inet_addr(const char *" cp );
.sp
.BI "in_addr_t inet_network(const char *" cp );
.sp
.BI "char *inet_ntoa(struct in_addr " in );
.sp
.BI "struct in_addr inet_makeaddr(int " net ", int " host );
.sp
.BI "in_addr_t inet_lnaof(struct in_addr " in );
.sp
.BI "in_addr_t inet_netof(struct in_addr " in );
.fi
.sp
.in -4n
.\"O Feature Test Macro Requirements for glibc (see
.\"O .BR feature_test_macros (7)):
glibc 向けの機能検査マクロの要件
.RB ( feature_test_macros (7)
参照):
.in
.sp
.BR inet_aton (),
.BR inet_ntoa ():
_BSD_SOURCE || _SVID_SOURCE
.\"O .SH DESCRIPTION
.SH 説明
.\"O .BR inet_aton ()
.\"O converts the Internet host address \fIcp\fP from the
.\"O IPv4 numbers-and-dots notation into binary form (in network byte order)
.\"O and stores it in the structure that \fIinp\fP points to.
.\"O .BR inet_aton ()
.\"O returns nonzero if the address is valid, zero if not.
.\"O The address supplied in
.\"O .I cp
.\"O can have one of the following forms:
.BR inet_aton ()
は、インターネットホストのアドレス \fIcp\fP を、
IPv4 の数値とドットによる表記から (ネットワークバイトオーダの) バイナリ値へ
変換し、変換結果を \fIinp\fP が指している構造体に格納する。
アドレスが有効な場合 0 以外を返し、そうでない場合は 0 を返す。
.I cp
で渡すアドレスとして、以下の形式を用いることができる。
.TP 10
.I a.b.c.d
.\"O Each of the four numeric parts specifies a byte of the address;
.\"O the bytes are assigned in left-to-right order to produce the binary address.
4 つの数字のそれぞれはアドレスの各バイトを示す。
これらのバイトは左から右の順序でバイナリアドレスに割り当てられる。
.TP
.I a.b.c
.\"O Parts
.\"O .I a
.\"O and
.\"O .I b
.\"O specify the first two bytes of the binary address.
.\"O Part
.\"O .I c
.\"O is interpreted as a 16-bit value that defines the rightmost two bytes
.\"O of the binary address.
.\"O This notation is suitable for specifying (outmoded) Class B
.\"O network addresses.
.I a
と
.I b
はバイナリアドレスの最初の 2 バイトを示す。
.I c
は 16 ビット値と解釈され、バイナリアドレスの右側の 2 バイトを表す。
この表記は、(過去のものとなった) クラス B ネットワークアドレスを
指定するのに適している。
.TP
.I a.b
.\"O Part
.\"O .I a
.\"O specifies the first byte of the binary address.
.\"O Part
.\"O .I b
.\"O is interpreted as a 24-bit value that defines the rightmost three bytes
.\"O of the binary address.
.\"O This notation is suitable for specifying (outmoded) Class C
.\"O network addresses.
.I a
はバイナリアドレスの最初のバイトを示す。
.I b
は 24 ビット値と解釈され、バイナリアドレスの右側の 3 バイトを表す。
この表記は、(過去のものとなった) クラス C ネットワークアドレスを
指定するのに適している。
.TP
.I a
.\"O The value
.\"O .I a
.\"O is interpreted as a 32-bit value that is stored directly
.\"O into the binary address without any byte rearrangement.
値
.I a
は 32 ビット値と解釈され、バイトの再配置は行われず、
そのままバイナリアドレスとして格納される。
.PP
.\"O In all of the above forms,
.\"O components of the dotted address can be specified in decimal,
.\"O octal (with a leading
.\"O .IR 0 ),
.\"O or hexadecimal, with a leading
.\"O .IR 0X ).
.\"O Addresses in any of these forms are collectively termed
.\"O .IR "IPV4 numbers-and-dots notation" .
.\"O The form that uses exactly four decimal numbers is referred to as
.\"O .IR "IPv4 dotted-decimal notation"
.\"O (or sometimes:
.\"O .IR "IPv4 dotted-quad notation" ).
上記の全ての形式で、ドット区切りのアドレスの各要素は、10 進数、
8 進数 (先頭に
.I 0
を付ける)、
16 進数 (先頭に
.I 0X
を付ける) で指定できる。
これらの形式のアドレスをまとめて
.I "IPv4 の数値とドットによる表記 (IPv4 numbers-and-dots notation)"
と呼ぶ。
また、10 進数 4 つだけを使った形式を
.I "IPv4 のドット区切りの 10 進数表記 (IPv4 dotted-decimal notation)"
と呼ぶ
.RI ( "IPv4 のドット区切り 4 分割表記 (IPv4 dotted-decimal notation)"
と呼ぶこともある)。
.PP
.\"O The
.\"O .BR inet_addr ()
.\"O function converts the Internet host address
.\"O \fIcp\fP from IPv4 numbers-and-dots notation into binary data in network
.\"O byte order.
.\"O If the input is invalid,
.\"O .B INADDR_NONE
.\"O (usually \-1) is returned.
.\"O Use of this function is problematic because \-1 is a valid address
.\"O (255.255.255.255).
.\"O Avoid its use in favor of
.\"O .BR inet_aton (),
.\"O .BR inet_pton (3),
.\"O or
.\"O .BR getaddrinfo (3)
.\"O which provide a cleaner way to indicate error return.
.BR inet_addr ()
関数は、インターネットホストのアドレス \fIcp\fP を、
IPv4 の数値とドットによる表記からネットワークバイトオーダでの
バイナリ値へ変換して返す。
入力が不正な場合、
.B INADDR_NONE
(普通は \-1) を返す。
\-1 は有効なアドレス (255.255.255.255) なので、この関数を使うと
問題になるかもしれない。
この関数を使うのは避け、代わりに
.BR inet_aton (),
.BR inet_pton (3),
.BR getaddrinfo (3)
を使うのがよい。
これらの関数の方が、エラーの通知がよりきれいな方法で行われる。
.PP
.\"O The
.\"O .BR inet_network ()
.\"O function converts
.\"O .IR cp ,
.\"O a string in IPv4 numbers-and-dots notation,
.\"O into a number in host byte order suitable for use as an
.\"O Internet network address.
.\"O On success, the converted address is returned.
.\"O If the input is invalid, \-1 is returned.
.BR inet_network ()
関数は、
IPv4 の数値とドットによる表記の文字列 \fIcp\fP を、
インターネットアドレスとしての使用に適した
ホストバイトオーダの数値に変換する。
成功すると、変換されたアドレスを返す。
入力が不正な場合は \-1 を返す。
.PP
.\"O The
.\"O .BR inet_ntoa ()
.\"O function converts the Internet host address
.\"O \fIin\fP, given in network byte order, to a string in IPv4
.\"O dotted-decimal notation.
.\"O The string is returned in a statically
.\"O allocated buffer, which subsequent calls will overwrite.
.BR inet_ntoa ()
関数は、ネットワークバイトオーダで渡されたインターネットホストアドレス
\fIin\fP を、 IPv4 のドット区切りの 10 進数表記の文字列に変換する。
文字列は静的に割当てられたバッファに格納されて返されるので、
この後でこの関数を再度呼び出すと文字列は上書きされる。
.PP
.\"O The
.\"O .BR inet_lnaof ()
.\"O function returns the local network address part
.\"O of the Internet address \fIin\fP.
.\"O The returned value is in host byte order.
.BR inet_lnaof ()
関数は、インターネットアドレス \fIin\fP のローカルネットワーク部分を返す。
この返り値はホストバイトオーダである。
.PP
.\"O The
.\"O .BR inet_netof ()
.\"O function returns the network number part of
.\"O the Internet address \fIin\fP.
.\"O The returned value is in host byte order.
.BR inet_netof ()
関数は、インターネットアドレス \fIin\fP のネットワーク部分を返す。
この返り値はホストバイトオーダである。
.PP
.\"O The
.\"O .BR inet_makeaddr ()
.\"O function is the converse of
.\"O .BR inet_netof ()
.\"O and
.\"O .BR inet_lnaof ().
.\"O It returns an Internet host address in network byte order,
.\"O created by combining the network number \fInet\fP
.\"O with the local address \fIhost\fP, both in
.\"O host byte order.
.BR inet_makeaddr ()
関数は
.BR inet_netof ()
と
.BR inet_lnaof ()
の逆の機能を持つ。
ネットワーク番号 \fInet\fP と、ローカルアドレス \fIhost\fP を
組み合わせて生成した、インターネットホストアドレスを
ネットワークバイトオーダで返す。
\fIhost\fP, \fInet\fP はともにホストバイトオーダである。
.PP
.\"O The structure \fIin_addr\fP as used in
.\"O .BR inet_ntoa (),
.\"O .BR inet_makeaddr (),
.\"O .BR inet_lnaof ()
.\"O and
.\"O .BR inet_netof ()
.\"O is defined in
.\"O .I <fnetinet/in.h>
.\"O as:
.BR inet_ntoa (),
.BR inet_makeaddr (),
.BR inet_lnaof (),
.BR inet_netof ()
で使用する構造体 \fIin_addr\fP は
.I <netinet/in.h>
で次のように定義されている:
.sp
.in +4n
.nf
typedef uint32_t in_addr_t;

struct in_addr {
    in_addr_t s_addr;
};
.fi
.in
.\"O .SH "CONFORMING TO"
.SH 準拠
4.3BSD.
.\"O .BR inet_addr ()
.\"O and
.\"O .BR inet_ntoa ()
.\"O are specified in POSIX.1-2001.
.BR inet_addr (),
.BR inet_ntoa ()
は POSIX.1-2001 で規定されている。
.\"O .BR inet_aton ()
.\"O is not specified in POSIX.1-2001, but is available on most systems.
.BR inet_aton ()
は POSIX.1-2001 で規定されていないが、ほとんどのシステムで利用可能である。
.\"O .SH NOTES
.SH 注意
.\"O On the i386 the host byte order is Least Significant Byte
.\"O first (little endian), whereas the network byte order, as used on the
.\"O Internet, is Most Significant Byte first (big endian).
i386 ではホストバイトオーダは Least Significant Byte (LSB) first
(リトルエンディアン) だが、
インターネットで使われるネットワークバイトオーダは
Most Significant Byte (MSB) first (ビッグエンディアン)
である点に注意すること。

.\"O .BR inet_lnaof (),
.\"O .BR inet_netof (),
.\"O and
.\"O .BR inet_makeaddr ()
.\"O are legacy functions that assume they are dealing with
.\"O .IR "classful network addresses" .
.\"O Classful networking divides IPv4 network addresses into host and network
.\"O components at byte boundaries, as follows:
.BR inet_lnaof (),
.BR inet_netof (),
.BR inet_makeaddr ()
は過去の名残であり、渡されたアドレスが
.I "クラスフル・ネットワークアドレス (classful network addresses)"
であると仮定して処理を行う。
クラスフル・ネットワークアドレスでは、以下にあるように、
IPv4 ネットワークアドレスをバイト境界でネットワーク部とホスト部に分割する。
.TP 10
Class A
.\"O This address type is indicated by the value 0 in the
.\"O most significant bit of the (network byte ordered) address.
.\"O The network address is contained in the most significant byte,
.\"O and the host address occupies the remaining three bytes.
(ネットワークバイトオーダの) アドレスの最上位ビットが 0 の場合、
このアドレス種別となる。このアドレス種別では、
最上位バイトがネットワークアドレスを表し、
残りの 3 バイトがホストアドレスを表す。
.TP
Class B
.\"O This address type is indicated by the binary value 10 in the
.\"O most significant two bits of the address.
.\"O The network address is contained in the two most significant bytes,
.\"O and the host address occupies the remaining two bytes.
(ネットワークバイトオーダの) アドレスの上位側 2 ビットがバイナリ値で
10 の場合、このアドレス種別となる。このアドレス種別では、
上位 2 バイトがネットワークアドレスを表し、
残りの 2 バイトがホストアドレスを表す。
.TP
Class C
.\"O This address type is indicated by the binary value 110 in the
.\"O most significant three bits of the address.
.\"O The network address is contained in the three most significant bytes,
.\"O and the host address occupies the remaining byte.
(ネットワークバイトオーダの) アドレスの上位側 3 ビットがバイナリ値で
110 の場合、このアドレス種別となる。このアドレス種別では、
上位 3 バイトがネットワークアドレスを表し、
残りの 1 バイトがホストアドレスを表す。
.PP
.\"O Classful network addresses are now obsolete,
.\"O having been superseded by Classless Inter-Domain Routing (CIDR),
.\"O which divides addresses into network and host components at
.\"O arbitrary bit (rather than byte) boundaries.
クラスフル・ネットワークアドレスは現在では廃止され、
クラスレス・ドメイン間ルーチン (CIDR) に取って代わられた。
CIDR では、アドレスを任意のビット境界 (バイト境界ではない) で
ネットワーク部とホスト部に分割する。
.\"O .SH EXAMPLE
.SH 例
.\"O An example of the use of
.\"O .BR inet_aton ()
.\"O and
.\"O .BR inet_ntoa ()
.\"O is shown below.
.\"O Here are some example runs:
以下は
.BR inet_aton ()
と
.BR inet_ntoa ()
の使用例である。このように実行する。
.in +4n
.nf

.RB "$" " ./a.out 226.000.000.037" "      # Last byte is in octal"
226.0.0.31
.RB "$" " ./a.out 0x7f.1         " "      # First byte is in hex"
127.0.0.1
.fi
.in
.\"O .SS Program source
.SS プログラムのソース
\&
.nf
#define _BSD_SOURCE
#include <arpa/inet.h>
#include <stdio.h>
#include <stdlib.h>

int
main(int argc, char *argv[])
{
    struct in_addr addr;

    if (argc != 2) {
        fprintf(stderr, "%s <dotted\-address>\\n", argv[0]);
        exit(EXIT_FAILURE);
    }

    if (inet_aton(argv[1], &addr) == 0) {
        perror("inet_aton");
        exit(EXIT_FAILURE);
    }

    printf("%s\\n", inet_ntoa(addr));
    exit(EXIT_SUCCESS);
}
.fi
.\"O .SH "SEE ALSO"
.SH 関連項目
.BR byteorder (3),
.BR getaddrinfo (3),
.BR gethostbyname (3),
.BR getnameinfo (3),
.BR getnetent (3),
.BR inet_ntop (3),
.BR inet_pton (3),
.BR hosts (5),
.BR networks (5)