/jEdit/tags/jedit-4-2-pre3/doc/users-guide/activity-log.xml

# · XML · 42 lines · 38 code · 1 blank · 3 comment · 0 complexity · 07ab5c14487d08a4be97543418a6948d MD5 · raw file

  1. <!-- jEdit buffer-local properties: -->
  2. <!-- :indentSize=1:noTabs=true: -->
  3. <!-- :xml.root=users-guide.xml: -->
  4. <appendix id="activity-log"><title>The Activity Log</title>
  5. <para>
  6. The <firstterm>activity log</firstterm> is very useful for
  7. troubleshooting problems, and helps when developing plugins.
  8. </para>
  9. <para>
  10. <guimenu>Utilities</guimenu>&gt;<guisubmenu>Troubleshooting</guisubmenu>&gt;<guimenuitem>Activity
  11. Log</guimenuitem> displays
  12. the last 500 lines of the activity log. By default, the activity log is shown in a floating window. It can be docked using the commands shown when clicking the popup menu button in the top-left corner; see <xref linkend="docking" />.
  13. The complete
  14. log can be found in the <filename>activity.log</filename> file inside the
  15. jEdit settings directory, the path of which is shown inside the activity
  16. log window.
  17. </para>
  18. <para>
  19. jEdit writes the following information to the activity log:
  20. </para>
  21. <itemizedlist>
  22. <listitem><para>Information about your Java implementation (version,
  23. operating system, architecture, etc).</para></listitem>
  24. <listitem><para>All error messages and runtime exceptions (most errors
  25. are shown in dialog boxes as well, but the activity log usually
  26. contains more detailed and technical information).
  27. </para></listitem>
  28. <listitem><para>All sorts of debugging information that can be helpful
  29. when tracking down bugs.</para></listitem>
  30. <listitem><para>Information about loaded plugins.</para></listitem>
  31. </itemizedlist>
  32. <para>
  33. While jEdit is running, the log file on disk may not always accurately reflect
  34. what has been logged, due to buffering being done for performance reasons.
  35. To ensure the file on disk is up to
  36. date, invoke the
  37. <guimenu>Utilities</guimenu>&gt;<guisubmenu>Troubleshooting</guisubmenu>&gt;<guimenuitem>Update
  38. Activity Log on Disk</guimenuitem> command. The log file is also automatically
  39. updated on disk when jEdit exits.
  40. </para>
  41. </appendix>