MODULES

    News::yEnc          - yEnc decoder
    News::yEnc::Decoder - decodes yEncoded files
    News::yEnc::RC      - yEnc file-part database
    News::yEnc::Entry   - an entry in a News::yEnc::RC database


>From the News::yEnc POD

    =head1 NAME

    News::yEnc - yEnc decoder

    =head1 SYNOPSIS

      use News::yEnc;
      
      $yEnc = new News::yEnc RC  => $rcFile,
                             out => $outDir, 
                             tmp => $tmpDir;
      
      $ok = $yEnc->decode(\*FILE);
      $ok = $yEnc->decode($file);
      
      $rc = $yEnc->RC;
      
      undef $yEnc;   # saves the News::yEnc::RC database to disk


    =head1 ABSTRACT

    yEnc decoder, with database of file parts


    =head1 DESCRIPTION

    C<News::yEnc> decodes yEncoded files and writes them to disk. File
    parts are saved to I<$tmpDir>; when all parts of a file have been
    received, the completed file is moved to I<$outDir>.

    C<News::yEnc> maintains a database of partially received files, called
    the RC database. The RC database is loaded from disk when a
    C<News::yEnc> object is created, and saved to disk when the object is
    C<DESTROY>'d.



Complete PODs

    http://world.std.com/~swmcd/News/yEnc.html
    http://world.std.com/~swmcd/News/yEnc/Decoder.html
    http://world.std.com/~swmcd/News/yEnc/RC.html
    http://world.std.com/~swmcd/News/yEnc/Entry.html


- SWM

Reply via email to