summaryrefslogtreecommitdiffstats
path: root/perl/perl-Filesys-Df/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/perl-Filesys-Df/README')
-rw-r--r--perl/perl-Filesys-Df/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/perl/perl-Filesys-Df/README b/perl/perl-Filesys-Df/README
new file mode 100644
index 0000000000..2d5b677dbc
--- /dev/null
+++ b/perl/perl-Filesys-Df/README
@@ -0,0 +1,11 @@
+Filesys::DF module provides a way to obtain filesystem disk space information.
+
+df() requires a argument that represents the filesystem you want to
+query. The argument can be either a scalar directory/file name or a
+open filehandle. There is also an optional block size argument so you
+can tailor the size of the values returned. The default block size is
+1024. This will cause the function to return the values in 1k blocks.
+If you want bytes, set the block size to 1.
+
+df() returns a reference to a hash. The keys available in the hash are as follows:
+{blocks} {bfree} {bavail} {used} {per}. \ No newline at end of file