| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
|---|
| 3 | <concept id="loghandling" xml:lang="en-us">
|
|---|
| 4 | <title>Log files</title>
|
|---|
| 5 | <shortdesc>When you run the DITA-OT, key information is logged on the screen. This information
|
|---|
| 6 | also is written to a log file. If you encounter a problem, you can analyze this information to
|
|---|
| 7 | determine the source of the problem and then take action to resolve it.</shortdesc>
|
|---|
| 8 | <conbody>
|
|---|
| 9 | <p>The logging behavior varies depending on whether you use the DITA-OT command-line tool or Ant
|
|---|
| 10 | to invoke a toolkit build.<dl>
|
|---|
| 11 | <dlentry>
|
|---|
| 12 | <dt>Ant</dt>
|
|---|
| 13 | <dd>By default, status information is written to the screen. If you issue the
|
|---|
| 14 | <parmname>-l</parmname> parameter, the build runs silently and the information is
|
|---|
| 15 | written to a log file with the name and location that you specified. (You also can use
|
|---|
| 16 | other Ant loggers; see the Ant documentation for more information.)</dd>
|
|---|
| 17 | </dlentry>
|
|---|
| 18 | <dlentry>
|
|---|
| 19 | <dt>Command-line tool</dt>
|
|---|
| 20 | <dd>Status information is written to the screen and the log file. The log file name
|
|---|
| 21 | contains the input file name and transformation type; by default, it is located in the
|
|---|
| 22 | output directory. If you issue the <parmname>/logdir</parmname> parameter, you can
|
|---|
| 23 | specify a different location for where the log file is written.</dd>
|
|---|
| 24 | </dlentry>
|
|---|
| 25 | </dl></p>
|
|---|
| 26 | <!--<section><title>Analyze messages on the screen</title><p>During the building process, some information or messages occur on the screen to tell you about the status, warnings, errors, or fatal errors. You need to analyze the messages to solve the problems. <ul><li>If the build succeeded with some warning messages on the screen, it means that there are something incorrect within the user input parameters or source DITA files; but you can still get the correct output.</li><li>If the build succeeded with some error messages on the screen, it means that there are something incorrect within the user input parameters or source DITA files; the output maybe not correct.</li><li>If the build failed with fatal error message on the screen, it means that there are something illegal or invalid within the user input parameters or source DITA files; you may get no output, or wrong output.</li></ul> </p></section>-->
|
|---|
| 27 | <!--<section><title>Analyze messages in the log file</title><p>A log file in plain text format is generated in the log directory, which has a name combined with both input file name and transform type. You can open it and find more detailed information, which are helpful for solving problems. You can use the same way introduced above to analyze the messages and solve the problems.</p><p>The log directory can be specified by:</p><ul><li>using Ant, with argument <codeph>-logfile=<userinput>log-file</userinput></codeph></li><li>using command-line tool, the parameter <codeph>/logdir:<userinput>log-dir</userinput></codeph>.</li></ul></section>-->
|
|---|
| 28 | <!--<section><title>Turn on debug mode</title><p>Under debug mode, diagnostic information, such as: environment variables, stack trace, will be logged into the log file. These information can help the user or developer to go deep into the problems and find the root cause.</p><p>By default, the debug mode is disabled. To turn on the debug mode on, you need to follow the usage below: <ul><li>Append <codeph>-v</codeph> and <codeph>-Dargs.debug=yes</codeph> in Ant command.</li><li>Append <codeph>/d</codeph> or <codeph>/debug</codeph> in command-line tool.</li></ul></p></section>-->
|
|---|
| 29 | </conbody>
|
|---|
| 30 | </concept>
|
|---|
