release/man2/renameat.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Japanese Version Copyright (c) 2006 Yuichi SATO
  26 .\"         all rights reserved.
  27 .\" Translated 2006-09-05 by Yuichi SATO <ysato444@yahoo.co.jp>, LDP v2.39
  28 .\"
  29 .TH RENAMEAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  30 .SH 名前
  31 renameat \- ディレクトリファイルディスクリプタから相対的な位置にあるファイルの名前を変更する
  32 .SH 書式
  33 .nf
  34 .B #include <fcntl.h>           /* AT_* 定数の定義 */
  35 .B #include <stdio.h>
  36 .sp
  37 .BI "int renameat(int " olddirfd ", const char *" oldpath ,
  38 .BI "             int " newdirfd ", const char *" newpath );
  39 .fi
  40 .sp
  41 .in -4n
  42 glibc 向けの機能検査マクロの要件
  43 .RB ( feature_test_macros (7)
  44 参照):
  45 .in
  46 .sp
  47 .BR renameat ():
  48 .PD 0
  49 .ad l
  50 .RS 4
  51 .TP 4
  52 glibc 2.10 以降:
  53 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  54 .TP
  55 glibc 2.10 より前:
  56 _ATFILE_SOURCE
  57 .RE
  58 .ad
  59 .PD
  60 .SH 説明
  61 .BR renameat ()
  62 システムコールは、この man ページで説明している違いがある以外は、
  63 .BR rename (2)
  64 と全く同じように動作する。
  65
  66 .I oldpath
  67 で指定されるパス名が相対パスである場合、
  68 ファイルディスクリプタ
  69 .I olddirfd
  70 で参照されるディレクトリからの相対パス名として解釈される
  71 .RB ( rename (2)
  72 では、相対パスは呼び出し元プロセスのカレントワーキングディレクトリからの
  73 相対パスとなる)。
  74
  75 .I oldpath
  76 が相対パスであり、かつ
  77 .I olddirfd
  78 が特別な値
  79 .B AT_FDCWD
  80 である場合、
  81 .I oldpath
  82 は
  83 .RB ( rename (2)
  84 と同じように) 呼び出し元プロセスの
  85 カレントワーキングディレクトリからの相対パス名として解釈される。
  86
  87 .I oldpath
  88 が絶対パスである場合、
  89 .I olddirfd
  90 は無視される。
  91
  92 .I newpath
  93 の解釈は
  94 .I oldpath
  95 と同様であるが、
  96 相対パス名はファイルディスクリプタ
  97 .I newdirfd
  98 で参照されるディレクトリからの相対パス名として解釈される。
  99 .SH 返り値
 100 成功した場合、
 101 .BR renameat ()
 102 は 0 を返す。
 103 エラーの場合、\-1 が返されて、
 104 .I errno
 105 にはエラーを示す値が設定される。
 106 .SH エラー
 107 .BR rename (2)
 108 と同じエラーが
 109 .BR renameat ()
 110 でも起こる。
 111 .BR renameat ()
 112 では、その他に以下のエラーが起こる:
 113 .TP
 114 .B EBADF
 115 .I olddirfd
 116 または
 117 .I newdirfd
 118 が有効なファイルディスクリプタでない。
 119 .TP
 120 .B ENOTDIR
 121 .I oldpath
 122 が相対パスで、かつ
 123 .I olddirfd
 124 がディレクトリ以外のファイルを参照するファイルディスクリプタである。
 125 または
 126 .I newpath
 127 と
 128 .I newdirfd
 129 について、同様のことが起きている。
 130 .SH バージョン
 131 .BR renameat ()
 132 は Linux カーネル 2.6.16 で追加された。
 133 .SH 準拠
 134 POSIX.1-2008.
 135 .SH 注意
 136 .BR renameat ()
 137 が必要な理由については、
 138 .BR openat (2)
 139 を参照すること。
 140 .SH 関連項目
 141 .BR openat (2),
 142 .BR rename (2),
 143 .BR path_resolution (7)