diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:28:22 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:28:22 (GMT) |
commit | 116aa62bf54a39697e25f21d6cf6799f7faa1349 (patch) | |
tree | 8db5729518ed4ca88e26f1e26cc8695151ca3eb3 /Doc/library/statvfs.rst | |
parent | 739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (diff) | |
download | cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.zip cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.gz cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.bz2 |
Move the 3k reST doc tree in place.
Diffstat (limited to 'Doc/library/statvfs.rst')
-rw-r--r-- | Doc/library/statvfs.rst | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/Doc/library/statvfs.rst b/Doc/library/statvfs.rst new file mode 100644 index 0000000..6ec7c38 --- /dev/null +++ b/Doc/library/statvfs.rst @@ -0,0 +1,67 @@ + +:mod:`statvfs` --- Constants used with :func:`os.statvfs` +========================================================= + +.. module:: statvfs + :synopsis: Constants for interpreting the result of os.statvfs(). +.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> + + +.. % LaTeX'ed from comments in module + +The :mod:`statvfs` module defines constants so interpreting the result if +:func:`os.statvfs`, which returns a tuple, can be made without remembering +"magic numbers." Each of the constants defined in this module is the *index* of +the entry in the tuple returned by :func:`os.statvfs` that contains the +specified information. + + +.. data:: F_BSIZE + + Preferred file system block size. + + +.. data:: F_FRSIZE + + Fundamental file system block size. + + +.. data:: F_BLOCKS + + Total number of blocks in the filesystem. + + +.. data:: F_BFREE + + Total number of free blocks. + + +.. data:: F_BAVAIL + + Free blocks available to non-super user. + + +.. data:: F_FILES + + Total number of file nodes. + + +.. data:: F_FFREE + + Total number of free file nodes. + + +.. data:: F_FAVAIL + + Free nodes available to non-super user. + + +.. data:: F_FLAG + + Flags. System dependent: see :cfunc:`statvfs` man page. + + +.. data:: F_NAMEMAX + + Maximum file name length. + |