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