OSDN Git Service

(split) LDP: Update release pages
[linuxjm/LDP_man-pages.git] / release / man3 / realpath.3
index bea1b20..f232bf2 100644 (file)
@@ -1,5 +1,6 @@
-.\" Copyright (C), 1994, Graeme W. Wilford. (Wilf.)
+.\" Copyright (C) 1999 Andries Brouwer (aeb@cwi.nl)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" 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.
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" Rewritten old page, 990824, aeb@cwi.nl
 .\" 2004-12-14, mtk, added discussion of resolved_path == NULL
 .\"
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
 .\" Japanese Version Copyright (c) 1998 SHOJI Yasushi all rights reserved.
 .\" Translated 1998-03-22, SHOJI Yasushi <yashi@yashi.com>
 .\" Updated 1999-03-07, Shouichi Saito
 .\" Updated 2005-02-27, Akihiro MOTOKI
 .\" Updated 2005-09-06, Akihiro MOTOKI
 .\" Updated 2009-04-24, Akihiro MOTOKI, LDP v3.20
+.\" Updated 2012-05-29, Akihiro MOTOKI <amotoki@gmail.com>
+.\" Updated 2013-03-27, Akihiro MOTOKI <amotoki@gmail.com>
 .\"
-.\"WORD: bounded       À©¸Â¤¬¤Ê¤¤
-.\"
-.TH REALPATH 3  2009-02-23 "" "Linux Programmer's Manual"
-.SH Ì¾Á°
-realpath \- Àµµ¬²½¤µ¤ì¤¿ÀäÂХѥ¹Ì¾¤òÊÖ¤¹
-.SH ½ñ¼°
+.TH REALPATH 3 2013\-03\-15 "" "Linux Programmer's Manual"
+.SH 名前
+realpath \- 正規化された絶対パス名を返す
+.SH 書式
 .nf
-.B #include <limits.h>
-.B #include <stdlib.h>
+\fB#include <limits.h>\fP
+\fB#include <stdlib.h>\fP
 .sp
-.BI "char *realpath(const char *" path ", char *" resolved_path );
+\fBchar *realpath(const char *\fP\fIpath\fP\fB, char *\fP\fIresolved_path\fP\fB);\fP
 .fi
 .sp
 .in -4n
-glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
-.RB ( feature_test_macros (7)
-»²¾È):
+glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
 .in
 .sp
-.BR realpath ():
-_BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500
-.SH ÀâÌÀ
-.BR realpath ()
-¤Ï
-.I path
-¤È¤·¤ÆÍ¿¤¨¤é¤ì¤¿ NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎóÃæ¤Î
-¤¹¤Ù¤Æ¤Î¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤òŸ³«¤·¡¢
-.IR "/./" ", " "/../"
-¤Ë¤è¤ë»²¾È¤ä;ʬ¤Ê \(aq/\(aq
-¤ò²ò·è¤·¤Æ¡¢Àµµ¬²½¤µ¤ì¤¿ÀäÂХѥ¹Ì¾¤òÀ¸À®¤¹¤ë¡£
-ÆÀ¤é¤ì¤¿ÀäÂХѥ¹Ì¾¤Ï¡¢ºÇÂç¤Ç
-.B PATH_MAX
-¥Ð¥¤¥È¤Î NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎó¤È¤·¤Æ¡¢
-.I resolved_path
-¤Ë¤è¤ê»²¾È¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡¤Ë³ÊǼ¤µ¤ì¤ë¡£
-·ë²Ì¤È¤·¤ÆÊÖ¤ë¥Ñ¥¹¤ÎÃæ¤Ë¤Ï¡¢¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤ä
-.IR "/./" ", " "/../"
-¤È¤¤¤Ã¤¿Í×ÁǤϴޤޤì¤Ê¤¤¡£
-.I resolved_path
-¤Ë NULL ¤¬»ØÄꤵ¤ì¤ë¤È¡¢
-.BR realpath ()
-¤Ï
-.BR malloc (3)
-¤ò»È¤Ã¤Æ²ò·è¤·¤¿¥Ñ¥¹Ì¾¤òÊÝ»ý¤¹¤ë¤¿¤á¤Î¥Ð¥Ã¥Õ¥¡¤ò
-ºÇÂç¤Ç
-.B PATH_MAX
-¥Ð¥¤¥È¤Þ¤Ç³ä¤êÅö¤Æ¡¢¤³¤Î¥Ð¥Ã¥Õ¥¡¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£
-¸Æ¤Ó½Ð¤·¸µ¤Ï¡¢
-.BR free (3)
-¤ò»È¤Ã¤Æ¤³¤Î¥Ð¥Ã¥Õ¥¡¤ò²òÊü¤¹¤Ù¤­¤Ç¤¢¤ë¡£
-.\" resolved_path == NULL ¤ò»ØÄꤷ¤¿¾ì¹ç¤Ç¤â¡¢²ò·è¤·¤¿¥Ñ¥¹Ì¾¤ÎŤµ¤¬
-.\" PATH_MAX ¥Ð¥¤¥È¤òĶ¤¨¤¿¤È¤­¤Ë¤Ï¡¢realpath() ¤ÏÁ°¤ÈƱ¤¸¤¯
-.\" ENAMETOOLONG ¤òÊÖ¤¹¡£-- MTK, Dec 04
-.\" .SH Îò»Ë
+\fBrealpath\fP():
+.ad l
+.RS 4
+_BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
+.RE
+.ad
+.SH 説明
+\fBrealpath\fP()  は \fIpath\fP として与えられた NULL 終端された文字列中の すべてのシンボリックリンクを展開し、 \fI/./\fP,
+\fI/../\fP による参照や余分な \(aq/\(aq を解決して、正規化された絶対パス名を生成する。 得られた絶対パス名は、最大で
+\fBPATH_MAX\fP バイトの NULL 終端された文字列として、 \fIresolved_path\fP により参照されるバッファに格納される。
+結果として返るパスの中には、シンボリックリンクや \fI/./\fP, \fI/../\fP といった要素は含まれない。
+
+.\" Even if we use resolved_path == NULL, then realpath() will still
+.\" return ENAMETOOLONG if the resolved pathname would exceed PATH_MAX
+.\" bytes -- MTK, Dec 04
+.\" .SH HISTORY
+.\" The
 .\" .BR realpath ()
-.\" ´Ø¿ô¤Ï 4.4BSD ¤Ç½é¤á¤ÆÅо줷¤¿ (Jan-Simon Pendry ¤Ë¤è¤êÄ󶡤µ¤ì¤¿)¡£
-.SH ÊÖ¤êÃÍ
-¥¨¥é¡¼¤¬¤Ê¤«¤Ã¤¿¾ì¹ç¡¢
-.BR realpath ()
-¤Ï
-.I resolved_path
-¤Ø¤Î¥Ý¥¤¥ó¥¿¡¼¤òÊÖ¤¹¡£
+.\" function first appeared in 4.4BSD, contributed by Jan-Simon Pendry.
+\fIresolved_path\fP に NULL が指定されると、 \fBrealpath\fP()  は \fBmalloc\fP(3)
+を使って解決したパス名を保持するためのバッファを 最大で \fBPATH_MAX\fP バイトまで割り当て、このバッファへのポインタを返す。 呼び出し元は、
+\fBfree\fP(3)  を使ってこのバッファを解放すべきである。
+.SH 返り値
+エラーがなかった場合、 \fBrealpath\fP()  は \fIresolved_path\fP へのポインターを返す。
 
-¤½¤ì°Ê³°¤Î¾ì¹ç¤Ï¡¢¥Ì¥ë (NULL) ¥Ý¥¤¥ó¥¿¡¼¤¬Ê֤ꡢÇÛÎó
-.I resolved_path
-¤ÎÆâÍƤÏÉÔÄê¤È¤Ê¤ê¡¢
-.I errno
-¤Ë¥¨¥é¡¼¤ÎÆâÍƤò¼¨¤¹Ãͤ¬¥»¥Ã¥È¤µ¤ì¤ë¡£
-.SH ¥¨¥é¡¼
-.TP
-.B EACCES
-¥Ñ¥¹¤Î¥Ç¥£¥ì¥¯¥È¥êÉôʬ¤Ë¡¢Æɤ߽Ф·µö²Ä¤Þ¤¿¤Ï¸¡º÷µö²Ä¤¬Í¿¤¨¤é¤ì¤Æ¤¤¤Ê¤¤¡£
-.TP
-.B EINVAL
-.I path
-¤«
-.I resolved_path
-¤Î¤¤¤º¤ì¤«¤¬ NULL ¤Ç¤¢¤ë¡£
-(libc5 ¤Ç¤Ï¡¢¤³¤Î¤è¤¦¤Ê¾ì¹ç segfault ¤òµ¯¤³¤¹¤À¤±¤Ç¤¢¤í¤¦)
-⤷¡¢²¼µ­¤Î¡ÖÃí°Õ¡×¤ÎÀá¤ò»²¾È¤Î¤³¤È¡£
-.TP
-.B EIO
-¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤òÆɤà¤È¤­¤Ë¡¢I/O¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
-.TP
-.B ELOOP
-¥Ñ¥¹Ì¾¤ÎÊÑ´¹¤Ë¤¢¤¿¤ê¡¢²ò·è¤¹¤Ù¤­¥·¥ó¥Ü¥ê¥Ã¥¯¡¦¥ê¥ó¥¯¤Î¿ô¤¬Â¿²á¤®¤¿¡£
-.TP
-.B ENAMETOOLONG
-¥Ñ¥¹Ì¾¤Î°ìÍ×ÁǤÎʸ»ú¿ô¤¬
-.B NAME_MAX
-¤ò±Û¤¨¤Æ¤¤¤ë¡¢¤Þ¤¿¤Ï¥Ñ¥¹Ì¾Á´ÂΤÎʸ»ú¿ô¤¬
-.B PATH_MAX
-¤ò±Û¤¨¤Æ¤¤¤ë¡£
-.TP
-.B ENOENT
-»ØÄꤵ¤ì¤¿¥Õ¥¡¥¤¥ë¤¬Â¸ºß¤·¤Ê¤¤¡£
-.TP
-.B ENOTDIR
-¥Ñ¥¹¤Î¥Ç¥£¥ì¥¯¥È¥êÍ×ÁǤ¬¡¢¥Ç¥£¥ì¥¯¥È¥ê¤Ç¤Ê¤¤¡£
-.SH ¥Ð¡¼¥¸¥ç¥ó
-¤³¤Î´Ø¿ô¤¬ Linux ¤ËÅо줷¤¿¤Î¤Ï libc 4.5.21 ¤Ç¤¢¤ë¡£
-.SH ½àµò
-4.4BSD, POSIX.1-2001.
+それ以外の場合は、ヌル (NULL) ポインターが返り、配列 \fIresolved_path\fP の内容は不定となり、 \fIerrno\fP
+にエラーの内容を示す値がセットされる。
+.SH エラー
+.TP 
+\fBEACCES\fP
+パスのディレクトリ部分に、読み出し許可または検索許可が与えられていない。
+.TP 
+\fBEINVAL\fP
+.\" (In libc5 this would just cause a segfault.)
+\fIpath\fP が NULL である。 (バージョン 2.3 より前の glibc では、 \fIresolved_path\fP が NULL
+の場合にもこのエラーが返される。)
+.TP 
+\fBEIO\fP
+ファイルシステムを読むときに、I/Oエラーが起こった。
+.TP 
+\fBELOOP\fP
+パス名の変換にあたり、解決すべきシンボリック・リンクの数が多過ぎた。
+.TP 
+\fBENAMETOOLONG\fP
+パス名の一要素の文字数が \fBNAME_MAX\fP を越えている、またはパス名全体の文字数が \fBPATH_MAX\fP を越えている。
+.TP 
+\fBENOENT\fP
+指定されたファイルが存在しない。
+.TP 
+\fBENOTDIR\fP
+パスのディレクトリ要素が、ディレクトリでない。
+.SH バージョン
+Linux では、この関数が登場したのは libc 4.5.21 である。
+.SH 準拠
+4.4BSD, POSIX.1\-2001.
 
-POSIX.1-2001 ¤Ç¤Ï
-.I resolved_path
-¤¬ NULL ¤Î¾ì¹ç¤ÎÆ°ºî¤Ï¼ÂÁõ¤Ë°Í¸¤¹¤ë¤È¤·¤Æ¤¤¤ë¡£
-POSIX.1-2008 ¤Ç¤Ï¡¢¤³¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë½ñ¤«¤ì¤Æ¤¤¤ëÆ°ºî¤¬µ¬Äꤵ¤ì¤Æ¤¤¤ë¡£
-.SH Ãí°Õ
-4.4BSD ¤È Solaris ¤Ç¤Ï¡¢¥Ñ¥¹Ì¾¤ÎŤµ¤Î¾å¸Â¤Ï
-(\fI<sys/param.h>\fP ¤ÎÃæ¤Ë¤¢¤ë)
-.B MAXPATHLEN
-¤Ç¤¢¤ë¡£SUSv2 ¤Ç¤Ï
-.B PATH_MAX
-¤È
-.B NAME_MAX
-¤¬µ¬Äꤵ¤ì¤Æ¤ª¤ê¡¢
-¤³¤ì¤é¤Ï \fI<limits.h>\fP ¤ÇÄêµÁ¤µ¤ì¤Æ¤¤¤ë¤«¡¢
-.BR pathconf (3)
-´Ø¿ô¤«¤éÆÀ¤é¤ì¤ë¡£°Ê²¼¤Î¤è¤¦¤Ê¥½¡¼¥¹¥³¡¼¥É¤Ë¤Ê¤Ã¤Æ¤¤¤ë¤³¤È¤¬Â¿¤¤¡£
+POSIX.1\-2001 では \fIresolved_path\fP が NULL の場合の動作は実装に依存するとしている。 POSIX.1\-2008
+では、このマニュアルページに書かれている動作が規定されている。
+.SH 注意
+4.4BSD と Solaris では、パス名の長さの上限は (\fI<sys/param.h>\fP の中にある)
+\fBMAXPATHLEN\fP である。SUSv2 では \fBPATH_MAX\fP と \fBNAME_MAX\fP が規定されており、 これらは
+\fI<limits.h>\fP で定義されているか、 \fBpathconf\fP(3)
+関数から得られる。以下のようなソースコードになっていることが多い。
 .LP
 .in +4n
 .nf
@@ -164,52 +132,40 @@ POSIX.1-2008 
 .fi
 .in
 .LP
-(¥Ð¥°¤Î¾Ï¤â»²¾È¤Î¤³¤È¡£) 
+(バグの章も参照のこと。)
 .LP
-4.4BSD¡¢Linux¡¢SUSv2 ¤Ç¤Ï¡¢ÊÖ¤êÃͤϾï¤ËÀäÂХѥ¹Ì¾¤Ç¤¢¤ë¡£
-Solaris ¤Ç¤Ï¡¢
-°ú¤­¿ô
-.I path
-¤¬ÁêÂХѥ¹¤Î¾ì¹ç¡¢ÊÖ¤êÃͤ¬ÁêÂХѥ¹¤Ë¤Ê¤ë¤³¤È¤¬¤¢¤ë¡£
-.BR realpath ()
-¤Î¥×¥í¥È¥¿¥¤¥×Àë¸À¤Ï¡¢
-libc4 ¤È libc5 ¤Ç¤Ï \fI<unistd.h>\fP ¤Ë¤¢¤ë¤¬¡¢
-¤½¤ì°Ê³°¤Î´Ä¶­¤Ç¤Ï¤¤¤º¤ì¤â \fI<stdlib.h>\fP ¤Ë¤¢¤ë¡£
-.SH ¥Ð¥°
-¤³¤Î´Ø¿ô¤Î POSIX.1-2001 ÈǤϡ¢Àß·×Ãʳ¬¤«¤éÌäÂ꤬¤¢¤ë¡£
-½ÐÎϥХåե¡
-.I resolved_path
-¤ÎŬÀڤʥµ¥¤¥º¤ò·èÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤Ê¤¤¤«¤é¤Ç¤¢¤ë¡£
-POSIX.1-2001 ¤Ç¤Ï¥Ð¥Ã¥Õ¥¡¡¦¥µ¥¤¥º¤È¤·¤Æ
-.B PATH_MAX
-¤Ï½½Ê¬¤À¤È¤µ¤ì¤Æ¤¤¤ë¤¬¡¢
-.B PATH_MAX
-¤ÏÄêµÁºÑ¤ÎÄê¿ô¤Ç¤¢¤ëɬÍפϤʤ¯¡¢
-.BR pathconf (3)
-¤ò»È¤Ã¤ÆÆÀ¤é¤ì¤ëÃͤǤ¢¤Ã¤Æ¤â¤è¤¤¤³¤È¤Ë¤Ê¤Ã¤Æ¤¤¤ë¡£
-.BR pathconf (3)
-¤«¤é¥Ð¥Ã¥Õ¥¡¡¦¥µ¥¤¥º¤ò¼èÆÀ¤·¤¿¤È¤·¤Æ¤âɬ¤º¤·¤â½½Ê¬¤Ç¤Ï¤Ê¤¤¡£
-¤Ê¤¼¤Ê¤é¡¢POSIX ¤Ç·Ù¹ð¤µ¤ì¤Æ¤¤¤ë¤è¤¦¤Ë¡¢
-.BR pathconf (3)
-¤ÎÊÖ¤êÃͤ¬Â礭²á¤®¤ÆŬÀڤ˥á¥â¥ê¤ò³ÎÊݤ¹¤ë¤³¤È¤¬¤Ç¤­¤Ê¤¤
-¤«¤â¤·¤ì¤Ê¤¤°ìÊý¤Ç¡¢
-.BR pathconf (3)
-¤Ï
-.B PATH_MAX
-¤ËÀ©¸Â¤¬¤Ê¤¤¤³¤È¤ò¼¨¤¹ \-1 ¤òÊÖ¤¹¤«¤â¤·¤ì¤Ê¤¤¤«¤é¤Ç¤¢¤ë¡£
-.I "resolved_path\ ==\ NULL"
-¤Îµ¡Ç½¤ò»È¤¦¤È¡¢¤³¤ÎÀß·×¾å¤ÎÌäÂê¤ò²óÈò¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
-¤³¤Îµ¡Ç½¤Ï POSIX.1-2001 ¤Ç¤Ïɸ½à²½¤µ¤ì¤Æ¤¤¤Ê¤¤¤¬¡¢
-POSIX.1-2008 ¤Ç¤Ïɸ½à²½¤µ¤ì¤Æ¤¤¤ë¡£
+.\"     2012-05-05, According to Casper Dik, the statement about
+.\"     Solaris was not true at least as far back as 1997, and
+.\"     may never have been true.
+.\"
+.\" The 4.4BSD, Linux and SUSv2 versions always return an absolute
+.\" pathname.
+.\" Solaris may return a relative pathname when the
+.\" .I path
+.\" argument is relative.
+\fBrealpath\fP() のプロトタイプ宣言は、 libc4 と libc5 では
+\fI<unistd.h>\fP にあるが、それ以外の環境ではいずれも
+\fI<stdlib.h>\fP にある。
+.SS "GNU による拡張"
+呼び出しが \fBEACCES\fP か \fBENOENT\fP で失敗し \fIresolved_path\fP が NULL
+でない場合、読むことができない、もしくは存在しない \fIpath\fP のディレクトリ要素 (prefix) が \fIresolved_path\fP
+で返される。
+.SH バグ
+この関数の POSIX.1\-2001 版は、設計段階から問題がある。 出力バッファ \fIresolved_path\fP
+の適切なサイズを決定することができないからである。 POSIX.1\-2001 ではバッファ・サイズとして \fBPATH_MAX\fP
+は十分だとされているが、 \fBPATH_MAX\fP は定義済の定数である必要はなく、 \fBpathconf\fP(3)
+を使って得られる値であってもよいことになっている。 \fBpathconf\fP(3)  からバッファ・サイズを取得したとしても必ずしも十分ではない。
+なぜなら、POSIX で警告されているように、 \fBpathconf\fP(3)  の返り値が大き過ぎて適切にメモリを確保することができない
+かもしれない一方で、 \fBpathconf\fP(3)  は \fBPATH_MAX\fP に制限がないことを示す \-1 を返すかもしれないからである。
+\fIresolved_path\ ==\ NULL\fP の機能を使うと、この設計上の問題を回避することができる。 この機能は POSIX.1\-2001
+では標準化されていないが、 POSIX.1\-2008 では標準化されている。
 .LP
-libc4 ¤È libc5 ¤Î¼ÂÁõ¤Ï¥Ð¥Ã¥Õ¥¡¡¦¥ª¡¼¥Ð¡¼¥Õ¥í¡¼¤Î²ÄǽÀ­¤ò»ý¤Ã¤Æ¤¤¤ë
-(libc-5.4.13 ¤Ç½¤Àµ¤µ¤ì¤¿¤¬)¡£¤·¤¿¤¬¤Ã¤Æ¡¢
-.BR mount (8)
-¤Î¤è¤¦¤Ê set-user-ID ¤µ¤ì¤ë¥×¥í¥°¥é¥à¤Ç¤Ï¡¢
-¤³¤Î´Ø¿ôÁêÅö¤Î´Ø¿ô¤ò¼«Á°¤Ç»ý¤ÄɬÍפ¬¤¢¤ë¡£
-.SH ´ØÏ¢¹àÌÜ
-.BR readlink (2),
-.BR canonicalize_file_name (3),
-.BR getcwd (3),
-.BR pathconf (3),
-.BR sysconf (3)
+libc4 と libc5 の実装はバッファ・オーバーフローの可能性を持っていた (libc\-5.4.13 で修正されたが)。したがって、
+\fBmount\fP(8)  のような set\-user\-ID されるプログラムでは、この関数相当の関数を自前で持つ必要があった。
+.SH 関連項目
+\fBreadlink\fP(2), \fBcanonicalize_file_name\fP(3), \fBgetcwd\fP(3), \fBpathconf\fP(3),
+\fBsysconf\fP(3)
+.SH この文書について
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.54 の一部
+である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man\-pages/ に書かれている。