Update README with new settings.
[manu/perfect_maildir.git] / README
1 Usage: perfect_maildir ~/Maildir < mbox
2
3 (since v0.3, two settings can be modified at the top of the file for date and
4 maildir++ handling)
5
6 Simple  - only converts one mbox (can use script in one-liners)
7 Perfect - message Flags/X-Flags are converted; "^>From ." line is unescaped
8
9 I wrote this script after being unsatisfied with existing mbox to
10 maildir converters. By making it "Simple", code complexity is kept
11 low thus making it easy to program and debug. At the same time,
12 since it only converts one mbox at a time, it is perfect for use in
13 a shell ``for'' loop (for example).
14
15 As for being "Perfect", to the best of my knowledge this script does
16 the conversion correctly in all cases; it will translate "Status"
17 and "X-Status" fields into maildir info, and it correctly detects
18 where messages begin and end. (This is only version 0.1 so I may
19 have messed something up though. Please send me feedback!)
20
21 NOTE: The MUA ``mutt'' has a bug/feature where in the message index,
22 it claims that all maildir messages have 0 lines unless they have a
23 "Lines:" header set. perfect_maildir does not attempt to add the
24 "Lines:" header; you may want to reconfigure ``mutt' to display byte
25 size instead of lines instead by adding the following line to your
26 ~/.muttrc file:
27 #
28 set index_format="%4C %Z %{%b %d} %-15.15L (%4c) %s"