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