Doc/lib/libstatvfs.tex

   1 \section{\module{statvfs} ---
   2          Constants used with \function{os.statvfs()}}
   3
   4 \declaremodule{standard}{statvfs}
   5 % LaTeX'ed from comments in module
   6 \sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
   7 \modulesynopsis{Constants for interpreting the result of
   8                 \function{os.statvfs()}.}
   9
  10 The \module{statvfs} module defines constants so interpreting the result
  11 if \function{os.statvfs()}, which returns a tuple, can be made without
  12 remembering ``magic numbers.''  Each of the constants defined in this
  13 module is the \emph{index} of the entry in the tuple returned by
  14 \function{os.statvfs()} that contains the specified information.
  15
  16
  17 \begin{datadesc}{F_BSIZE}
  18 Preferred file system block size.
  19 \end{datadesc}
  20
  21 \begin{datadesc}{F_FRSIZE}
  22 Fundamental file system block size.
  23 \end{datadesc}
  24
  25 \begin{datadesc}{F_BLOCKS}
  26 Total number of blocks in the filesystem.
  27 \end{datadesc}
  28
  29 \begin{datadesc}{F_BFREE}
  30 Total number of free blocks.
  31 \end{datadesc}
  32
  33 \begin{datadesc}{F_BAVAIL}
  34 Free blocks available to non-super user.
  35 \end{datadesc}
  36
  37 \begin{datadesc}{F_FILES}
  38 Total number of file nodes.
  39 \end{datadesc}
  40
  41 \begin{datadesc}{F_FFREE}
  42 Total number of free file nodes.
  43 \end{datadesc}
  44
  45 \begin{datadesc}{F_FAVAIL}
  46 Free nodes available to non-super user.
  47 \end{datadesc}
  48
  49 \begin{datadesc}{F_FLAG}
  50 Flags. System dependent: see \cfunction{statvfs()} man page.
  51 \end{datadesc}
  52
  53 \begin{datadesc}{F_NAMEMAX}
  54 Maximum file name length.
  55 \end{datadesc}