README
1README for RTF::Writer
2 Time-stamp: "2001-04-26 17:12:12 MDT"
3
4[Excerpted from the POD...]
5
6
7NAME
8 RTF::Writer - for generating documents in Rich Text Format
9
10SYNOPSIS
11 use RTF::Writer;
12 my $rtf = RTF::Writer->new_to_file("greetings.rtf");
13 $rtf->prolog( 'title' => "Greetings, hyoomon" );
14 $rtf->number_pages;
15 $rtf->paragraph(
16 \'\fs40\b\i', # 20pt, bold, italic
17 "Hi there!"
18 );
19 $rtf->close;
20
21DESCRIPTION
22 This module is for generating documents in Rich Text Format.
23
24 This module is a class; an object belonging to this class
25 acts like an output filehandle, and calling methods on it
26 causes RTF text to be written.
27
28 Incidentally, this module also exports a few useful
29 functions, upon request.
30
31 The following documentation assumes some familiarity with
32 the RTF Specification. Users not already intimately
33 familiar with RTF should look at RTF::Cookbook.
34
35[... RTF::Cookbook is included in this dist ...]
36
37COPYRIGHT AND DISCLAIMER
38 Copyright 2001 Sean M. Burke.
39
40 This library is free software; you can redistribute it
41 and/or modify it under the same terms as Perl itself.
42
43 This program is distributed in the hope that it will be
44 useful, but without any warranty; without even the implied
45 warranty of merchantability or fitness for a particular
46 purpose.
47
48 The author of this document is not affiliated with the
49 Microsoft corporation.
50
51 Product and company names mentioned in this document may be
52 the trademarks or service marks of their respective owners.
53 Trademarks and service marks are not identified, although
54 this must not be construed as the author's expression of
55 validity or invalidity of each trademark or service mark.
56
57
58[...end pod excerpt]
59
60PREREQUISITES
61
62This suite requires perl 5.005 to run. If you really need to run it
63under perl 5.004, email me and I'll suggest how to get it to work.
64
65
66INSTALLATION
67
68You install RTF::Writer et al, as you would install any Perl module
69library, by running these commands:
70
71 perl Makefile.PL
72 make
73 make test
74 make install
75
76If you want to install a private copy of RTF::Writer in your home
77directory, then you should try to produce the initial Makefile with
78something like this command:
79
80 perl Makefile.PL PREFIX=~/perl
81
82See perldoc perlmodinstall for more information and advice.
83
84
85!!!!!!!!!!SPECIAL NOTE!!!!!!!!!!
86
87The distribution archive contains two files of some interest, in the
88examples/ directory. They do not get installed anywhere by the "make
89install" command, but you should look at them:
90 demo_writer.pl -- sample program using RTF::Writer to generate output.
91 la_dame.rtf -- the "sample complete RTF file" from RTF::Cookbook.
92
93
94DOCUMENTATION
95
96POD-format documentation is included in RTF/Writer.pod and
97RTF/Cookbook.pod. POD is readable with the 'perldoc' utility. See
98ChangeLog for recent changes.
99
100
101MACPERL INSTALLATION NOTES
102
103Don't bother with the makefiles. Just move the lib/RTF directory
104into your MacPerl site_lib or lib directory.
105
106
107SUPPORT
108
109Questions, bug reports, useful code bits, and suggestions for
110RTF::Writer should just be sent to me at sburke@cpan.org
111
112
113AVAILABILITY
114
115The latest version of this suite is available from the
116Comprehensive Perl Archive Network (CPAN). Visit
117<http://www.perl.com/CPAN/> to find a CPAN site near you.
118
119