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