OSDN Git Service

Update README
[linuxjm/LDP_man-pages.git] / release / man3 / netlink.3
index 8c8bd9f..49ce39c 100644 (file)
@@ -1,6 +1,17 @@
-.\" This manpage copyright 1998 by Andi Kleen. Subject to the GPL.
+.\" This manpage copyright 1998 by Andi Kleen.
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
+.\" Subject to the GPL.
+.\" %%%LICENSE_END
+.\"
 .\" Based on the original comments from Alexey Kuznetsov
-.\" $Id: netlink.3,v 1.4 2000/09/07 07:21:43 hanataka Exp $
+.\" $Id: netlink.3,v 1.1 1999/05/14 17:17:24 freitag Exp $
+.\"
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
 .\"
 .\" Japanese Version Copyright (c) 1999 Shouichi Saito
 .\"    all rights reserved.
 .\"    by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
 .\" Proofed Fri Aug 20 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
 .\"
-.\"WORD:       payload         ³ÊǼÎΰè
-.\"WORD:       lvalue          º¸ÊÕÃÍ
-.\"
-.TH NETLINK 3 1999-05-14 "GNU" "Linux Programmer's Manual"
-.SH Ì¾Á°
-netlink \- netlink ¥Þ¥¯¥í
-.SH ½ñ¼°
+.TH NETLINK 3 2014\-03\-20 GNU "Linux Programmer's Manual"
+.SH 名前
+netlink \- netlink マクロ
+.SH 書式
 .nf
-.\" FIXME . what will glibc 2.1 use here?
-.\" May 2007: glibc 2.5, things look to be unchanged -- the header file
-.\" is still linux/netlink.h -- mtk
-.B #include <asm/types.h>
+\fB#include <asm/types.h>\fP
 .br
-.B #include <linux/netlink.h>
+\fB#include <linux/netlink.h>\fP
 .sp
-.BI "int NLMSG_ALIGN(size_t " len );
+\fBint NLMSG_ALIGN(size_t \fP\fIlen\fP\fB);\fP
 .br
-.BI "int NLMSG_LENGTH(size_t " len );
+\fBint NLMSG_LENGTH(size_t \fP\fIlen\fP\fB);\fP
 .br
-.BI "int NLMSG_SPACE(size_t " len );
+\fBint NLMSG_SPACE(size_t \fP\fIlen\fP\fB);\fP
 .br
-.BI "void *NLMSG_DATA(struct nlmsghdr *" nlh );
+\fBvoid *NLMSG_DATA(struct nlmsghdr *\fP\fInlh\fP\fB);\fP
 .br
-.BI "struct nlmsghdr *NLMSG_NEXT(struct nlmsghdr *" nlh ", int " len );
+\fBstruct nlmsghdr *NLMSG_NEXT(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
 .br
-.BI "int NLMSG_OK(struct nlmsghdr *" nlh ", int " len );
+\fBint NLMSG_OK(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
 .br
-.BI "int NLMSG_PAYLOAD(struct nlmsghdr *" nlh ", int " len );
+\fBint NLMSG_PAYLOAD(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
 .fi
-.SH ÀâÌÀ
-.I <linux/netlink.h>
-¤Ç¤Ï¡¢ netlink ¥Ç¡¼¥¿¥°¥é¥à¤Ë¥¢¥¯¥»¥¹¤·¤¿¤ê¡¢¤³¤ì¤òºîÀ®¤¹¤ë¤¿¤á¤Î
-ɸ½à¥Þ¥¯¥í¤¬¤¤¤¯¤Ä¤«ÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
-¤³¤ì¤é¤Ï
-.BR cmsg (3)
-¤ÇÄêµÁ¤µ¤ì¤Æ¤¤¤ëÊä½õ¥Ç¡¼¥¿ (auxiliary data) ÍѤΥޥ¯¥í¤È¡¢
-¤½¤ÎÀº¿À¤Ë¤ª¤¤¤Æ»÷¤Æ¤¤¤ë¤â¤Î¤Ç¤¢¤ë¡£
-netlink ¥½¥±¥Ã¥È¤ËÂФ·¤Æ¤ä¤ê¤È¤ê¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡¤Ë¤Ï¡¢
-ɬ¤º¤³¤ì¤é¤Î¥Þ¥¯¥í¤ò»È¤Ã¤Æ¥¢¥¯¥»¥¹¤¹¤Ù¤­¤Ç¤¢¤ë¡£
-.TP
-.B NLMSG_ALIGN
-netlink ¥á¥Ã¥»¡¼¥¸¤ÎŤµ¤ò´Ý¤á¤ÆÀµ¤·¤¯Â·¤¨¤ë¡£
-.TP
-.B NLMSG_LENGTH
-³ÊǼÎΰè (payload) ¤ÎŤµ
-.I len
-¤ò°ú¿ô¤Ë¤È¤ê¡¢
-.I nlmsghdr
-¤Î
-.I nlmsg_len
-¥Õ¥£¡¼¥ë¥É¤ËÂåÆþ¤Ç¤­¤ë
-·¤¨¤é¤ì¤¿Ä¹¤µ (aligned length) ¤òÊÖ¤¹¡£
-.TP
-.B NLMSG_SPACE
-¥Ú¥¤¥í¡¼¥É¤ÎŤµ¤¬
-.I len
-¤Î netlink ¥á¥Ã¥»¡¼¥¸¤Î¥Ð¥¤¥È¿ô¤òÊÖ¤¹¡£
-.TP
-.B NLMSG_DATA
-Í¿¤¨¤¿
-.I nlmsghdr
-¤Ë´ØÏ¢¤Å¤±¤é¤ì¤¿³ÊǼÎΰè¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£
-.TP
+.SH 説明
+\fI<linux/netlink.h>\fP では、 netlink データグラムにアクセスしたり、これを作成するための
+標準マクロがいくつか定義されている。 これらは \fBcmsg\fP(3)  で定義されている補助データ (auxiliary data) 用のマクロと、
+その精神において似ているものである。 netlink ソケットに対してやりとりされるバッファーには、
+必ずこれらのマクロだけを使ってアクセスすべきである。
+.TP 
+\fBNLMSG_ALIGN\fP
+netlink メッセージの長さを丸めて正しく揃える。
+.TP 
+\fBNLMSG_LENGTH\fP
+格納領域 (payload) の長さ \fIlen\fP を引数にとり、 \fInlmsghdr\fP の \fInlmsg_len\fP フィールドに代入できる
+揃えられた長さ (aligned length) を返す。
+.TP 
+\fBNLMSG_SPACE\fP
+ペイロードの長さが \fIlen\fP の netlink メッセージのバイト数を返す。
+.TP 
+\fBNLMSG_DATA\fP
+与えた \fInlmsghdr\fP に関連づけられた格納領域へのポインターを返す。
+.TP 
 .\" this is bizarre, maybe the interface should be fixed.
-.B NLMSG_NEXT
-¥Þ¥ë¥Á¥Ñ¡¼¥È¥á¥Ã¥»¡¼¥¸¤Ë¤ª¤¤¤Æ¡¢¼¡¤Î
-.I nlmsghdr
-¤òÆþ¼ê¤¹¤ë¡£¤³¤ì¤ò¸Æ¤Ó½Ð¤¹¤È¤­¤Ë¤Ï¡¢
-¸½ºß¤Î nlmsghdr ¤Ç NLMSG_DONE ¤¬¥»¥Ã¥È¤µ¤ì¤Æ¤¤¤Ê¤¤¤³¤È¤ò
-³Îǧ¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£¤³¤Î´Ø¿ô¤Ï½ªÃ¼¤Ç NULL ¤òÊÖ¤µ¤Ê¤¤¤«¤é¤Ç¤¢¤ë¡£
-.I len
-°ú¿ô¤Ï¥á¥Ã¥»¡¼¥¸¥Ð¥Ã¥Õ¥¡¤Î»Ä¤êŤµ¤¬Æþ¤Ã¤¿º¸ÊÕÃͤǤ¢¤ë¡£
-¤³¤Î¥Þ¥¯¥í¤Ï¤³¤Î°ú¿ô¤«¤é¥á¥Ã¥»¡¼¥¸¥Ø¥Ã¥À¤ÎŤµÊ¬¤òº¹¤·°ú¤¯¡£
-.TP
-.B NLMSG_OK
-Netlink ¥á¥Ã¥»¡¼¥¸¤¬ÅÓÀÚ¤ì¤Æ¤ª¤é¤º¡¢¥Ñ¡¼¥º²Äǽ¤Ç¤¢¤ì¤Ð¿¿¤òÊÖ¤¹¡£
-.TP
-.B NLMSG_PAYLOAD
-.I nlmsghdr
-¤Ë´ØÏ¢¤Å¤±¤é¤ì¤¿³ÊǼÎΰè¤ÎŤµ¤òÊÖ¤¹¡£
-.SH ½àµò
-¤³¤ì¤é¤Î¥Þ¥¯¥í¤ÏÈóɸ½à¤Ç Linux ¤Ç¤Î³ÈÄ¥¤Ç¤¢¤ë¡£
-.SH Ãí°Õ
-Ä̾ï¤Ï¥«¡¼¥Í¥ë¤ÎÄã¥ì¥Ù¥ë¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹¤è¤ê¤â¡¢
-.I libnetlink
-·Ðͳ¤Ç netlink ¤òÍѤ¤¤ë¤Û¤¦¤¬Îɤ¤¡£
-.SH ´ØÏ¢¹àÌÜ
-.BR netlink (7)
-.br
-¤ª¤è¤Ó libnetlink ¤Ë´Ø¤·¤Æ¤Ï ftp://ftp.inr.ac.ru/ip-routing/iproute2*
+\fBNLMSG_NEXT\fP
+マルチパートメッセージにおいて、次の \fInlmsghdr\fP を入手する。これを呼び出すときには、 現在の nlmsghdr で NLMSG_DONE
+がセットされていないことを 確認しなければならない。この関数は終端で NULL を返さないからである。 \fIlen\fP
+引数はメッセージバッファーの残り長さが入った左辺値である。 このマクロはこの引数からメッセージヘッダーの長さ分を差し引く。
+.TP 
+\fBNLMSG_OK\fP
+Netlink メッセージが途切れておらず、かつ解釈可能な形の場合であれば真を返す。
+.TP 
+\fBNLMSG_PAYLOAD\fP
+\fInlmsghdr\fP に関連づけられた格納領域の長さを返す。
+.SH 準拠
+これらのマクロは非標準で、Linux での拡張である。
+.SH 注意
+通常はカーネルの低レベルインターフェイスよりも、 \fIlibnetlink\fP 経由で netlink を用いるほうが良い。
+.SH 関連項目
+\fBlibnetlink\fP(3), \fBnetlink\fP(7)
+.SH この文書について
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
+である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man\-pages/ に書かれている。