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