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