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