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