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