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