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