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