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-08-28:
  14
  15   The $editor_headers option has been added.
  16
  17   The %Z expando of $index_format now also includes an 'A'
  18   as the last character if a mail has attachments, i.e. is of
  19   type multipart and a space otherwise.
  20
  21 2005-08-27:
  22
  23   The $debug_level option has been added.
  24
  25   It's now possible to define and use arbitrary self-defined
  26   variables as long as prefixed with user_.
  27
  28   The $user_agent variable had to be renamed to $agent_string.
  29
  30   To keep consistency, the -D option has been removed again in
  31   favor of -T and -t.
  32
  33 2005-08-25:
  34
  35   Instead of only supporting to expand environment variables via
  36   $NAME, it's now possible to query for all variables, too, e.g.
  37   'set imap_home_namespace = $folder'.
  38
  39   The $abort_noattach and $attach_remind_regexp options have been
  40   added to remind users of possibly forgotten attachments.
  41
  42 2005-08-23:
  43
  44   The $delete_space option has been added.
  45
  46 2005-08-22:
  47
  48   Reading configurations from ~/.muttngrc-$version and
  49   ~/.muttng/muttngrc-$version is no longer supported;
  50   ~/.muttngrc and ~/.muttng/muttngrc remain.
  51
  52 2005-08-18:
  53
  54   The $max_display_recips option has been added.
  55
  56 2005-08-13:
  57
  58   The $smtp_envelope option has been added.
  59
  60   To improve consistency, the following variables were renamed and
  61   synonyms kept: $smtp_auth_username to $smtp_user and
  62   $smtp_auth_password to $smtp_pass.
  63
  64 2005-08-11:
  65
  66   The $smtp_use_tls option has been added.
  67
  68   The $imap_check_subscribed option has been added in muttng and mutt.
  69
  70 2005-08-08:
  71
  72   The $imap_force_ssl option has been replaced with the more generic
  73   $ssl_force_tls option.
  74
  75 2005-08-07:
  76
  77   For $sidebar_number_format, the expandos %c and %f are replaced with
  78   their $status_format pendants %m and %F respectively. Use of %c and
  79   %f is deprecated but still kept for compatibility.
  80
  81 2005-08-06:
  82
  83   Due to merging in changes made to mutt where NSS support was dropped,
  84   it's dropped in mutt-ng too.
  85
  86 2005-07-28:
  87
  88   Because of reverting a (overly eager) mutt-ng-specific issue with
  89   header caching, starting with revision 362, all caches must be removed
  90   and rebuild again. Sorry for that.
  91
  92 2005-07-25:
  93
  94   Due to changes to internal structures introduced in SVN revision 344,
  95   all header caches must be removed and rebuild.
  96
  97   The '-D' command line option has been added.
  98
  99   Editing threads functionality is no longer only available
 100   in muttng as it has been integrated into mutt, too.
 101
 102 2005-07-24:
 103
 104   The $xterm_leave option has been added.
 105
 106   The '^' shortcut pointing to the current folder is no longer
 107   only available in muttng as it has been integrated into mutt, too.
 108
 109 2005-07-16:
 110
 111   The 'prepare' script has been renamed to 'autogen.sh' as this name
 112   seems to be used in many projects using the autotools too.
 113
 114 2005-06-16:
 115
 116   Pine compatibility for naming IMAP mailboxes has been removed, only
 117   the common imap[s]:// syntax remains.
 118
 119   The first "round" of removing synonym variables is completed. The
 120   replacements for the next round are: ask_followup_to ->
 121   nntp_ask_followup_to, ask_x_comment_to -> nntp_ask_x_comment_to,
 122   catchup_newsgroup -> nntp_catchup, followup_to_poster ->
 123   nntp_followup_to_poster, group_index_format ->
 124   nntp_group_index_format, inews -> nntp_inews, mime_subject ->
 125   nntp_mime_subject, news_cache_dir -> nntp_cache_dir, news_server ->
 126   nntp_host, newsrc -> nntp_newsrc, nntp_poll -> nntp_mail_check,
 127   pop_checkinterval -> pop_mail_check, post_moderated ->
 128   nntp_post_moderated, save_unsubscribed -> nntp_save_unsubscribed,
 129   show_new_news -> nntp_show_new_news, show_only_unread ->
 130   nntp_show_only_unread, x_comment_to -> nntp_x_comment_to. Please use
 131   the contrib/update-config.pl script to update.
 132
 133   Due to frequent trouble, $imap_mail_check now defaults to 300 seconds
 134   (5 minutes) rather than 5 seconds.
 135
 136   The configuration variable $strict_mailto has been added.
 137
 138 2005-05-17:
 139
 140   Changes due to better integration of qdbm support w/ header caching:
 141
 142     - the $header_cache_pagesize variable is not available with as it's
 143       not used
 144     - the following feature tests were added: feature_qdbm, feature_gdbm,
 145       feature_db4 (for ifdef/ifndef)
 146
 147 2005-05-14:
 148
 149   New Configuration Variables:
 150     - $header_cache_compress - compress header cache database with qdbm
 151       when switching to qdbm, please make sure to _first_ _completely_
 152       remove the old header cache (files) as you need to start off from
 153       scratch; compressed qdbm require much less space (only ~1/5)
 154
 155 2005-04-18:
 156
 157   New Configuration Variables:
 158     - $sidebar_boundary - boundary characters for name compression
 159     - $sidebar_number_format - control if and how to print/count numbers
 160
 161   Renamed Variables:
 162     - $shorten_hierarchy is now named $sidebar_shorten_hierarchy
 163       (still kept as synonym)
 164
 165 2005-03-16:
 166
 167   New Configuration Variables:
 168     - $sidebar_newmail_only - if set, only mailboxes with new mail will
 169       be shown in the sidebar
 170
 171 2005-03-14
 172
 173   New Configuration Variables:
 174     - $strip_was
 175     - $strip_was_regex
 176
 177 2005-03-10
 178
 179   New Configuration Command (based on CD's ifdef Patch):
 180     - ifdef
 181     - ifndef
 182
 183 2005-03-07
 184
 185   New Variables:
 186     - $imap_mail_check is split from $mail_check
 187     - $force_buffy_check forces check on <buffy-list>
 188
 189 2005-03-05
 190
 191   New Color:
 192     - 'sidebar [fg] [bg]' for the delimiter
 193
 194 2005-03-01 (init)
 195
 196   New Variables:
 197
 198     NNTP-Support:
 199     ask_follow_up, ask_x_comment_to, followup_to_poster,
 200     group_index_format, catchup_newsgroup, inews, news_cache_dir,
 201     newsrc,news_server, nntp_context, nntp_load_description, nntp_pass,
 202     nntp_poll, nntp_reconnect, nntp_user, post_moderated,
 203     save_unsubscribed, show_new_news, show_only_unread, x_comment_to
 204
 205     Quoting-Initials-Support
 206     indent_string
 207
 208     libESMTP-Support:
 209     smtp_auth_password, smtp_auth_username, smtp_host, smtp_port
 210
 211     Assumed Character Set Patch:
 212     assumed_charset, strict_mime, file_charset
 213
 214     Header Caching:
 215     maildir_header_cache_verify, header_cache
 216
 217     Sidebar:
 218     sidebar_delim, sidebar_visible, sidebar_width, shorten_hierarchy
 219
 220     Format Flowed Improvements:
 221     max_line_length, quote_empty, quote_quoted, stuff_quoted
 222
 223     XTerm-Titles Patch:
 224     xterm_icon, xterm_set_titles, xterm_title
 225
 226     Misc.
 227     imap_reconnect, msgid_format, operating_system, shorten_hierarchy,
 228     signoff_string, umask
 229
 230     Trash-Folder Patch:
 231     trash
 232
 233   New Functions:
 234
 235     NNTP-Support:
 236     change-newsgroup, change-newsgroup-readonly, forward-to-group,
 237     followup-message, get-children, get-message, get-parent,
 238     reconstruct-thread, post-message, catchup, edit-newsgroups,
 239     edit-followup-to, edit-x-comment-to, reload-active,
 240     subscribe-pattern, unsubscribe-pattern, catchup, uncatchup,
 241
 242     Purge-Message Patch:
 243     purge-message
 244
 245     List-Reply Patch
 246     list_reply
 247
 248     Patch edit_threads:
 249     break-thread, link-threads
 250
 251     Sidebar:
 252     sidebar-open, sidebar-next, sidebar-prev, sidebar-next-new,
 253     sidebar-prev-new, sidebar-scroll-up, sidebar-scroll-down
 254
 255   New Hooks:
 256
 257     Compressed-Folder Support:
 258     close-hook, open-hook, append-hook
 259
 260   New Misc.:
 261
 262     Sidebar Colors:
 263     sidebar_new, sidebar_flagged
 264
 265     Scoring Patterns:
 266     ~*
 267
 268   Other Changes:
 269
 270     The config files were renamed. Instead of ~/.muttrc it's now
 271     ~/.muttngrc, instead of /etc/Muttrc it's now /etc/Muttngrc and
 272     so on.
 273
 274     The config directories were renamed too. If you used .mutt/ for
 275     config file you have to use .muttng/ now.
 276
 277     The following tools were removed:
 278     bin/flea, bin/muttbug, bin/mutt_dotlock, bin/pgpewrap, bin/pgpring,
 279     bin/smime_keys and etc/mime.types.
 280     They were replaced by:
 281     bin/fleang, bin/muttngbug, bin/muttng_dotlock, bin/pgpewrapng
 282     bin/pgpringng, bin/smime_keysng and etc/muttng-mime.types.
 283     Please check and update your configuration.