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