enabling-debug-mode.dita 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <task id="t-enabling-debug-mode">
  5. <title>Enabling debug mode</title>
  6. <shortdesc>When the debug mode is enabled, additional diagnostic information is written to the log file. This
  7. information, which includes environment variables and stack trace data, can help you determine the root cause of a
  8. problem.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm><xmlelement>property</xmlelement></indexterm>
  13. <indexterm>command line<indexterm>debugging</indexterm></indexterm>
  14. <indexterm><cmdname>dita</cmdname> command<indexterm>debugging</indexterm></indexterm>
  15. <indexterm>debugging<indexterm>args.debug</indexterm></indexterm>
  16. <indexterm>environment variables</indexterm>
  17. <indexterm>stack trace</indexterm>
  18. <indexterm>args.debug</indexterm>
  19. <indexterm>Ant<indexterm>args.debug</indexterm></indexterm>
  20. </keywords>
  21. </metadata>
  22. </prolog>
  23. <taskbody>
  24. <steps>
  25. <step>
  26. <cmd>From the command prompt, add the following parameters:</cmd>
  27. <choicetable>
  28. <chhead>
  29. <choptionhd>Application</choptionhd>
  30. <chdeschd>Parameters</chdeschd>
  31. </chhead>
  32. <chrow>
  33. <choption><cmdname>dita</cmdname> command</choption>
  34. <chdesc><parmname>--debug</parmname>,
  35. <parmname>-debug</parmname>, or
  36. <parmname>-d</parmname></chdesc>
  37. </chrow>
  38. <chrow>
  39. <choption>Ant</choption>
  40. <chdesc><codeph>-v -Dargs.debug=yes</codeph></chdesc>
  41. </chrow>
  42. <!--<chrow importance="deprecated">
  43. <choption>Command-line tool</choption>
  44. <chdesc><codeph>/d</codeph> or <codeph>-debug</codeph></chdesc>
  45. </chrow>-->
  46. </choicetable>
  47. <info>
  48. <p>You also can add a <xmlelement>property</xmlelement> element to an Ant target in your build file, for
  49. example: <codeblock outputclass="language-xml">&lt;property name="args.debug" value="yes"/></codeblock></p></info>
  50. </step>
  51. </steps>
  52. </taskbody>
  53. </task>