README
1Text::Flowed - text formatting routines for RFC2646 format=flowed
2
3This module provides functions that deals with formatting data with
4Content-Type 'text/plain; format=flowed' as described in RFC2646
5(http://www.rfc-editor.org/rfc/rfc2646.txt). In a nutshell,
6format=flowed text solves the problem in plain text files where it is
7not known which lines can be considered a logical paragraph, enabling
8lines to be automatically flowed (wrapped and/or joined) as appropriate
9when displaying.
10
11In format=flowed, a soft newline is expressed as " \n", while hard
12newlines are expressed as "\n". Soft newlines can be automatically
13deleted or inserted as appropriate when the text is reformatted.
14
15 use Text::Flowed qw(reformat quote quote_fixed);
16 print reformat($text, \%args); # Reformat some format=flowed text
17
18To install:
19
20perl Makefile.PL
21make
22make test
23make install
24
25Copyright 2002-2003, Philip Mak
26
27This library is free software; you can redistribute it and/or modify it
28under the same terms as Perl itself.
29
30---
31
32Revision History
33
342002-08-14: v0.14
35- $args->{fixed} logic was broken.
36- Removed $args->{break} option. It violates the RFC, and after fiddling
37 with it, I think such functionality should be implemented by the user
38 agent when displaying text to the user.
39
402002-08-13: v0.13
41- Increased version to 0.13 because CPAN's being stubborn.
42- $OPT_LENGTH was being used by mistake instead of $args->{opt_length}.
43- $args->{break} was breaking words longer than opt_length but shorter
44 than max_length.
45- $args->{fixed} == 2 makes all lines interpreted as format=fixed.
46- Off-by-one bug: Lines could be longer than opt_length/max_length by
47 one character.
48
492002-08-11: v0.02
50- reformat($text, {fixed => 1}) was incorrectly interpreting all lines
51 as fixed, rather than just unquoted lines as fixed.
52- reformat() was not unstuffing joined lines.
53- Lines were sometimes double-quoted due to _num_quotes() using $1 even
54 if it was undefined.
55- $args->{break} added to break excessively long words (in violation of
56 RFC2646).
57