.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Fmode 3pm"
.TH Fmode 3pm "2014-08-09" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
FileHandle::Fmode \- determine whether a filehandle is opened for reading, writing, or both.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& use FileHandle::Fmode qw(:all);
\& .
\& .
\& #$fh and FH are open filehandles
\& print is_R($fh), "\en";
\& print is_W(\e*FH), "\en";
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.Vb 5
\& $bool = is_FH($fh);
\& $bool = is_FH(\e*FH);
\&  This is just a (more intuitively named) alias for is_arg_ok().
\&  Returns 1 if its argument is an open filehandle.
\&  Returns 0 if its argument is something other than an open filehandle.
\&
\& $bool = is_arg_ok($fh);
\& $bool = is_arg_ok(\e*FH);
\&  Returns 1 if its argument is an open filehandle.
\&  Returns 0 if its argument is something other than an open filehandle.
\&
\& Arguments to the following functions  must be open filehandles. If
\& any of those functions receive an argument that is not an open
\& filehandle then the function dies with an appropriate error message.
\& To ensure that your script won\*(Aqt suffer such a death, you could first
\& check by passing the argument to is_FH(). Or you could wrap the
\& function call in an eval{} block.
\&
\& Note that it may be possible that a filehandle opened for writing may
\& become unwritable \- if (eg) the disk becomes full. I don\*(Aqt know how
\& the below functions would be affected by such an event. I suspect
\& that they would be unaware of the change ... but I haven\*(Aqt actually
\& checked.
\&
\& $bool = is_R($fh);
\& $bool = is_R(\e*FH);
\&  Returns true if the filehandle is readable.
\&  Else returns false.
\&
\& $bool = is_W($fh);
\& $bool = is_W(\e*FH);
\&  Returns true if the filehandle is writable.
\&  Else returns false
\&
\& $bool = is_RO($fh);
\& $bool = is_RO(\e*FH);
\&  Returns true if the filehandle is readable but not writable.
\&  Else returns false
\&
\& $bool = is_WO($fh);
\& $bool = is_WO(\e*FH);
\&  Returns true if the filehandle is writable but not readable.
\&  Else returns false
\&
\& $bool = is_RW($fh);
\& $bool = is_RW(\e*FH);
\&  Returns true if the filehandle is both readable and writable.
\&  Else returns false
\&
\& $bool = is_A($fh);
\& $bool = is_A(\e*FH);
\&
\&  Returns true if the filehandle was opened for appending.
\&  Else returns false.
\&  Not currently implemented on Win32 with pre\-5.6.1 versions of perl (and
\&  dies with appropriate error message if called on such a platform).
.Ve
.SH "CREDITS"
.IX Header "CREDITS"
.Vb 4
\& Inspired (hmmm ... is that the right word ?) by an idea from BrowserUK
\& posted on PerlMonks in response to a question from dragonchild. Win32
\& code (including XS code) provided by BrowserUK. Zaxo presented the idea
\& of using fcntl() in an earlier PerlMonks thread.
\&
\& Thanks to dragonchild and BrowserUK for steering this module in
\& the right direction.
\&
\& Thanks to attn.steven.kuo for directing me to the perliol routines
\& that enable us to query filehandles attached to memory objects.
\&
\& And thanks to Jost Krieger for helping to sort out the test failures that
\& were occurring on Solaris (and some other operating systems too).
.Ve
.SH "TODO"
.IX Header "TODO"
.Vb 3
\& I don\*(Aqt know that anyone still runs pre\-5.6.1 perl on Win32. However, if
\& someone likes to tell me how is_A() could be made to work on pre\-5.6.1
\& Win32 perl, I would be quite happy to implement it.
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
.Vb 3
\& This program is free software; you may redistribute it and/or
\& modify it under the same terms as Perl itself.
\& Copyright 2006\-2008, 2009, 2010, 2012 Sisyphus
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\& Sisyphus <sisyphus at cpan dot org>
.Ve