README.md

   1 # tee for Windows
   2
   3 A simple [**`tee`**](https://en.wikipedia.org/wiki/Tee_(command)) implementation for Microsoft Windows.
   4
   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>
   7
   8 ## Usage
   9
  10 ```
  11 tee for Windows
  12
  13 Copy standard input to output file(s), and also to standard output.
  14
  15 Usage:
  16   gizmo.exe [...] | tee.exe [options] <file_1> ... <file_n>
  17
  18 Options:
  19   -a --append  Append to the existing file, instead of truncating
  20   -b --buffer  Enable write combining, i.e. buffer small chunks
  21   -e --escape  Enable standard output ANSI escape code processing
  22   -f --flush   Flush output file after each write operation
  23   -i --ignore  Ignore the interrupt signal (SIGINT), e.g. CTRL+C
  24   -d --delay   Add a small delay after each read operation
  25 ```
  26
  27 ### Terminal output
  28
  29 Tee can be used as an intermediate buffer (i.e. *without* writing to a file) to greatly speed-up terminal output:
  30 ```
  31 gizmo.exe [...] | tee.exe NUL
  32 ```
  33
  34 ## Implementation
  35
  36 This is a "native" implementation of the **`tee`** command that builds directly on top of the Win32 API.
  37
  38 It uses [multi-threaded I/O and triple buffering](https://github.com/dEajL3kA/tee-win32/wiki/Multi%E2%80%90Threading) for maximum throughput.
  39
  40 ## System Requirements
  41
  42 This application requires Windows Vista or later. All 32-Bit and 64-Bit editions, including ARM64, are supported.
  43
  44 ## Website
  45
  46 Git mirrors for this project:
  47
  48 * <https://github.com/dEajL3kA/tee-win32>
  49 * <https://gitlab.com/deajl3ka1/tee-for-windows>
  50 * <https://repo.or.cz/tee-win32.git>
  51
  52 ## License
  53
  54 Copyright (c) 2024 “dEajL3kA” &lt;Cumpoing79@web.de&gt;
  55 This work has been released under the MIT license. See [LICENSE.txt](LICENSE.txt) for details!
  56
  57 ### Acknowledgement
  58
  59 Using [T-junction icons](https://www.flaticon.com/free-icons/t-junction) created by Smashicons &ndash; Flaticon.