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