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