.\"
.\" Extended attributes system calls manual pages
.\"
.\" Copyright (C) Andreas Gruenbacher, February 2001
.\" Copyright (C) Silicon Graphics Inc, September 2001
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.\" Japanese Version Copyright (c) 2003  Akihiro MOTOKI
.\"         all rights reserved.
.\" Translated Tue Jul  8 04:43:40 JST 2003
.\"         by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\"
.\"WORD:	extended attributes	拡張属性
.\"WORD:	namespace		名前空間
.\"
.TH SETXATTR 2 2001-12-31 "Linux" "Linux Programmer's Manual"
.SH 名前
setxattr, lsetxattr, fsetxattr \- 拡張属性の値を設定する
.SH 書式
.fam C
.nf
.B #include <sys/types.h>
.B #include <attr/xattr.h>
.sp
.BI "int setxattr(const char\ *" path ", const char\ *" name ,
.BI "              const void\ *" value ", size_t " size ", int " flags );
.BI "int lsetxattr(const char\ *" path ", const char\ *" name ,
.BI "              const void\ *" value ", size_t " size ", int " flags );
.BI "int fsetxattr(int " fd ", const char\ *" name ,
.BI "              const void\ *" value ", size_t " size ", int " flags );
.fi
.fam T
.SH 説明
拡張属性は、inode (ファイル、ディレクトリ、シンボリックリンク等) に
関連付けられた
.IR name :\c
.I value
の対である。
これらは、システム上のすべての inode に関連付けられた通常の属性
.RB ( stat (2)
が返すデータ) を拡張するものである。
拡張属性のコンセプトは
.BR attr (5)
に書かれている。
.PP
.BR setxattr ()
は、ファイルシステム内の指定された
.I path
に対応する、名前
.I name
の拡張属性の値
.I value
を設定する。
.I value
の
.I size
は必ず指定しなければならない。
.PP
.BR lsetxattr ()
は
.BR setxattr ()
と同じだが、シンボリックリンクの場合に、リンクが参照しているファイル
ではなく、リンクそのものの拡張属性を設定する点だけが異なる。
.PP
.BR fsetxattr ()
は
.BR setxattr ()
と同じだが、
.I path
の代わりに
.I fd
で参照されたオープン済みファイルの情報だけを設定する点が異なる
.RI ( filedes
は
.BR open (2)
によって返される)。
.PP
拡張属性の名前
は普通の NULL 終端された文字列である。
.I name
には、名前空間を表す接頭辞 (prefix) が含まれる。
個々の inode に対して、互いに独立な名前空間が複数あってもよい。
拡張属性の値
.I value
は、ある一定の長さの任意のテキスト・データまたは
バイナリ・データの集合である。
.PP
操作の意味を明確にするために
.I flags
引き数を使用することができる。
.B XATTR_CREATE
は属性の作成だけを行うことを指定する。
指定された名前の属性がすでに存在する場合は失敗する。
.B XATTR_REPLACE
は属性の置換だけを行うことを指定する。
指定された名前の属性がまだ存在しない場合は失敗する。
デフォルトでは (フラグを指定しない場合)、拡張属性は必要な場合は作成され、
属性がすでに存在する場合は属性値の置換を行う。
.SH 返り値
成功した場合、 0 が返される。
失敗した場合、 \-1 が返され、
.I errno
に適切な値がセットされる。
.PP
.B XATTR_CREATE
が指定され、かつ属性がすでに存在する場合、
.I errno
に
.B EEXIST
がセットされる。
.B XATTR_REPLACE
が指定され、属性がまだ存在しない場合、
.I errno
に
.B ENOATTR
がセットされる。
.PP
拡張属性を記憶するのに十分なスペースが残っていない場合、
.I errno
に
.B ENOSPC
または
.B EDQUOT
(quota による制限が原因の場合) がセットされる。
.PP
拡張属性がそのファイルシステムでサポートされていない場合、
もしくは無効になっている場合、
.I errno
に
.B ENOTSUP
がセットされる。
.PP
.BR stat (2)
システムコールの説明に書かれているエラーは
これらのシステムコールにも適用される。
.SH バージョン
これらのシステムコールはカーネル 2.4 以降の Linux で利用できる。
glibc でのサポートはバージョン 2.3 以降で行われている。
.SH 準拠
これらのシステムコールは Linux 独自である。
.\" .SH 著者
.\" Andreas Gruenbacher,
.\" .RI < a.gruenbacher@computer.org >
.\" と SGI XFS 開発チーム,
.\" .RI < linux-xfs@oss.sgi.com >。
.\" バグレポートやコメントは上記のアドレスまで送って下さい。
.SH 関連項目
.BR getfattr (1),
.BR setfattr (1),
.BR getxattr (2),
.BR listxattr (2),
.BR open (2),
.BR removexattr (2),
.BR stat (2),
.BR attr (5),
.BR symlink (7)