[Bio] / FigKernelScripts / Packager.pl Repository:
ViewVC logotype

Diff of /FigKernelScripts/Packager.pl

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2, Wed Aug 17 02:37:07 2005 UTC revision 1.3, Mon Sep 12 00:25:22 2005 UTC
# Line 2  Line 2 
2    
3  =head1 Packager  =head1 Packager
4    
5    C<Packager> [I<options>] C<scan>|C<pack>|C<unpack> I<directoryRoot> I<packageFile>
6    
7  Package all the files in a directory tree for transport or recreate the directory  Package all the files in a directory tree for transport or recreate the directory
8  tree from the packaged files.  tree from the packaged files.
9    
10  This method takes as input three positional parameters: a command, the name of the  This method takes as input three positional parameters.
11  root for the directory tree and the name of the package files. If the command is  
12  C<pack>, the files are packaged into one or more text files. If the command is  =over 4
13  C<unpack>, the files are unpackaged from the text files. If the command is  
14  C<scan>, the files are examined to determine the file types.  =item command
15    
16    C<pack> to package the files into a single package file, <unpack> to restore
17    the files from the package file, or C<scan> to scan the files to determine
18    file types.
19    
20    =item directoryRoot
21    
22    Root directory of the directory tree. If scanning or packing, all files in this
23    tree will be packaged. If unpacking, the files are unpacked into this tree.
24    
25    =item packageFile
26    
27    Name of the package file. If packing, this is the output file. If unpacking,
28    this is the input file.
29    
30    =back
31    
32  File and directory names should be specified using Unix conventions, with a  File and directory names should be specified using Unix conventions, with a
33  forward slash (C</>) instead of a backslash (C<\>).  forward slash (C</>) instead of a backslash (C<\>).
34    
 File names ending in a tilde (C<~>) or C<.bak> will be ignored when scanning or  
 packaging. These files are presumed to be temporary backups.  
   
35  The process of packaging is straightforward. We write out the name of the input file,  The process of packaging is straightforward. We write out the name of the input file,
36  its type (text or binary), the file data itself, and an MD5 digest. Each file is  its type (text or binary), the file data itself, and an MD5 digest. Each file is
37  compressed using the PERL C<Compress::Zlib> libary.  compressed using the PERL C<Compress::Zlib> libary.

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3