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