projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / IO::File.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "IO::File 3"
132.TH IO::File 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133.SH "NAME"
134IO::File \- supply object methods for filehandles
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use IO::File;
139.Ve
140.PP
141.Vb 5
142\& $fh = new IO::File;
143\& if ($fh->open("< file")) {
144\& print <$fh>;
145\& $fh->close;
146\& }
147.Ve
148.PP
149.Vb 5
150\& $fh = new IO::File "> file";
151\& if (defined $fh) {
152\& print $fh "bar\en";
153\& $fh->close;
154\& }
155.Ve
156.PP
157.Vb 5
158\& $fh = new IO::File "file", "r";
159\& if (defined $fh) {
160\& print <$fh>;
161\& undef $fh; # automatically closes the file
162\& }
163.Ve
164.PP
165.Vb 3
166\& $fh = new IO::File "file", O_WRONLY|O_APPEND;
167\& if (defined $fh) {
168\& print $fh "corge\en";
169.Ve
170.PP
171.Vb 2
172\& $pos = $fh->getpos;
173\& $fh->setpos($pos);
174.Ve
175.PP
176.Vb 2
177\& undef $fh; # automatically closes the file
178\& }
179.Ve
180.PP
181.Vb 1
182\& autoflush STDOUT 1;
183.Ve
184.SH "DESCRIPTION"
185.IX Header "DESCRIPTION"
186\&\f(CW\*(C`IO::File\*(C'\fR inherits from \f(CW\*(C`IO::Handle\*(C'\fR and \f(CW\*(C`IO::Seekable\*(C'\fR. It extends
187these classes with methods that are specific to file handles.
188.SH "CONSTRUCTOR"
189.IX Header "CONSTRUCTOR"
190.IP "new ( \s-1FILENAME\s0 [,MODE [,PERMS]] )" 4
191.IX Item "new ( FILENAME [,MODE [,PERMS]] )"
192Creates an \f(CW\*(C`IO::File\*(C'\fR. If it receives any parameters, they are passed to
193the method \f(CW\*(C`open\*(C'\fR; if the open fails, the object is destroyed. Otherwise,
194it is returned to the caller.
195.IP "new_tmpfile" 4
196.IX Item "new_tmpfile"
197Creates an \f(CW\*(C`IO::File\*(C'\fR opened for read/write on a newly created temporary
198file. On systems where this is possible, the temporary file is anonymous
199(i.e. it is unlinked after creation, but held open). If the temporary
200file cannot be created or opened, the \f(CW\*(C`IO::File\*(C'\fR object is destroyed.
201Otherwise, it is returned to the caller.
202.SH "METHODS"
203.IX Header "METHODS"
204.IP "open( \s-1FILENAME\s0 [,MODE [,PERMS]] )" 4
205.IX Item "open( FILENAME [,MODE [,PERMS]] )"
206\&\f(CW\*(C`open\*(C'\fR accepts one, two or three parameters. With one parameter,
207it is just a front end for the built-in \f(CW\*(C`open\*(C'\fR function. With two or three
208parameters, the first parameter is a filename that may include
209whitespace or other special characters, and the second parameter is
210the open mode, optionally followed by a file permission value.
211.Sp
212If \f(CW\*(C`IO::File::open\*(C'\fR receives a Perl mode string (">\*(L", \*(R"+<\*(L", etc.)
213or an \s-1ANSI\s0 C \fIfopen()\fR mode string (\*(R"w\*(L", \*(R"r+", etc.), it uses the basic
214Perl \f(CW\*(C`open\*(C'\fR operator (but protects any special characters).
215.Sp
216If \f(CW\*(C`IO::File::open\*(C'\fR is given a numeric mode, it passes that mode
217and the optional permissions value to the Perl \f(CW\*(C`sysopen\*(C'\fR operator.
218The permissions default to 0666.
219.Sp
220For convenience, \f(CW\*(C`IO::File\*(C'\fR exports the O_XXX constants from the
221Fcntl module, if this module is available.
222.SH "SEE ALSO"
223.IX Header "SEE ALSO"
224perlfunc,
225\&\*(L"I/O Operators\*(R" in perlop,
226IO::Handle
227IO::Seekable
228.SH "HISTORY"
229.IX Header "HISTORY"
230Derived from FileHandle.pm by Graham Barr <\fIgbarr@pobox.com\fR>.
Full OpenSPARC design & verification tarball including full HDL.