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