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