Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man2 / statvfs.2

.\" Copyright (C) 2003 Andries Brouwer (aeb@cwi.nl)
.\"
.\" 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.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" The pathconf note is from Walter Harms
.\" This is not a system call on Linux
.\"
.\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" Japanese Version Copyright (c) 2004-2005 Yuichi SATO
.\"         all rights reserved.
.\" Translated Tue Jun 29 23:36:41 JST 2004
.\"         by Yuichi SATO <ysato444@yahoo.co.jp>
.\" Updated & Modified Sun Jan  9 22:50:29 JST 2005 by Yuichi SATO
.\"
.TH STATVFS 2 2003-08-22 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O statvfs, fstatvfs \- get file system statistics
statvfs, fstatvfs \- ¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤ÎÅý·×¤ò¼èÆÀ¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #include <sys/statvfs.h>
.sp
.BI "int statvfs(const char *" path ", struct statvfs *" buf );
.br
.BI "int fstatvfs(int " fd ", struct statvfs *" buf );
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The function
.\"O .BR statvfs ()
.\"O returns information about a mounted file system.
´Ø¿ô
.BR statvfs ()
¤Ï¥Þ¥¦¥ó¥È¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ë¤Ä¤¤¤Æ¤Î¾ðÊó¤òÊÖ¤¹¡£
.\"O .I path
.\"O is the pathname of any file within the mounted file system.
.I path
¤Ï¥Þ¥¦¥ó¥È¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥àÃæ¤ÎǤ°Õ¤Î¥Õ¥¡¥¤¥ë¤Î¥Ñ¥¹Ì¾¤Ç¤¢¤ë¡£
.\"O .I buf
.\"O is a pointer to a
.\"O .I statvfs
.\"O structure defined approximately as follows:
.I buf
¤Ï¡¢¤À¤¤¤¿¤¤°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë
.I statvfs
¹½Â¤ÂΤؤΥݥ¤¥ó¥¿¤Ç¤¢¤ë:

.in +4n
.nf
struct statvfs {
.\"O     unsigned long  f_bsize;    /* file system block size */
.\"O     unsigned long  f_frsize;   /* fragment size */
.\"O     fsblkcnt_t     f_blocks;   /* size of fs in f_frsize units */
.\"O     fsblkcnt_t     f_bfree;    /* # free blocks */
.\"O     fsblkcnt_t     f_bavail;   /* # free blocks for unprivileged users */
.\"O     fsfilcnt_t     f_files;    /* # inodes */
.\"O     fsfilcnt_t     f_ffree;    /* # free inodes */
.\"O     fsfilcnt_t     f_favail;   /* # free inodes for unprivileged users */
.\"O     unsigned long  f_fsid;     /* file system ID */
.\"O     unsigned long  f_flag;     /* mount flags */
.\"O     unsigned long  f_namemax;  /* maximum filename length */
    unsigned long  f_bsize;    /* ¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Î¥Ö¥í¥Ã¥¯¥µ¥¤¥º */
    unsigned long  f_frsize;   /* ¥Õ¥é¥°¥á¥ó¥È¥µ¥¤¥º */
    fsblkcnt_t     f_blocks;   /* ¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Î¥µ¥¤¥º (f_frsize ñ°Ì) */
    fsblkcnt_t     f_bfree;    /* ²òÊü¤µ¤ì¤Æ¤¤¤ë¥Ö¥í¥Ã¥¯¿ô */
    fsblkcnt_t     f_bafvail;   /* ÈóÆø¢¥æ¡¼¥¶ÍѤ˲òÊü¤µ¤ì¤Æ¤¤¤ë¥Ö¥í¥Ã¥¯¿ô */
    fsfilcnt_t     f_files;    /* inode ¿ô */
    fsfilcnt_t     f_ffree;    /* ²òÊü¤µ¤ì¤Æ¤¤¤ë inode ¤Î¿ô */
    fsfilcnt_t     f_favail;   /* ÈóÆø¢¥æ¡¼¥¶ÍѤ˲òÊü¤µ¤ì¤Æ¤¤¤ë inode ¤Î¿ô */
    unsigned long  f_fsid;     /* ¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à ID */
    unsigned long  f_flag;     /* ¥Þ¥¦¥ó¥È¥Õ¥é¥° */
    unsigned long  f_namemax;  /* ¥Õ¥¡¥¤¥ë̾¤ÎŤµ¤ÎºÇÂçÃÍ */
};
.fi
.in

.\"O Here the types
.\"O .I fsblkcnt_t
.\"O and
.\"O .I fsfilcnt_t
.\"O are defined in
.\"O .IR <sys/types.h> .
¤³¤³¤Ç¡¢·¿
.I fsblkcnt_t
¤È
.I fsfilcnt_t
¤Ï
.I <sys/types.h>
¤ÇÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
.\"O Both used to be
.\"O .IR "unsigned long" .
¤«¤Ä¤Æ¡¢¤³¤ì¤é¤Ï¶¦¤Ë
.I "unsigned long"
¤Ç¤¢¤Ã¤¿¡£

.\"O The field
.\"O .I f_flag
.\"O is a bit mask (of mount flags, see
.\"O .BR mount (8)).
¥Õ¥£¡¼¥ë¥É
.I f_flag
¤Ï (¥Þ¥¦¥ó¥È¥Õ¥é¥°¤Î) ¥Ó¥Ã¥È¥Þ¥¹¥¯¤Ç¤¢¤ë
(¥Þ¥¦¥ó¥È¥Õ¥é¥°¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.BR mount (8)
¤ò»²¾È¤¹¤ë¤³¤È)¡£
.\"O Bits defined by POSIX are
POSIX ¤ÇÄêµÁ¤µ¤ì¤Æ¤¤¤ë¥Ó¥Ã¥È¤Ï°Ê²¼¤ÎÄ̤ê:
.TP
.B ST_RDONLY
.\"O Read-only file system.
Æɤ߹þ¤ßÀìÍѤΥե¡¥¤¥ë¥·¥¹¥Æ¥à¡£
.TP
.B ST_NOSUID
.\"O Set-user-id/set-group-ID bits are ignored by
.\"O .BR exec (3).
.BR exec (3)
¤Ë̵»ë¤µ¤ì¤ë set-user-id/set-group-ID ¥Ó¥Ã¥È¡£
.LP
.\"O It is unspecified whether all members of the returned struct
.\"O have meaningful values on all file systems.
ÊÖ¤µ¤ì¤¿¹½Â¤ÂΤÎÁ´¤Æ¤Î¥á¥ó¥Ð¤¬Á´¤Æ¤Î¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ç
°ÕÌ£¤Î¤¢¤ëÃͤǤ¢¤ë¤«Èݤ«¤Ï¡¢»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¡£

.\"O .BR fstatvfs ()
.\"O returns the same information about an open file referenced by descriptor
.\"O .IR fd .
.BR fstatvfs ()
¤Ï¡¢¥Ç¥£¥¹¥¯¥ê¥×¥¿
.I fd
¤Ç»²¾È¤µ¤ì¤ë¥ª¡¼¥×¥ó¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤Ë¤Ä¤¤¤Æ¡¢Æ±¤¸¾ðÊó¤òÊÖ¤¹¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, zero is returned.
.\"O On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¡¢0 ¤¬ÊÖ¤µ¤ì¤ë¡£
¥¨¥é¡¼¤Î¾ì¹ç¡¢\-1 ¤¬ÊÖ¤µ¤ì¤Æ¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EACCES
.\"O .RB ( statvfs ())
.\"O Search permission is denied for a component of the path prefix of
.\"O .IR path .
.\"O (See also
.\"O .BR path_resolution (7).)
.RB ( statvfs ()
¤Î¾ì¹ç)
.I path
¤Î¥Ç¥£¥ì¥¯¥È¥êÉôʬ¤Ë¸¡º÷µö²Ä¤¬Í¿¤¨¤é¤ì¤Æ¤¤¤Ê¤¤
.RB ( path_resolution (7)
¤â»²¾È¤¹¤ë¤³¤È)¡£
.TP
.B EBADF
.\"O .RB ( fstatvfs ())
.\"O .I fd
.\"O is not a valid open file descriptor.
.RB ( fstatvfs ()
¤Î¾ì¹ç)
.I fd
¤¬Í­¸ú¤Ê¥ª¡¼¥×¥ó¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ï¤Ê¤¤¡£
.TP
.B EFAULT
.\"O .I Buf
.\"O or
.\"O .I path
.\"O points to an invalid address.
.I buf
¤Þ¤¿¤Ï
.I path
¤¬Ìµ¸ú¤Ê¥¢¥É¥ì¥¹¤ò»Ø¤·¤Æ¤¤¤ë¡£
.TP
.B EINTR
.\"O This call was interrupted by a signal.
¤³¤Î¸Æ¤Ó½Ð¤·¤¬¥·¥°¥Ê¥ë¤Ë¤è¤Ã¤ÆÃæÃǤµ¤ì¤¿¡£
.TP
.B EIO
.\"O An I/O error occurred while reading from the file system.
¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤«¤éÆɤ߽Ф·¤Æ¤¤¤ë´Ö¤Ë I/O ¥¨¥é¡¼¤¬È¯À¸¤·¤¿¡£
.TP
.B ELOOP
.\"O .RB ( statvfs ())
.\"O Too many symbolic links were encountered in translating
.\"O .IR path .
.RB ( statvfs ()
¤Î¾ì¹ç)
.I path
¤Ë¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤¬Â¿¤¹¤®¤ë¡£
.TP
.B ENAMETOOLONG
.\"O .RB ( statvfs ())
.\"O .I path
.\"O is too long.
.RB ( statvfs ()
¤Î¾ì¹ç)
.I path
¤¬Ä¹¤¹¤®¤ë¡£
.TP
.B ENOENT
.\"O .RB ( statvfs ())
.\"O The file referred to by
.\"O .I path
.\"O does not exist.
.RB ( statvfs ()
¤Î¾ì¹ç)
.I path
¤Ç»²¾È¤µ¤ì¤ë¥Õ¥¡¥¤¥ë¤¬Â¸ºß¤·¤Ê¤¤¡£
.TP
.B ENOMEM
.\"O Insufficient kernel memory was available.
½½Ê¬¤Ê¥«¡¼¥Í¥ë¥á¥â¥ê¤¬»ÈÍѤǤ­¤Ê¤¤¡£
.TP
.B ENOSYS
.\"O The file system does not support this call.
¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤¬¤³¤Î¸Æ¤Ó½Ð¤·¤ò¥µ¥Ý¡¼¥È¤·¤Æ¤¤¤Ê¤¤¡£
.TP
.B ENOTDIR
.\"O .RB ( statvfs ())
.\"O A component of the path prefix of
.\"O .I path
.\"O is not a directory.
.RB ( statvfs ()
¤Î¾ì¹ç)
.I path
¤Î¥Ç¥£¥ì¥¯¥È¥êÉôʬ¤¬¥Ç¥£¥ì¥¯¥È¥ê¤Ç¤Ê¤¤¡£
.TP
.B EOVERFLOW
.\"O Some values were too large to be represented in the returned struct.
¤¤¤¯¤Ä¤«¤ÎÃͤϡ¢ÊÖ¤µ¤ì¤ë¹½Â¤ÂΤÇɽ¸½¤¹¤ë¤Ë¤ÏÂ礭¤¹¤®¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.
.\"O .SH NOTES
.SH Ãí°Õ
.\"O The Linux kernel has system calls
.\"O .BR statfs (2)
.\"O and
.\"O .BR fstatfs (2)
.\"O to support this library call.
Linux ¥«¡¼¥Í¥ë¤Ë¤Ï¡¢¤³¤Î¥é¥¤¥Ö¥é¥ê¥³¡¼¥ë¤ò¥µ¥Ý¡¼¥È¤¹¤ë¤¿¤á¤Ë¡¢
.BR statfs (2),
.BR fstatfs (2)
¥·¥¹¥Æ¥à¥³¡¼¥ë¤¬¤¢¤ë¡£

.\"O The current glibc implementations of
¸½ºß¤Î glibc ¤Î¼ÂÁõ¤Ë¤ª¤¤¤Æ¡¢
.sp
.nf
   pathconf(path, _PC_REC_XFER_ALIGN);
   pathconf(path, _PC_ALLOC_SIZE_MIN);
   pathconf(path, _PC_REC_MIN_XFER_SIZE);
.fi
.sp
.\"O respectively use the
.\"O .IR f_frsize ,
.\"O .IR f_frsize ,
.\"O and
.\"O .I f_bsize
.\"O fields of the return value of
.\"O .IR "statvfs(path,buf)" .
¤Ï¡¢¤½¤ì¤¾¤ì
.I "statvfs(path,buf)"
¤ÎÊÖ¤êÃͤÎ
.IR f_frsize ,
.IR f_frsize ,
.I f_bsize
¥Õ¥£¡¼¥ë¥É¤ò»È¤¦¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR statfs (2)