PageRenderTime 168ms CodeModel.GetById 163ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/doc/users-guide/activity-log.xml

#
XML | 61 lines | 46 code | 12 blank | 3 comment | 0 complexity | 9b0be62dda90e4124692ae0ef1af5f9e MD5 | raw file
 1<?xml version="1.0" encoding="UTF-8"?>
 2
 3<appendix id="activity-log">
 4    <!-- jEdit buffer-local properties: -->
 5    <!-- :indentSize=4:noTabs=true: -->
 6    <!-- :xml.root=users-guide.xml: -->
 7    <title>The Activity Log</title>
 8
 9    <para>The <firstterm>activity log</firstterm> is very useful for
10    troubleshooting problems, and helps when developing plugins.</para>
11
12    <para><guimenu>Utilities</guimenu>&gt;<guisubmenu>Troubleshooting</guisubmenu>&gt;<guimenuitem>Activity
13    Log</guimenuitem> displays the last 500 lines of the activity log. By
14    default, the activity log is shown in a floating window. This window can be
15    docked using the commands in its top-left corner popup menu; see <xref
16    linkend="docking" />.</para>
17
18    <para>The complete log can be found in the <filename>activity.log</filename>
19    file inside the jEdit settings directory, the path of which is shown inside
20    the activity log window.</para>
21
22    <para>jEdit writes the following information to the activity log:</para>
23
24    <itemizedlist>
25        <listitem>
26            <para>Information about your Java implementation (version, operating
27            system, architecture, etc).</para>
28        </listitem>
29
30        <listitem>
31            <para>All error messages and runtime exceptions (most errors are
32            shown in dialog boxes as well, but the activity log usually contains
33            more detailed and technical information).</para>
34        </listitem>
35
36        <listitem>
37            <para>All sorts of debugging information that can be helpful when
38            tracking down bugs.</para>
39        </listitem>
40
41        <listitem>
42            <para>Information about loaded plugins.</para>
43        </listitem>
44
45    </itemizedlist>
46
47    <para>While jEdit is running, the log file on disk may not always accurately
48    reflect what has been logged, due to buffering being done for performance
49    reasons. To ensure the file on disk is up to date, invoke the
50    <guimenu>Utilities</guimenu>&gt;<guisubmenu>Troubleshooting</guisubmenu>&gt;<guimenuitem>Update
51    Activity Log on Disk</guimenuitem> command. The log file is also
52    automatically updated on disk when jEdit exits.</para>
53
54    <para>
55    The "Settings" button in the Activity Log window shows a dialog that lets
56    you adjust the output colors, filter the messages by type, and lets you set
57    the maximum number of lines to display.  Note that larger numbers will 
58    decrease the overall performance of jEdit since these lines are kept in
59    memory.
60    </para>
61</appendix>