| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <title>MHonArc v2.5 -- Release Notes</title> |
| 5 | </head> |
| 6 | <!-- |
| 7 | <body background="ssbg75.jpg" |
| 8 | text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000"> |
| 9 | --> |
| 10 | <body> |
| 11 | |
| 12 | <!--X-NavButtons-Start--> |
| 13 | <table width="100%"> |
| 14 | <tr valign="top"> |
| 15 | <td align="left"><nobr><a href="intro.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="install.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table> |
| 16 | <!--X-NavButtons-End--> |
| 17 | <hr> |
| 18 | |
| 19 | <h1><a name="relnotes">Release Notes</a></h1> |
| 20 | |
| 21 | <p>Read the <tt>CHANGES</tt> document included in the distribution |
| 22 | for a more complete summary of changes to |
| 23 | MHonArc. This document highlights important changes that have occurred |
| 24 | and important usage details which you should be aware of before using |
| 25 | MHonArc. If you are upgrading from a previous release, make sure to |
| 26 | check for the |
| 27 | <a href="#important">highlighted incompatibilites</a> |
| 28 | from earlier releases. |
| 29 | </p> |
| 30 | |
| 31 | <!--X-TOC-Start--> |
| 32 | <ul> |
| 33 | <li><a href="#important">Compatibility Notes</a> |
| 34 | <ul> |
| 35 | <li><small><a href="#v2.4.x-defrcname">UPGRADING FROM v2.4.x OR EARLIER: DEFRCNAME Change</a></small> |
| 36 | <li><small><a href="#v2.4.x-header-footer">UPGRADING FROM v2.4.x OR EARLIER: HEADER and FOOTER Removed</a></small> |
| 37 | <li><small><a href="#v2.4.x-mimefilters">UPGRADING FROM v2.4.x OR EARLIER: MIMEFILTERS API Change</a></small> |
| 38 | <li><small><a href="#v2.1.x-dbedit">UPGRADING FROM v2.1.x OR EARLIER: Database Format Change</a></small> |
| 39 | <li><small><a href="#down">DOWNGRADING TO OLDER VERSIONS</a></small> |
| 40 | </ul> |
| 41 | <li><a href="#general">General Notes</a> |
| 42 | </ul> |
| 43 | <!--X-TOC-End--> |
| 44 | |
| 45 | <!-- *************************************************************** --> |
| 46 | <hr> |
| 47 | <h2><a name="important">Compatibility Notes</a></h2> |
| 48 | |
| 49 | <p>This sections provides notes dealing with compatibility issues |
| 50 | if upgrading from a previous release of MHonArc: |
| 51 | </p> |
| 52 | |
| 53 | <h3><a name="v2.4.x-defrcname">UPGRADING FROM v2.4.x OR EARLIER: DEFRCNAME Change</a></h3> |
| 54 | |
| 55 | <p>The default value for the <a |
| 56 | href="resources/defrcname.html">DEFRCNAME</a> is now called |
| 57 | "<tt>.mhonarc.mrc</tt>", or "<tt>mhonarc.mrc</tt>" under |
| 58 | Windows and VMS. The old value was "<tt>.mhonarc.rc</tt>", or |
| 59 | "<tt>mhonarc.rc</tt>". If you use the default resource file, |
| 60 | you will need to rename the file to match the filenames used for |
| 61 | v2.5 and later. |
| 62 | </p> |
| 63 | |
| 64 | <h3><a name="v2.4.x-header-footer">UPGRADING FROM v2.4.x OR EARLIER: HEADER and FOOTER Removed</a></h3> |
| 65 | |
| 66 | <p>The HEADER and FOOTER resources are no longer supported. |
| 67 | If you are using these resources, the HEADER content and |
| 68 | FOOTER content will be lost once v2.5, or later, of |
| 69 | MHonArc processes an archive containing these resources. |
| 70 | </p> |
| 71 | <p>The HEADER and FOOTER resources have been deprecated for |
| 72 | a long time since they only applied to the main index; the |
| 73 | thread index has no equivalent. The |
| 74 | <a href="resources/idxpgbegin.html">IDXPGBEGIN</a> |
| 75 | or <a href="resources/listbegin.html">LISTBEGIN</a> |
| 76 | resources can be used to achieve the same effect of HEADER. |
| 77 | The <a href="resources/idxpgend.html">IDXPGEND</a> |
| 78 | or <a href="resources/listend.html">LISTEND</a> |
| 79 | can be used to achieve the same effect |
| 80 | of FOOTER. |
| 81 | </p> |
| 82 | |
| 83 | <h3><a name="v2.4.x-mimefilters">UPGRADING FROM v2.4.x OR EARLIER: MIMEFILTERS API Change</a></h3> |
| 84 | |
| 85 | <p>The API for data filters registered via |
| 86 | <a href="resources/mimefilters.html">MIMEFILTERS</a> |
| 87 | is not capability with filters written for v2.4.x and |
| 88 | earlier. See CHANGES and the documentation for the |
| 89 | <a href="resources/mimefilters.html">MIMEFILTERS</a> resource |
| 90 | for the API. |
| 91 | </p> |
| 92 | <p>If you use custom style filters written for v2.4.x, or earlier, |
| 93 | you will need to update them for them to work properly under |
| 94 | v2.5, and later. |
| 95 | </p> |
| 96 | |
| 97 | <h3><a name="v2.1.x-dbedit">UPGRADING FROM v2.1.x OR EARLIER: Database Format Change</a></h3> |
| 98 | |
| 99 | <p>If you have archives created with v2.1.x, or earlier, the |
| 100 | format of mime-related resources is not compatible with v2.2, and |
| 101 | later, versions. MHonArc will reset the mime-related resources |
| 102 | <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a> |
| 103 | and <a href="resources/mimefilters.html">MIMEFILTERS</a> to their |
| 104 | default values. |
| 105 | <a href="resources/mimeargs.html">MIMEARGS</a> will also be |
| 106 | reset to the default value unless you are upgrading to v2.5.8, or |
| 107 | later, where the MIMEARGS settings will be preserved. |
| 108 | </p> |
| 109 | <p>To avoid the resetting of the mime-related resource if you |
| 110 | are using customized settings, you will need to re-specify your |
| 111 | settings the next time you update an archive. If you always |
| 112 | specify your resource settings each time you invoke MHonArc, then |
| 113 | your settings should to still take effect. |
| 114 | </p> |
| 115 | <p>You can also use the |
| 116 | <a href="app-utilsprg.html#mha-dbedit"><tt>mha-dbedit</tt></a> |
| 117 | program to apply |
| 118 | your settings directly without processing the archive. |
| 119 | </p> |
| 120 | |
| 121 | <h3><a name="down">DOWNGRADING TO OLDER VERSIONS</a></h3> |
| 122 | |
| 123 | <p>Downgrading to an earlier version of MHonArc can be |
| 124 | dangerous, especially if downgrading to an older version that |
| 125 | used different storage formats in archive database files from |
| 126 | the current version in use. |
| 127 | If an older version of MHonArc is |
| 128 | used to process an archive last updated by a new version, archive |
| 129 | data can get lost and/or unexpected output can occur. |
| 130 | </p> |
| 131 | <p>Changes in archive format are not common, so downgrading |
| 132 | can be okay depending on the versions involved. The key versions |
| 133 | to watch out for are the ones noted in this section where |
| 134 | database format changes have occured. The following lists |
| 135 | release numbers where a format change occured: |
| 136 | </p> |
| 137 | <ul> |
| 138 | <li>2.0.0</li> |
| 139 | <li>2.2.0</li> |
| 140 | <li>2.5.0</li> |
| 141 | </ul> |
| 142 | <p>For example, if an archive was last updated with v2.5.0, |
| 143 | processing the archive with a previous release will cause problems. |
| 144 | </p> |
| 145 | <p>A possible method for successfully downgrading to a release |
| 146 | with differences in the database format, |
| 147 | is to try to reconstruct the database file using |
| 148 | the <a href="app-utilsprg.html#mha-dbrecover"><tt>mha-dbrecover</tt></a> |
| 149 | utility contained in the MHonArc version the archive is being |
| 150 | downgraded to. |
| 151 | </p> |
| 152 | <p>Of course, the safest way to downgrade is to recreate an archive |
| 153 | from the original raw mail data. It is good practice to preserve |
| 154 | the raw mail data in some form for cases like these and for |
| 155 | general archive recovering situations due to file corruption or other |
| 156 | system failures. |
| 157 | </p> |
| 158 | |
| 159 | <!-- *************************************************************** --> |
| 160 | <hr> |
| 161 | <h2><a name="general">General Notes</a></h2> |
| 162 | |
| 163 | <ul> |
| 164 | |
| 165 | <li><p>For v2.5, the default text/html filter (mhtxthtml.pl) will |
| 166 | now convert auto-loaded URL attributes to |
| 167 | '<tt>javascript:void(0);</tt>' for some HTML elements -- |
| 168 | <tt>IMG</tt>, <tt>BODY</tt>, <tt>IFRAME</tt>, <tt>FRAME</tt>, |
| 169 | <tt>OBJECT</tt>, <tt>SCRIPT</tt>, <tt>INPUT</tt> -- except for cid: |
| 170 | URLs. This behavior can be disabled if the '<tt>allownoncidurls</tt>' |
| 171 | filter argument is specified. |
| 172 | </p> |
| 173 | <p>The new behavior is to prevent malicious URLs that verify |
| 174 | mail addresses for spam purposes, secretly set cookies, or |
| 175 | gather some statistical data automatically with the use of |
| 176 | elements that cause browsers to automatically fetch data. |
| 177 | </p> |
| 178 | </li> |
| 179 | |
| 180 | <li><p>ISO-8859 character set data processing now defaults to using |
| 181 | the <tt>MHonArc::CharEnt</tt> module in v2.5. The old <tt>iso8859.pl</tt> |
| 182 | library is still provided for compatibility with older |
| 183 | archives. To update archives to use the new settings, you |
| 184 | can run the following command, |
| 185 | </p> |
| 186 | <pre> |
| 187 | <a href="app-utilsprg.html#mha-dbedit">mha-dbedit</a> -rcfile examples/<a href="rcfileexs/def-mime.mrc.html">def-mime.mrc</a> \ |
| 188 | -outdir /path/to/archive </pre> |
| 189 | <p>where "examples/<a href="rcfileexs/def-mime.mrc.html">def-mime.mrc</a>" represents the default MIME |
| 190 | processing resources for MHonArc provided within the MHonArc |
| 191 | distribution. |
| 192 | </p> |
| 193 | <table border=0 cellpadding=4> |
| 194 | <tr valign="top"> |
| 195 | <td><strong>NOTE</strong></td> |
| 196 | <td><p>v2.5.4, and later, generated archives will automatically |
| 197 | inherit new |
| 198 | <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a> |
| 199 | if the built-in defaults are being used. |
| 200 | However, if you have defined CHARSETCONVERTERS for your archives, you |
| 201 | will need to explicitly update your archives if you want them |
| 202 | applied to your archives. |
| 203 | </p> |
| 204 | </td> |
| 205 | </tr> |
| 206 | </table> |
| 207 | </li> |
| 208 | |
| 209 | <li><p>The value of the <a href="resources/tslice.html">TSLICE</a> |
| 210 | resource is used to determine the number of messages to update, |
| 211 | before and after by thread, of each new message added. To |
| 212 | insure that messages within a thread slice are updated when |
| 213 | a new message is added, make sure the before and after ranges |
| 214 | specified for <a href="resources/tslice.html">TSLICE</a> is |
| 215 | equal to maximum before and the maximum after range arguments |
| 216 | specifed in the uses of the |
| 217 | <a href="rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource |
| 218 | variable. For example, if you have <tt>$TSLICE(0;4)$</tt> and |
| 219 | <tt>$TSLICE(3;3)$</tt> in message layout resources, you should |
| 220 | set TSLICE to <tt>3:4</tt>. |
| 221 | </p> |
| 222 | <p>If you only use <tt>$TSLICE$</tt> once, it is best to |
| 223 | set options for thread slice formatting via the |
| 224 | TSLICE resource so you will not have anything to worry about. |
| 225 | </p> |
| 226 | |
| 227 | <li><p>If updgrading from v2.4.x, or earlier, reference and follow-up |
| 228 | information of a message is now stored in a different format |
| 229 | in the database (and internally). MHonArc will auto-update |
| 230 | older archives to the new format, so no action should be |
| 231 | required on your part. |
| 232 | </p> |
| 233 | </li> |
| 234 | |
| 235 | <li><p>If upgrading from v2.1.x, or earlier, any custom filters you |
| 236 | have developed may need to modified. If your filter accessed |
| 237 | some main variables, your filter will not operate properly. |
| 238 | All variables that used to be in package "main" are no longer. |
| 239 | The major variables are now in package "mhonarc". For example, |
| 240 | <tt>$::OUTDIR</tt> is now <tt>$mhonarc::OUTDIR</tt>. See the |
| 241 | <a href="resources/mimefilters.html">MIMEFILTERS</a> |
| 242 | resource page for more information. |
| 243 | </p> |
| 244 | </li> |
| 245 | |
| 246 | <li><p>See the warnings in the documentation for the |
| 247 | <a href="resources/htmlext.html">HTMLEXT</a> and |
| 248 | <a href="resources/msgprefix.html">MSGPREFIX</a> |
| 249 | resources before using them. |
| 250 | </p> |
| 251 | </li> |
| 252 | |
| 253 | <li><p>Occasionally, a new release of MHonArc may contain new |
| 254 | MIME filters. See the <tt>CHANGES</tt> file to check if any new filters |
| 255 | have been added. |
| 256 | </p> |
| 257 | <p>If you confirm that new filters have been added, and you want |
| 258 | to apply them to your archives, you use the |
| 259 | <a href="app-utilsprg.html#mha-dbedit"><tt>mha-dbedit</tt></a> |
| 260 | program |
| 261 | using the <tt><a href="rcfileexs/def-mime.mrc.html">def-mime.mrc</a></tt> |
| 262 | in the examples directory. |
| 263 | </p> |
| 264 | <table border=0 cellpadding=4> |
| 265 | <tr valign="top"> |
| 266 | <td><strong>NOTE</strong></td> |
| 267 | <td><p>v2.5.4, and later, generated archives will automatically |
| 268 | inherit new MIMEFILTERS if the built-in defaults are being used. |
| 269 | However, if you have defined MIMEFILTERS for your archives, you |
| 270 | will need to explicitly update your archives if you want them |
| 271 | applied to your archives. |
| 272 | </p> |
| 273 | </td> |
| 274 | </tr> |
| 275 | </table> |
| 276 | <p>Example usage of <tt>mha-dbedit</tt>: |
| 277 | </p> |
| 278 | <pre> |
| 279 | mha-dbedit -rcfile examples/<a href="rcfileexs/def-mime.mrc.html">def-mime.mrc</a> \ |
| 280 | -outdir /path/to/archive </pre> |
| 281 | <p>Change the <a href="resources/rcfile.html">-rcfile</a> |
| 282 | and <a href="resources/outdir.html">-outdir</a> pathnames to reflect where |
| 283 | you are running mhonarc and where your archive is located, |
| 284 | respectively. |
| 285 | </p> |
| 286 | <p>Note, if your archives are using custom settings of |
| 287 | <a href="resources/mimefilters.html">MIMEFILTERS</a>, |
| 288 | <a href="resources/mimeargs.html">MIMEARGS</a>, and/or |
| 289 | <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a> |
| 290 | resources, |
| 291 | you will need to create a variant version of |
| 292 | <tt><a href="rcfileexs/def-mime.mrc.html">def-mime.mrc</a></tt> |
| 293 | (included in the examples directory) to include your settings |
| 294 | and use the variant version when updating your archives. |
| 295 | </p> |
| 296 | </li> |
| 297 | |
| 298 | </ul> |
| 299 | |
| 300 | <hr> |
| 301 | <!--X-NavButtons-Start--> |
| 302 | <table width="100%"> |
| 303 | <tr valign="top"> |
| 304 | <td align="left"><nobr><a href="intro.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="install.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table> |
| 305 | <!--X-NavButtons-End--> |
| 306 | |
| 307 | <!-- *************************************************************** --> |
| 308 | <hr> |
| 309 | <address> |
| 310 | $Date: 2002/06/27 05:00:01 $ <br> |
| 311 | <img align="top" src="monicon.png" alt=""> |
| 312 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> |
| 313 | Copyright © 1997-2001, <a href="http://www.mhonarc.org/~ehood/" |
| 314 | >Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org" |
| 315 | >mhonarc@mhonarc.org</a><br> |
| 316 | </address> |
| 317 | |
| 318 | </BODY> |
| 319 | </HTML> |