reorganize to be more novice-friendly, add more docs
[flac.git] / doc / html / documentation_bugs.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson -->
3 <!-- Permission is granted to copy, distribute and/or modify this document -->
4 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
5 <!-- or any later version published by the Free Software Foundation; -->
6 <!-- with no invariant sections. -->
7 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
8 <html>
9 <head>
10         <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
11         <meta name="author" content="Josh Coalson" />
12         <meta name="description" content="A free, open source codec for lossless audio compression and decompression" />
13         <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" />
14         <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
15         <link rel="stylesheet" type="text/css" href="flac.css" />
16         <title>FLAC - documentation</title>
17 </head>
18
19 <body>
20
21 <div class="logo">
22         <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a>
23 </div>
24
25 <div class="above_nav"></div>
26
27 <div class="navbar">
28         &nbsp;<a href="index.html">home</a>&nbsp;&nbsp;|
29         &nbsp;<a href="faq.html">faq</a>&nbsp;&nbsp;|
30         &nbsp;<a href="news.html">news</a>&nbsp;&nbsp;|
31         &nbsp;<a href="download.html">download</a>&nbsp;&nbsp;|
32         &nbsp;<a href="documentation.html">documentation</a>&nbsp;&nbsp;|
33         &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
34         &nbsp;<a href="changelog.html">changelog</a>&nbsp;&nbsp;|
35         &nbsp;<a href="links.html">links</a>&nbsp;&nbsp;|
36         &nbsp;<a href="developers.html">developers</a>&nbsp;
37 </div>
38
39 <div class="langbar">
40         &nbsp;english&nbsp;&nbsp;|
41         &nbsp;<a href="ru/documentation.html">russian</a>&nbsp;
42 </div>
43
44 <div class="below_nav"></div>
45
46 <div class="box">
47         <div class="box_title">
48                 <a name="bugs">known bugs</a>
49         </div>
50         <div class="box_header"></div>
51         <div class="box_body">
52                 The following are major known bugs in the current (1.1.3) release:
53                 <ul>
54                         <li>
55                                 If your locale does not use "." for the decimal point, there is a bug that causes the default compression settings to be sub-optimal.  You should add <span class="argument">-A "tukey(0,5)"</span> to your <span class="command">flac</span> command string (or however "0.5" should be formatted for your locale).
56                         </li>
57                         <li>
58                                 If a corrupted FLAC file is used as input in FLAC-to-FLAC encoding, the transcoded FLAC file will have the audio data truncated after the first error.
59                         </li>
60                         <li>
61                                 When encoding to Ogg FLAC, if there are too many seek points (&gt;240), the seek table will not have the offsets written back properly after encoding.
62                         </li>
63                 </ul>
64         </div>
65         <div class="box_footer"></div>
66 </div>
67
68 <br />
69
70 <div class="box">
71         <div class="box_title">
72                 <a name="bug_reporting">reporting bugs</a>
73         </div>
74         <div class="box_header"></div>
75         <div class="box_body">
76                 To report a bug, please go to the <a href="http://sourceforge.net/tracker/?group_id=13478&amp;atid=113478">FLAC bug tracker</a> (or appropriately the <a href="http://sourceforge.net/tracker/?group_id=13478&amp;atid=363478">feature request tracker</a>, <a href="http://sourceforge.net/tracker/?group_id=13478&amp;atid=313478">patch page</a>, or <a href="http://sourceforge.net/tracker/?group_id=13478&amp;atid=213478">support page</a>).<br />
77                 <br />
78                 First check that there is not already an existing request.  If you do submit a new request, make sure and provide an email contact <b>and</b> use the Monitor feature.<br />
79                 <br />
80                 Note that we get many false bug reports from people with faulty hardware or who overclock their machines that FLAC is not working.  Please do due diligence if you are getting FLAC encoding or decoding errors that it is not the fault of the hardware.  FLAC encoding tends to highlight problems with bad RAM, corrupted files, and excessive overclocking.
81         </div>
82         <div class="box_footer"></div>
83 </div>
84
85
86 <div class="copyright">
87         <!-- @@@ oh so hacky -->
88         <table>
89                 <tr>
90                         <td align="left">
91                                 Copyright (c) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson
92                         </td>
93                         <td width="1%" align="right">
94                                 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
95                         </td>
96                         <td width="1%" align="right">
97                                 <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br />
98                         </td>
99                         <td width="1%" align="right">
100                                 <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a>
101                         </td>
102                 </tr>
103         </table>
104 </div>
105
106 </body>
107 </html>