Updated README file.
[tee-win32.git] / README.md
bloba0c5b2eb7571e041431781fa1edf044d0d07c926
1 # tee for Windows
3 A simple [**`tee`**](https://en.wikipedia.org/wiki/Tee_(command)) implementation for Microsoft Windows.
5 ![tee](etc/images/tee.png)  
6 <small>(image created by [Sven](https://commons.wikimedia.org/wiki/User:Sven), CC BY-SA 4.0)</small>
8 ## Usage
10 ```
11 tee for Windows
13 Copy standard input to output file(s), and also to standard output.
15 Usage:
16   gizmo.exe [...] | tee.exe [options] <file_1> ... <file_n>
18 Options:
19   -a --append  Append to the existing file, instead of truncating
20   -f --flush   Flush output file after each write operation
21   -i --ignore  Ignore the interrupt signal (SIGINT), e.g. CTRL+C
22 ```
24 ## Implementation
26 This is a "native" implementation of the **`tee`** command that builds directly on top of the Win32 API.
28 It uses multi-threaded processing and double buffering for maximum throughput.
30 ## System Requirements
32 This application requires Windows Vista or later. All 32-Bit and 64-Bit editions, including ARM64, are supported.
34 ## License
36 Copyright (c) 2023 “dEajL3kA” &lt;Cumpoing79@web.de&gt;  
37 This work has been released under the MIT license. See [LICENSE.txt](LICENSE.txt) for details!
39 ### Acknowledgement
41 Using [T-junction icons](https://www.flaticon.com/free-icons/t-junction) created by Smashicons &ndash; Flaticon.