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