(split) LDP v3.30, v3.31 の定型的な変更内容を反映。

[linuxjm/LDP_man-pages.git] / draft / man2 / setxattr.2

.\"
.\" 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"
.\"O .SH NAME
.\"O setxattr, lsetxattr, fsetxattr \- set an extended attribute value
.SH ̾Á°
setxattr, lsetxattr, fsetxattr \- ³Èĥ°À­¤ÎÃͤòÀßÄꤹ¤ë
.\"O .SH SYNOPSIS
.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
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O Extended attributes are
.\"O .IR name :\c
.\"O .I value
.\"O pairs associated with inodes (files, directories, symbolic links, etc.).
.\"O They are extensions to the normal attributes which are associated
.\"O with all inodes in the system (i.e., the
.\"O .BR stat (2)
.\"O data).
.\"O A complete overview of extended attributes concepts can be found in
.\"O .BR attr (5).
³Èĥ°À­¤Ï¡¢inode (¥Õ¥¡¥¤¥ë¡¢¥Ç¥£¥ì¥¯¥È¥ê¡¢¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯Åù) ¤Ë
´ØÏ¢ÉÕ¤±¤é¤ì¤¿
.IR name :\c
.I value
¤ÎÂФǤ¢¤ë¡£
¤³¤ì¤é¤Ï¡¢¥·¥¹¥Æ¥à¾å¤Î¤¹¤Ù¤Æ¤Î inode ¤Ë´ØÏ¢ÉÕ¤±¤é¤ì¤¿Ä̾ï¤Î°À­
.RB ( stat (2)
¤¬ÊÖ¤¹¥Ç¡¼¥¿) ¤ò³ÈÄ¥¤¹¤ë¤â¤Î¤Ç¤¢¤ë¡£
³Èĥ°À­¤Î¥³¥ó¥»¥×¥È¤Ï
.BR attr (5)
¤Ë½ñ¤«¤ì¤Æ¤¤¤ë¡£
.PP
.\"O .BR setxattr ()
.\"O sets the
.\"O .I value
.\"O of the extended attribute identified by
.\"O .I name
.\"O and associated with the given
.\"O .I path
.\"O in the file system.
.\"O The
.\"O .I size
.\"O of the
.\"O .I value
.\"O must be specified.
.BR setxattr ()
¤Ï¡¢¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥àÆâ¤Î»ØÄꤵ¤ì¤¿
.I path
¤ËÂбþ¤¹¤ë¡¢Ì¾Á°
.I name
¤Î³Èĥ°À­¤ÎÃÍ
.I value
¤òÀßÄꤹ¤ë¡£
.I value
¤Î
.I size
¤Ïɬ¤º»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.PP
.\"O .BR lsetxattr ()
.\"O is identical to
.\"O .BR setxattr (),
.\"O except in the case of a symbolic link, where the extended attribute is
.\"O set on the link itself, not the file that it refers to.
.BR lsetxattr ()
¤Ï
.BR setxattr ()
¤ÈƱ¤¸¤À¤¬¡¢¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤Î¾ì¹ç¤Ë¡¢¥ê¥ó¥¯¤¬»²¾È¤·¤Æ¤¤¤ë¥Õ¥¡¥¤¥ë
¤Ç¤Ï¤Ê¤¯¡¢¥ê¥ó¥¯¤½¤Î¤â¤Î¤Î³Èĥ°À­¤òÀßÄꤹ¤ëÅÀ¤À¤±¤¬°Û¤Ê¤ë¡£
.PP
.\"O .BR fsetxattr ()
.\"O is identical to
.\"O .BR setxattr (),
.\"O only the extended attribute is set on the open file referred to by
.\"O .I fd
.\"O (as returned by
.\"O .BR open (2))
.\"O in place of
.\"O .IR path .
.BR fsetxattr ()
¤Ï
.BR setxattr ()
¤ÈƱ¤¸¤À¤¬¡¢
.I path
¤ÎÂå¤ï¤ê¤Ë
.I fd
¤Ç»²¾È¤µ¤ì¤¿¥ª¡¼¥×¥óºÑ¤ß¥Õ¥¡¥¤¥ë¤Î¾ðÊó¤À¤±¤òÀßÄꤹ¤ëÅÀ¤¬°Û¤Ê¤ë
.RI ( filedes
¤Ï
.BR open (2)
¤Ë¤è¤Ã¤ÆÊÖ¤µ¤ì¤ë)¡£
.PP
.\"O An extended attribute name is a simple null-terminated string.
.\"O The
.\"O .I name
.\"O includes a namespace prefix; there may be several, disjoint
.\"O namespaces associated with an individual inode.
.\"O The
.\"O .I value
.\"O of an extended attribute is a chunk of arbitrary textual or
.\"O binary data of specified length.
³Èĥ°À­¤Î̾Á°
¤ÏÉáÄ̤ΠNULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎó¤Ç¤¢¤ë¡£
.I name
¤Ë¤Ï¡¢Ì¾Á°¶õ´Ö¤òɽ¤¹ÀÜƬ¼­ (prefix) ¤¬´Þ¤Þ¤ì¤ë¡£
¸Ä¡¹¤Î inode ¤ËÂФ·¤Æ¡¢¸ß¤¤¤ËÆÈΩ¤Ê̾Á°¶õ´Ö¤¬Ê£¿ô¤¢¤Ã¤Æ¤â¤è¤¤¡£
³Èĥ°À­¤ÎÃÍ
.I value
¤Ï¡¢¤¢¤ë°ìÄê¤ÎŤµ¤ÎǤ°Õ¤Î¥Æ¥­¥¹¥È¡¦¥Ç¡¼¥¿¤Þ¤¿¤Ï
¥Ð¥¤¥Ê¥ê¡¦¥Ç¡¼¥¿¤Î½¸¹ç¤Ç¤¢¤ë¡£
.PP
.\"O The
.\"O .I flags
.\"O argument can be used to refine the semantics of the operation.
Áàºî¤Î°ÕÌ£¤òÌÀ³Î¤Ë¤¹¤ë¤¿¤á¤Ë
.I flags
°ú¤­¿ô¤ò»ÈÍѤ¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.\"O .B XATTR_CREATE
.\"O specifies a pure create, which fails if the named
.\"O attribute exists already.
.B XATTR_CREATE
¤Ï°À­¤ÎºîÀ®¤À¤±¤ò¹Ô¤¦¤³¤È¤ò»ØÄꤹ¤ë¡£
»ØÄꤵ¤ì¤¿Ì¾Á°¤Î°À­¤¬¤¹¤Ç¤Ë¸ºß¤¹¤ë¾ì¹ç¤Ï¼ºÇÔ¤¹¤ë¡£
.\"O .B XATTR_REPLACE
.\"O specifies a pure replace operation, which fails if the
.\"O named attribute does not already exist.
.B XATTR_REPLACE
¤Ï°À­¤ÎÃÖ´¹¤À¤±¤ò¹Ô¤¦¤³¤È¤ò»ØÄꤹ¤ë¡£
»ØÄꤵ¤ì¤¿Ì¾Á°¤Î°À­¤¬¤Þ¤À¸ºß¤·¤Ê¤¤¾ì¹ç¤Ï¼ºÇÔ¤¹¤ë¡£
.\"O By default (no flags), the extended attribute will be created if
.\"O need be, or will simply replace the value if the attribute exists.
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï (¥Õ¥é¥°¤ò»ØÄꤷ¤Ê¤¤¾ì¹ç)¡¢³Èĥ°À­¤ÏɬÍפʾì¹ç¤ÏºîÀ®¤µ¤ì¡¢
°À­¤¬¤¹¤Ç¤Ë¸ºß¤¹¤ë¾ì¹ç¤Ï°À­ÃͤÎÃÖ´¹¤ò¹Ô¤¦¡£
.\"O .SH RETURN VALUE
.SH ÊÖ¤êÃÍ
.\"O On success, zero is returned.
.\"O On failure, \-1 is returned and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¡¢ 0 ¤¬ÊÖ¤µ¤ì¤ë¡£
¼ºÇÔ¤·¤¿¾ì¹ç¡¢ \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤ËŬÀÚ¤ÊÃͤ¬¥»¥Ã¥È¤µ¤ì¤ë¡£
.PP
.\"O If
.\"O .B XATTR_CREATE
.\"O is specified, and the attribute exists already,
.\"O .I errno
.\"O is set to
.\"O .BR EEXIST .
.B XATTR_CREATE
¤¬»ØÄꤵ¤ì¡¢¤«¤Ä°À­¤¬¤¹¤Ç¤Ë¸ºß¤¹¤ë¾ì¹ç¡¢
.I errno
¤Ë
.B EEXIST
¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
.\"O If
.\"O .B XATTR_REPLACE
.\"O is specified, and the attribute does not exist,
.\"O .I errno
.\"O is set to
.\"O .BR ENOATTR .
.B XATTR_REPLACE
¤¬»ØÄꤵ¤ì¡¢Â°À­¤¬¤Þ¤À¸ºß¤·¤Ê¤¤¾ì¹ç¡¢
.I errno
¤Ë
.B ENOATTR
¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
.PP
.\"O If there is insufficient space remaining to store the extended attribute,
.\"O .I errno
.\"O is set to either
.\"O .BR ENOSPC ,
.\"O or
.\"O .B EDQUOT
.\"O if quota enforcement was the cause.
³Èĥ°À­¤òµ­²±¤¹¤ë¤Î¤Ë½½Ê¬¤Ê¥¹¥Ú¡¼¥¹¤¬»Ä¤Ã¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.I errno
¤Ë
.B ENOSPC
¤Þ¤¿¤Ï
.B EDQUOT
(quota ¤Ë¤è¤ëÀ©¸Â¤¬¸¶°ø¤Î¾ì¹ç) ¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
.PP
.\"O If extended attributes are not supported by the file system, or are disabled,
.\"O .I errno
.\"O is set to
.\"O .BR ENOTSUP .
³Èĥ°À­¤¬¤½¤Î¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ç¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
¤â¤·¤¯¤Ï̵¸ú¤Ë¤Ê¤Ã¤Æ¤¤¤ë¾ì¹ç¡¢
.I errno
¤Ë
.B ENOTSUP
¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
.PP
.\"O The errors documented for the
.\"O .BR stat (2)
.\"O system call are also applicable here.
.BR stat (2)
¥·¥¹¥Æ¥à¥³¡¼¥ë¤ÎÀâÌÀ¤Ë½ñ¤«¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ï
¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ë¤âŬÍѤµ¤ì¤ë¡£
.\"O .SH VERSIONS
.SH ¥Ð¡¼¥¸¥ç¥ó
.\"O These system calls have been available on Linux since kernel 2.4;
.\"O glibc support is provided since version 2.3.
¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï¥«¡¼¥Í¥ë 2.4 °Ê¹ß¤Î Linux ¤ÇÍøÍѤǤ­¤ë¡£
glibc ¤Ç¤Î¥µ¥Ý¡¼¥È¤Ï¥Ð¡¼¥¸¥ç¥ó 2.3 °Ê¹ß¤Ç¹Ô¤ï¤ì¤Æ¤¤¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.\"O These system calls are Linux-specific.
¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï Linux Æȼ«¤Ç¤¢¤ë¡£
.\"O .\" .SH AUTHORS
.\" .SH Ãø¼Ô
.\"O .\" Andreas Gruenbacher,
.\"O .\" .RI < a.gruenbacher@computer.org >
.\"O .\" and the SGI XFS development team,
.\"O .\" .RI < linux-xfs@oss.sgi.com >.
.\"O .\" Please send any bug reports or comments to these addresses.
.\" Andreas Gruenbacher,
.\" .RI < a.gruenbacher@computer.org >
.\" ¤È SGI XFS ³«È¯¥Á¡¼¥à,
.\" .RI < linux-xfs@oss.sgi.com >¡£
.\" ¥Ð¥°¥ì¥Ý¡¼¥È¤ä¥³¥á¥ó¥È¤Ï¾åµ­¤Î¥¢¥É¥ì¥¹¤Þ¤ÇÁ÷¤Ã¤Æ²¼¤µ¤¤¡£
.\"O .SH SEE ALSO
.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)