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