help/help/html/logging.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3
  11  * of the License, or (at your option) any later version.
  12  *
  13  * Jalview is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16  * PURPOSE.  See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  20  * The Jalview Authors are detailed in the 'AUTHORS' file.
  21  -->
  22 <head>
  23 <title>Logging and Reporting Bugs</title>
  24 </head>
  25 <body>
  26   <h2>
  27     <center>
  28       <strong>Logging and Reporting Bugs</strong>
  29     </center>
  30   </h2>
  31
  32   <h3>Logging</h3>
  33   <p>
  34   Jalview creates logs that can be extremely useful for diagnosing, or help to provide a workaround for, specific problems that you might encounter.
  35   </p>
  36   <p>
  37   The primary place to look for logs is in the <a href="#java_console">Java Console</a> which you can open from within Jalview by going to the <em>Tools</em> menu and checking the box next to <em>Show Java Console</em>.  This option is stored in your Jalview preferences file and so is remembered across Jalview sessions.
  38   </p>
  39   <p>
  40   The Java Console will show you information about what the Jalview application is doing (often in the background) whilst it is running.
  41   </p>
  42   <p>
  43   However, it is possible that some early logging information from when Jalview is initially launched, is not shown in the Java Console:
  44   <br/>
  45   If you are using a version of Jalview installed from one of our install4j installers, then Jalview's initial launch logging can be found in
  46   <pre>JALVIEW_APP_DIR/launcher.log</pre>
  47   where <em>JALVIEW_APP_DIR</em> is the directory that Jalview's application was installed into.
  48   <br/>
  49   For Jalview 2.11.0 onwards:
  50   <ul>
  51     <li>In Windows this is <em>%APPDATA%\Local\Jalview</em> by default</li>
  52     <li>In macOS this is <em>/Applications/Jalview.app/Contents/Resources/app</em> by default</li>
  53     <li>In Linux and other Unix OSes this is <em>~/opt/jalview</em> by default</li>
  54   </ul>
  55   <br/>
  56   Whereas if you are using the Jalview executable jar file (also used by bioconda installations) then a minimised launcher will output logging information to STDOUT and STDERR.
  57   </p>
  58
  59   <h3><a name="java_console">Java Console and Log Level</a></h3>
  60
  61
  62   <h3>Reporting Bugs</h3>
  63
  64
  65 </body>
  66 </html>