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