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