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