| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 1 | :mod:`statvfs` --- Constants used with :func:`os.statvfs` |
| 2 | ========================================================= |
| 3 | |
| 4 | .. module:: statvfs |
| 5 | :synopsis: Constants for interpreting the result of os.statvfs(). |
| 6 | .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> |
| 7 | |
| 8 | |
| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 9 | The :mod:`statvfs` module defines constants so interpreting the result if |
| 10 | :func:`os.statvfs`, which returns a tuple, can be made without remembering |
| 11 | "magic numbers." Each of the constants defined in this module is the *index* of |
| 12 | the entry in the tuple returned by :func:`os.statvfs` that contains the |
| 13 | specified information. |
| 14 | |
| 15 | |
| 16 | .. data:: F_BSIZE |
| 17 | |
| 18 | Preferred file system block size. |
| 19 | |
| 20 | |
| 21 | .. data:: F_FRSIZE |
| 22 | |
| 23 | Fundamental file system block size. |
| 24 | |
| 25 | |
| 26 | .. data:: F_BLOCKS |
| 27 | |
| 28 | Total number of blocks in the filesystem. |
| 29 | |
| 30 | |
| 31 | .. data:: F_BFREE |
| 32 | |
| 33 | Total number of free blocks. |
| 34 | |
| 35 | |
| 36 | .. data:: F_BAVAIL |
| 37 | |
| 38 | Free blocks available to non-super user. |
| 39 | |
| 40 | |
| 41 | .. data:: F_FILES |
| 42 | |
| 43 | Total number of file nodes. |
| 44 | |
| 45 | |
| 46 | .. data:: F_FFREE |
| 47 | |
| 48 | Total number of free file nodes. |
| 49 | |
| 50 | |
| 51 | .. data:: F_FAVAIL |
| 52 | |
| 53 | Free nodes available to non-super user. |
| 54 | |
| 55 | |
| 56 | .. data:: F_FLAG |
| 57 | |
| 58 | Flags. System dependent: see :cfunc:`statvfs` man page. |
| 59 | |
| 60 | |
| 61 | .. data:: F_NAMEMAX |
| 62 | |
| 63 | Maximum file name length. |
| 64 | |