File: Statvfs.pm

package info (click to toggle)
libfilesys-statvfs-perl 0.82-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 76 kB
  • sloc: perl: 52; makefile: 2
file content (71 lines) | stat: -rw-r--r-- 1,913 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package Filesys::Statvfs;

use strict;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);

require Exporter;
require DynaLoader;

@ISA = qw(Exporter DynaLoader);
@EXPORT = qw(statvfs fstatvfs);
$VERSION = '0.82';
bootstrap Filesys::Statvfs $VERSION;

1;
__END__

=head1 NAME

Filesys::Statvfs - Perl extension for statvfs() and fstatvfs()

=head1 SYNOPSIS

  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);
	}

=head1 DESCRIPTION

Interface for statvfs() and fstatvfs()

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.

The module should work with all flavors of Unix that implement the
C<statvfs()> and C<fstatvfs()> calls. This would include Linux, *BSD,
HP-UX, AIX, Solaris, Mac OS X, Irix, Cygwin, etc ...

The C<statvfs()> and C<fstatvfs()> functions will return a list of
values, or will return C<undef> and set C<$!> if there was an error.

The values returned are described in the statvfs/fstatvfs header or
the C<statvfs()/fstatvfs()> man page.

The module assumes that if you have C<statvfs()>, C<fstatvfs()> will
also be available.

=head1 AUTHOR

Ian Guthrie
IGuthrie@aol.com

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.

=head1 SEE ALSO

statvfs(2), fstatvfs(2), Filesys::DfPortable, Filesys::Df

=cut