.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Statvfs 3pm"
.TH Statvfs 3pm "2018-11-01" "perl v5.28.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Filesys::Statvfs \- Perl extension for statvfs() and fstatvfs()
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Filesys::Statvfs;
\&
\&        my($bsize, $frsize, $blocks, $bfree, $bavail,
\&        $files, $ffree, $favail, $flag, $namemax) = statvfs("/tmp");
\&
\&        #### Pass an open filehandle. Verify that fileno() returns a defined
\&        #### value. If you pass undef to fstatvfs you will get unexpected results
\&        my $fd = fileno(FILE_HANDLE);
\&        if(defined($fd)) {
\&                ($bsize, $frsize, $blocks, $bfree, $bavail,
\&                $files, $ffree, $favail, $flag, $namemax) = fstatvfs($fd);
\&        }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Interface for \fBstatvfs()\fR and \fBfstatvfs()\fR
.PP
Unless you need access to the bsize, flag, and namemax values,
you should probably look at using Filesys::DfPortable or
Filesys::Df instead. They will generally provide you with more
functionality and portability.
.PP
The module should work with all flavors of Unix that implement the
\&\f(CW\*(C`statvfs()\*(C'\fR and \f(CW\*(C`fstatvfs()\*(C'\fR calls. This would include Linux, *BSD,
HP-UX, \s-1AIX,\s0 Solaris, Mac \s-1OS X,\s0 Irix, Cygwin, etc ...
.PP
The \f(CW\*(C`statvfs()\*(C'\fR and \f(CW\*(C`fstatvfs()\*(C'\fR functions will return a list of
values, or will return \f(CW\*(C`undef\*(C'\fR and set \f(CW$!\fR if there was an error.
.PP
The values returned are described in the statvfs/fstatvfs header or
the \f(CW\*(C`statvfs()/fstatvfs()\*(C'\fR man page.
.PP
The module assumes that if you have \f(CW\*(C`statvfs()\*(C'\fR, \f(CW\*(C`fstatvfs()\*(C'\fR will
also be available.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ian Guthrie
IGuthrie@aol.com
.PP
Copyright (c) 2006 Ian Guthrie. All rights reserved.
               This program is free software; you can redistribute it and/or
               modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBstatvfs\fR\|(2), \fBfstatvfs\fR\|(2), Filesys::DfPortable, Filesys::Df