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