File: //usr/local/ssl/local/share/man/man3/AnyData::Storage::File.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AnyData::Storage::File 3"
.TH AnyData::Storage::File 3 "2001-07-17" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
.Vb 1
\& AnyData::Storage::File -- manipulate files with rich warnings
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 2
\& Opens, reads from, writes to, creates and destroys files with numerous
\& options for error handling, flocking, binmode, etc.
.Ve
.PP
.Vb 1
\& The simplest form is the equivalent of
.Ve
.PP
.Vb 2
\& my $f = AnyData::Storage::File->new(dirs=>\e@dirs,flock=>1);
\& my $str1 = $f->adSlurp($file);
.Ve
.PP
.Vb 7
\& for( @dirs ) {
\& open(IN,$file) or die $!;
\& }
\& sub slurp {
\& local *IN;
\& local $/ = undef;
\& }
.Ve
.PP
.Vb 1
\& But, depending on how you set the default behaviour
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\& use AnyData;
\& my $f = AnyData::Storage::File->new;
\& $f->set('binmode',1|0);
\& $f->set('PrintError',1|0);
\& $f->set('RaiseError',1|0);
\& $f->set('Trace',1|0);
\& $f->set('f_dir',$dir|$dir_array)
.Ve
.PP
< input, fail if doesn't exist
> output, truncate if exists, create if doesn't
>> append, create if doesn't exist
+< read/write, fail if doesn't exist
.PP
r = <
r+ =
.SH "\fInew()\fP"
.IX Header "new()"
.Vb 1
\& my $f = AnyData::Storage::File->new;
.Ve
.PP
.Vb 1
\& or
.Ve
.PP
.Vb 1
\& my $f = AnyData::Storage::File->new( %flags );
.Ve
.PP
.Vb 1
\& %flags is a hash which can contain any or all of:
.Ve
.PP
.Vb 3
\& f_dir => $directory, # defaults to './' (
\& binmode => $binmode, # defaults to 0 (doesn't binmode files)
\& printError => $warnings, # defaults to 1 (print warning on errors)
.Ve
.ie n .SH "open_local_file( $fname\fP, \f(CW$mode );"
.el .SH "open_local_file( \f(CW$fname\fP, \f(CW$mode\fP );"
.IX Header "open_local_file( $fname, $mode );"
.Vb 1
\& Mode is one of
.Ve
.PP
.Vb 5
\& a = append open for reading & writing, create if doesn't exist
\& r = read open for reading, fail if doesn't exist
\& u = open open for reading & writing, fail if doesn't exist
\& c = create open for reading & writing, fail if it already exists
\& o = overwrite open for reading & writing, overwrite if it already exists
.Ve
.PP
.Vb 3
\& Additionally, all modes fail if the file can't be opened. On systems
\& that support flock, 'r' fails if a shared lock can not be obtained; the
\& other modes fail if an exclusive lock can't be obtained.
.Ve