POD documentation for hpl2txt.pl
Outline
- Name
- Synopsis
- Description
- Options
- Arguments
- Script Layout
- See Also
- Known Bugs
- Author
- Copyright and License
- Source Code
Name
hpl2txt.pl - Makes tab-delimited text-file (.txt) from stage analysis location file (.hpl).
Synopsis
hpl2txt.pl [-
vb|--
verbose -B[txt] filename -
i|-
inter|--
interactive] [
hplfilename]
hpl2txt.pl
hpl2txt.pl hplfilename
hpl2txt.pl --help
produces this message
hpl2txt.pl --help -v
produces a longer help message
hpl2txt.pl -txt filename
places the .txt file in the user-specified location
hpl2txt.pl -i
uses the most recent .hpl file, and puts a .txt file in the same directory as it
Description
This makes a tab-delimited text-file (.txt) from an IMS-1270 stage
analysis file (.hpl). It sorts analysis by the order they are in the
.hpl file and outputs comment, x-coordinate, and y-coordinate.
Options
- -v|vb|verbose
Runs in verbose mode (this provides some useful debugging info).
- -help
Shows execution options.
- -txt filename
This sets the text-filename with (.txt) filename. If this is not
set, by default the filename is the same except .hpl is replaced by .txt .
- -i|inter|interactive
This sets the output filename without consulting the user. If this is
not set, the user is asked to decide before proceeding.
- Defaults:
Not verbose.
Arguments
This program currently expects either one argument (a stage analysis
file .hpl) or no arguments. If given no arguments it will find the
most recent .hpl file and run on that file.
Script Layout
This program currently has several parts:
- Find Most Recent .hpl File
If there is not a filename given for an existing file with non-zero
size, then this code looks through the program's current directory
(and any sub-directories) for .hpl files. It then looks at their
modification times, and selects the most recent file (which is
probably the one that you just saved).
- Read .hpl File
This reads and parses the existing IMS-1270 stage analysis file
(.hpl).
- Prompt User for .txt filename
This part of the code checks to make certain that there is a .txt
filename and that it can be written to, and prompts the user to enter
in a filename that will do that. The program will not progress until
those two things have occurred.
- Save New .txt File
This prints out the new .txt file with everything in the correct order.
See Also
perlpod,
http://www.perl.org,
http://www.gnu.org,
svg2hpl.pl,
txt2hpl.pl
Known Bugs
No known bugs.
Author
Miles McCammon, <
miles86@ucla.edu>
Copyright and License
hpl2txt.pl - Makes tab-delimited text-file (.txt) from stage analysis location file (.hpl).
Copyright © 2008 SIMS Lab, University of California Los Angeles; University of California Regents
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation version 2.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
To receive a copy of the GNU General Public License, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
Source Code
Source code for this version (11/6/08, 20:43) can be downloaded
here.