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