File: //usr/local/ssl/local/share/man/man3/Filesys::Statvfs.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Statvfs 3"
.TH Statvfs 3 "2006-06-24" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Filesys::Statvfs \- Perl extension for statvfs() and fstatvfs()
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Filesys::Statvfs;
.Ve
.PP
.Vb 2
\& my($bsize, $frsize, $blocks, $bfree, $bavail,
\& $files, $ffree, $favail, $flag, $namemax) = statvfs("/tmp");
.Ve
.PP
.Vb 7
\& #### 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 \fIstatvfs()\fR and \fIfstatvfs()\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,
\&\s-1HP\-UX\s0, \s-1AIX\s0, Solaris, Mac \s-1OS\s0 X, 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"
\&\fIstatvfs\fR\|(2), \fIfstatvfs\fR\|(2), Filesys::DfPortable, Filesys::Df