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