diff --git a/src/modules/files/doc/filesystem_stat b/src/modules/files/doc/filesystem_stat new file mode 100644 index 0000000000000000000000000000000000000000..731e70cfdddc86bb08645c5d3f79750cf3770bb8 --- /dev/null +++ b/src/modules/files/doc/filesystem_stat @@ -0,0 +1,41 @@ +NAME + filesystem_stat - stat a filesystem + +SYNTAX + mapping(string:atring|int) filesystem_stat(string file); + +DESCRIPTION + filesystem_stat returns a mapping describing some properties + about the filesystem. + Currently nine fields of the mapping are defined: + + ([ + "blocksize":int, /* filesystem block size */ + "blocks":int, /* total # of blocks on file system + * in units of blocksize */ + "bfree":int, /* total # of free blocks */ + "bavail":int, /* total # of free blocks + * available to non-super-user */ + "files":int, /* total # of files */ + "ffree":int, /* total # of free files */ + "favail":int, /* total # of free files + * available to non-super-user */ + "fstype":string /* target fs type name */ + "fsname":string /* target fs name */ + }) + + If there is no such file or directory, zero is returned. + +NOTA BENE + This function does not exist on all Operating Systems. + + Depending on Operating System some of the above values may not + be returned. + +KEYWORDS + file + +SEE ALSO + files/file_stat + +