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