Readlog Command-Line Options (Windows CE 5.0)

  • Article

Send Feedback

The Readlog Viewing Tool (Readlog.exe) is a command-line tool that converts the binary .clg log file created by CeLog event tracking into text (.txt) and other formats.

Readlog command-line options allow you to control the Readlog output in two ways.

  • Print options generate output in text (.txt) format.
  • Utility options generate a new CeLog file. Read this file by running the Readlog tool again on the new output.

The following code example shows the Readlog syntax:

readlog [ PrintOptions | UtilityOptions ] InfileOutfile

Parameters

  • InFile
    Specifies the name of the CeLog (.clg) file to read.

  • OutFile
    For print options, specifies the name of the text file to generate.

    For utility options, specifies the name of the new .clg log file.

  • PrintOptions
    Specifies formatting options for output in text file format. The following table describes the Readlog command-line print options.

    For detailed information about the Readlog print options, see Remarks**.**

  • UtilityOptions
    Specifies formatting options for output in CeLog format. For detailed information about the Readlog utility options, see Remarks**.**

Remarks

The following table provides detail about the Readlog print options.

Print option Description
-v Prints verbose information.
-s Print summary of logged events. If a range is provided, the summary includes only events in the range.

For more information, see Creating a Log Summary.
-d Prints timestamps as the length of time elapsed since the last event, rather than absolute times.
-u Prints Unicode output.
-e Prints timestamps as comma delimited number of microseconds, which are readable in Excel.
-ids Prints IDs for all events.

For more information, see Working with Event Ranges in Readlog.
-range <ID1><ID2> Prints only events from <ID1> to <ID2>, inclusive.

For more information, see Working with Event Ranges in Readlog.
-f <parameter> Filters out selected events, which are specified using additional parameters. The default setting is no filtering. Parameters are case-sensitive.

For more information, see Creating and Using Custom Filters With Readlog.

The following list shows specific pre-defined filters you can apply.

  • -f T
    Filters out thread, reschedule, migrate, and priority-invert events.
  • -f P
    Filters out process events.
  • -f I
    Filters out Interrupt events.
  • -f K
    Filters out KCALL entry and exit events.
  • -f M
    Filters out memory tracking events such as heap allocations, reallocations, and frees.
  • -f C
    Filters out critical section events.
  • -f S
    Filters out synchronization objects such as semaphores, mutexes, and events.
  • -f X
    Filters out all system events. This has the same effect as using the TPIKMCS flags in a command.

The following table shows detailed descriptions of the Readlog utility options.

Utility option Description
-sync Generates a new CeLog file with a sync header at the top.

This parameter is most useful for producing log files that are readable to the Remote Kernel Tracker tool.
-fixtime Generates a new CeLog file where the timestamp does not roll over.
-fixthreads Generates a new CeLog file with fixed thread names.

For more information, see Fixing Thread Names With Readlog.
-plugin Generates a new CeLog file with plugin string replacements.

For more information, see Writing A Readlog Extension To View Custom Events.
-copy Generates a new CeLog file with data from events flagged with the -range parameter only.

For more information, see Creating a New Binary Log File with Events in a Range.

Examples

  • The following code example shows a Readlog conversion of Celog.clg data into text without any filters enabled.

    readlog celog.clg output.txt

  • The following code example shows a Readlog conversion of Celog.clg data into text with the -sync option enabled. Note that this example requires two command-line sequences: the first sequence uses a utility option to output a .clg log file, the second sequence uses a print option to output a .txt file.

    readlog -sync celog.clg new.clg
readlog new.clg output.txt

  • The following code example shows a Readlog conversion of Celog.clg data into text with several filters enabled. These filter settings remove KCALL, memory tracking, critical section, and synchronization events from the converted data, and then write it to Output.txt.

    readlog -f KMCS celog.clg output.txt

See Also

Remote Kernel Tracker

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.