Rocco Rutte:
[apps/madmutt.git] / UPGRADING
1 This documents describes changes
2
3   - made to configuration variables, functions and the like which are
4     not backwards-compatible and/or which do not exist in mutt
5
6   - other changes which might break existing user configuration and thus
7     have to be documented
8
9 This document is not the place for verbose documentation; it only offers
10 the necessary keywords to look them up in the manual, ChangeLog or other
11 sources of information.
12
13 2005-07-28:
14
15   Because of reverting a (overly eager) mutt-ng-specific issue with
16   header caching, starting with revision 362, all caches must be removed
17   and rebuild again. Sorry for that.
18
19 2005-07-25:
20
21   Due to changes to internal structures introduced in SVN revision 344,
22   all header caches must be removed and rebuild.
23
24   The '-D' command line option has been added.
25
26   Editing threads functionality is no longer only available
27   in muttng as it has been integrated into mutt, too.
28
29 2005-07-24:
30
31   The $xterm_leave option has been added.
32
33   The '^' shortcut pointing to the current folder is no longer
34   only available in muttng as it has been integrated into mutt, too.
35
36 2005-07-16:
37
38   The 'prepare' script has been renamed to 'autogen.sh' as this name
39   seems to be used in many projects using the autotools too.
40
41 2005-06-16:
42
43   Pine compatibility for naming IMAP mailboxes has been removed, only
44   the common imap[s]:// syntax remains.
45
46   The first "round" of removing synonym variables is completed. The
47   replacements for the next round are: ask_followup_to ->
48   nntp_ask_followup_to, ask_x_comment_to -> nntp_ask_x_comment_to,
49   catchup_newsgroup -> nntp_catchup, followup_to_poster ->
50   nntp_followup_to_poster, group_index_format ->
51   nntp_group_index_format, inews -> nntp_inews, mime_subject ->
52   nntp_mime_subject, news_cache_dir -> nntp_cache_dir, news_server ->
53   nntp_host, newsrc -> nntp_newsrc, nntp_poll -> nntp_mail_check,
54   pop_checkinterval -> pop_mail_check, post_moderated ->
55   nntp_post_moderated, save_unsubscribed -> nntp_save_unsubscribed,
56   show_new_news -> nntp_show_new_news, show_only_unread ->
57   nntp_show_only_unread, x_comment_to -> nntp_x_comment_to. Please use
58   the contrib/update-config.pl script to update.
59
60   Due to frequent trouble, $imap_mail_check now defaults to 300 seconds
61   (5 minutes) rather than 5 seconds.
62
63   The configuration variable $strict_mailto has been added.
64
65 2005-05-17:
66
67   Changes due to better integration of qdbm support w/ header caching:
68   
69     - the $header_cache_pagesize variable is not available with as it's 
70       not used
71     - the following feature tests were added: feature_qdbm, feature_gdbm,
72       feature_db4 (for ifdef/ifndef)
73
74 2005-05-14:
75
76   New Configuration Variables:
77     - $header_cache_compress - compress header cache database with qdbm
78       when switching to qdbm, please make sure to _first_ _completely_
79       remove the old header cache (files) as you need to start off from
80       scratch; compressed qdbm require much less space (only ~1/5)
81
82 2005-04-18:
83
84   New Configuration Variables:
85     - $sidebar_boundary - boundary characters for name compression
86     - $sidebar_number_format - control if and how to print/count numbers
87
88   Renamed Variables:
89     - $shorten_hierarchy is now named $sidebar_shorten_hierarchy
90       (still kept as synonym)
91
92 2005-03-16:
93
94   New Configuration Variables:
95     - $sidebar_newmail_only - if set, only mailboxes with new mail will
96       be shown in the sidebar
97
98 2005-03-14
99
100   New Configuration Variables:
101     - $strip_was
102     - $strip_was_regex
103
104 2005-03-10
105
106   New Configuration Command (based on CD's ifdef Patch):
107     - ifdef
108     - ifndef
109
110 2005-03-07
111
112   New Variables: 
113     - $imap_mail_check is split from $mail_check
114     - $force_buffy_check forces check on <buffy-list>
115
116 2005-03-05
117
118   New Color:
119     - 'sidebar [fg] [bg]' for the delimiter
120
121 2005-03-01 (init)
122
123   New Variables:
124
125     NNTP-Support:
126     ask_follow_up, ask_x_comment_to, followup_to_poster,
127     group_index_format, catchup_newsgroup, inews, news_cache_dir,
128     newsrc,news_server, nntp_context, nntp_load_description, nntp_pass,
129     nntp_poll, nntp_reconnect, nntp_user, post_moderated,
130     save_unsubscribed, show_new_news, show_only_unread, x_comment_to
131
132     Quoting-Initials-Support
133     indent_string
134
135     libESMTP-Support:
136     smtp_auth_password, smtp_auth_username, smtp_host, smtp_port
137
138     Assumed Character Set Patch:
139     assumed_charset, strict_mime, file_charset 
140
141     Header Caching:
142     maildir_header_cache_verify, header_cache 
143
144     Sidebar:
145     sidebar_delim, sidebar_visible, sidebar_width, shorten_hierarchy
146
147     Format Flowed Improvements:
148     max_line_length, quote_empty, quote_quoted, stuff_quoted
149
150     XTerm-Titles Patch:
151     xterm_icon, xterm_set_titles, xterm_title
152
153     Misc.
154     imap_reconnect, msgid_format, operating_system, shorten_hierarchy,
155     signoff_string, umask
156     
157     Trash-Folder Patch:
158     trash
159
160   New Functions:
161
162     NNTP-Support:
163     change-newsgroup, change-newsgroup-readonly, forward-to-group,
164     followup-message, get-children, get-message, get-parent,
165     reconstruct-thread, post-message, catchup, edit-newsgroups,
166     edit-followup-to, edit-x-comment-to, reload-active,
167     subscribe-pattern, unsubscribe-pattern, catchup, uncatchup,
168
169     Purge-Message Patch:
170     purge-message
171
172     List-Reply Patch
173     list_reply 
174
175     Patch edit_threads:
176     break-thread, link-threads
177
178     Sidebar:
179     sidebar-open, sidebar-next, sidebar-prev, sidebar-next-new,
180     sidebar-prev-new, sidebar-scroll-up, sidebar-scroll-down
181
182   New Hooks:
183
184     Compressed-Folder Support:
185     close-hook, open-hook, append-hook
186
187   New Misc.:
188
189     Sidebar Colors:
190     sidebar_new, sidebar_flagged
191
192     Scoring Patterns:
193     ~*
194
195   Other Changes:
196   
197     The config files were renamed. Instead of ~/.muttrc it's now
198     ~/.muttngrc, instead of /etc/Muttrc it's now /etc/Muttngrc and
199     so on.
200
201     The config directories were renamed too. If you used .mutt/ for
202     config file you have to use .muttng/ now.
203
204     The following tools were removed:
205     bin/flea, bin/muttbug, bin/mutt_dotlock, bin/pgpewrap, bin/pgpring,
206     bin/smime_keys and etc/mime.types.
207     They were replaced by:
208     bin/fleang, bin/muttngbug, bin/muttng_dotlock, bin/pgpewrapng
209     bin/pgpringng, bin/smime_keysng and etc/muttng-mime.types.
210     Please check and update your configuration.