=encoding euc-jp

=head1 名前

Filesys::DiskFree -- 移植可能な方法でUnixコマンド'df'をおこなう

=head1 概要

    use Filesys::DiskFree;

    $handle = new Filesys::DiskFree;
    $handle->df();
    print "The root device is ".$handle->device("/")."\n";
    print "It has ".$handle->avail("/")." bytes available\n";
    print "It has ".$handle->total("/")." bytes total\n";
    print "It has ".$handle->used("/")." bytes used\n";

=head1 説明

Filesys::DiskFreeは概ねunixコマンドdf(1)がおこなうことをします。
マウントされているディスクと使用された、そして使用可能な
空き領域の量を一覧にします。

=head2 関数

=over 4

=item Filesys::DiskFree->set('option' => 'value')

モジュールでのさまざまなオプションを設定します。

もっとも変更されるオプションはmodeです。これはblocksかinodesに
することができます。デフォルトではblocksが使われます。

load()関数を使って'外部の'OSからファイルｗ読み込むならば、formatが
使われるかもしれません。これは$^O変数に設定されているようなOSの名前を
取ります。

そのオプションの前の値を返します。

=item Filesys::DiskFree->df()

'df'コマンドを実行し、後で使うためにその値を保管します。

=item Filesys::DiskFree->command()

現在のフォーマットのための'df'コマンドを行うために適切なコマンドを
返します。リモート・システムでdfを呼び出したいときに使われます。
ローカルなdfのためにはdf()メソッドを利用してください。

適切なコマンドがなければundefを返します。

=item Filesys::DiskFree->load($line)

'df'の出力を読み込みます。$lineはスカラーあるいはファイル・ハンドルに
することができます。$lineがファイルハンドルであれば、そのファイルハンドルはEOFまで
読み込まれます。

失敗するとundefを返します。

=item Filesys::DiskFree->disks()

分かっている全てのディスクを返します。

=item Filesys::DiskFree->device($id)

$idのためのデバイスを返します。$idはディスクのデバイス名あるいは
ファイル名が入っているスカラーで、ディスクの場合にはそれに格納されている
ファイル名が使われます。ファイル名が'/'から始まらなければ、
"/"であるかのように扱われます。

=item Filesys::DiskFree->mount($id)

$idのためのマウント・ポイントを返します。$idはディスクのデバイス名か
ファイル名が入ったスカラーです。ディスクの場合には、それに格納されている
ファイル名が使われます。

=item Filesys::DiskFree->avail($id)

$idのために利用可能な領域のバイト数を返します。$idはディスクのデバイス名あるいは
ファイル名が入っているスカラーで、ディスクの場合にはそれに格納されている
ファイル名が使われます。

=item Filesys::DiskFree->total($id)

$idのために全体な領域のバイト数を返します。$idはディスクのデバイス名あるいは
ファイル名が入っているスカラーで、ディスクの場合にはそれに格納されている
ファイル名が使われます。

=item Filesys::DiskFree->used($id)

$idで使用済み領域のバイト数を返します。$idはディスクのデバイス名あるいは
ファイル名が入っているスカラーで、ディスクの場合にはそれに格納されている
ファイル名が使われます。

=back

=head1 バグ

より多くのフォーマットをサポートするべきです。現在はLinux、Irix、Solaris
そしてBSDがサポートされています。他のフォーマットは利用できるようになったら
追加されます。あなたOSの名前、バージョン、利用するのに'最もよい'dfオプション
そしてそれらのオプションでのdfの出力、そしてサポートされていないフォーマットに
アクセスしたら$^Oの内容をどうか送ってください。

=head1 作者(=AUTHOR)

Alan R. Barclay <gorilla@drink.com>

=head1 翻訳者

川合 孝典(GCD00051@nifty.ne.jp)