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