perl 5.000
[p5sagit/p5-mst-13.2.git] / pod / modpods / FileHandle.pod
1 =head1 NAME 
2
3 FileHandle - supply object methods for filehandles
4
5 cacheout - keep more files open than the system permits
6
7 =head1 SYNOPSIS
8
9     use FileHandle;
10     autoflush STDOUT 1;
11
12     cacheout($path);
13     print $path @data;
14
15 =head1 DESCRIPTION
16
17 See L<perlvar> for complete descriptions of each of the following supported C<FileHandle> 
18 methods:
19
20     print
21     autoflush
22     output_field_separator
23     output_record_separator
24     input_record_separator
25     input_line_number
26     format_page_number
27     format_lines_per_page
28     format_lines_left
29     format_name
30     format_top_name
31     format_line_break_characters
32     format_formfeed
33
34 The cacheout() function will make sure that there's a filehandle
35 open for writing available as the pathname you give it.  It automatically
36 closes and re-opens files if you exceed your system file descriptor maximum.
37
38 =head1 BUGS
39
40 F<sys/param.h> lies with its C<NOFILE> define on some systems,
41 so you may have to set $cacheout::maxopen yourself.
42
43 Due to backwards compatibility, all filehandles resemble objects
44 of class C<FileHandle>, or actually classes derived from that class.
45 They actually aren't.  Which means you can't derive your own 
46 class from C<FileHandle> and inherit those methods.