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