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