html/menu/file-log.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <title>Log ([File] menu)</title>
    <META http-equiv="Content-Style-Type" content="text/css">
    <link rel="stylesheet" href="../style.css" type="text/css">
  </head>

  <body>
    <h1>Log ([File] menu)</h1>
    <p>
      Logs received characters to a file.<br>
      Default values can be set in <a href="setup-additional-log.html">
        [Setup] Menu / Additional settings / "Log" Tab</a>
    </p>

    <h2 id="LogStart">"Log" dialog box (to input the log file name)</h2>
    <dl>
      <dt id="FileName">File Name</dt>
      <dd>
        Enter or select the log file name.<br>
  Or drop file in this dialog.
      </dd>

      <dt id="New_Overwrite">New / Overwrite</dt>
      <dd>
  New or Overwrite file.
      </dd>

      <dt id="Append">Append</dt>
      <dd>
        If you select this option and the specified log file already exists,
        received characters are appended to the file. Otherwise, the file is
        overwritten.
      </dd>

      <dt id="Text">Text</dt>
      <dd>
        Output text file.
      </dd>

      <dt id="BOM">BOM</dt>
      <dd>
        Output BOM (Byte Oder Mark) at beginning of log file.
      </dd>

      <dt id="Code">UTF-8/UTF-16LE/UTF-16BE</dt>
      <dd>
        Select charactor code to output.
      </dd>

      <dt id="PlainText">Plain text</dt>
      <dd>
        If you select this option, ASCII non-printable characters are not written.<br>
        NOTE: When the Binary option is enabled, this option can not be checked and the value will be disabled.
      </dd>

      <dt id="Timestamp">Timestamp</dt>
      <dd>
        If you select this option, a timestamp is added on top of each log line. The timestamp is added when the first character of the line appears.<br>
        The timestamp type can be selected from following.

        <dl id="Timestamptype">
          <dt>Local Time</dt>
          <dd>
            Record the time in local time.
          </dd>

          <dt>UTC</dt>
          <dd>
            Record the time in UTC.
          </dd>

          <dt>Elapsed Time (Logging)</dt>
          <dd>
            Record the elapsed time from the start of logging.
          </dd>

          <dt>Elapsed Time (Connection)</dt>
          <dd>
            Record the elapsed time from the start of connection.
          </dd>
        </dl>
        The timestamp format is specified with <a href="../setup/teraterm-misc.html#LogTimestampFormat">LogTimestampFormat</a> when the timestamp type is "Local Time" and "UTC".<br>
        The LogTimestampFormat is ignored when the timestamp type is "Elapsed Time (Logging)" or "Elapsed Time (Connection)".<br>
        NOTE: When the Binary option is enabled, this option can not be checked and the value will be disabled.
      </dd>
    </dl>

      <dt id="Binary">Binary</dt>
      <dd>
        If you select this option, received characters are written without
        any modifications. Otherwise, new-line codes are converted and
        escape sequences are stripped out.
      </dd>

      <dt id="HideDialog">Hide dialog</dt>
      <dd>
        If you select this option, "Log" dialog box is not displayed.
      </dd>

      <dt id="LogIncludeScreenBuffer">Include screen buffer</dt>
      <dd>
        If you select this option, the logging starts after current all buffer is written into a log file.
      </dd>

    <h2 id="Logging">"Log" dialog box (displayed while logging)</h2>
    <dl>
      <dt id="Close">Close</dt>
      <dd>
        The Close button quits logging and closes the log file.
      </dd>

      <dt id="Pause">Pause/Start</dt>
      <dd>
        The Pause button pauses logging. The Start button restarts logging.
        These buttons function as toggles.
      </dd>
    </dl>
  </body>
</html>