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