Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ptvty authored Mar 29, 2024
1 parent c2ae50b commit d05547d
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Windows File Read Events

A Windows CLI utility to watch the file system for file *read* events.

It writes to the console the file path along with the offset and IO size in bytes.

## Usage

To watch a specific file:

WinFileReadEvents.exe C:\test\target.txt

Or without any argument to watch system-wide:

WinFileReadEvents.exe

Press `ctrl+c` to stop watching.

## Output format

Outputs to the stdout any file read event including the file path, along with the offset and read size in the following format:

>|<offset>|<io_size>|<file_path>

In case of an error, a line will be written to the stdout in the following format:

x|<error_message>

This utility uses Event Tracing for Windows (ETW) via [`Microsoft.Diagnostics.Tracing.TraceEvent`](https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.TraceEvent/) package.

0 comments on commit d05547d

Please sign in to comment.