From e81353b98e8dcebd1da3b5cf99118f5cf7563e8d Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Sun, 1 May 2022 23:34:28 -0700 Subject: Add markdown README. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..442ac76 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +## What is `pw`? + +`pw` stands for Pipe Watch. Pipe-Watch is a new monitoring utility for +Unix-like systems, developed starting in April 2022. + +`pw` can monitor anything that produces output. `tail -f /var/logfile`, +`tcpdump`, you name it. In particular, it's suitable when the output +is spewing at a fast rate. + +`pw` does not show you everything. Of course, it reads all the data, but it +does that in the background. It continuously pumps lines of input through a +small FIFO buffer. This buffer is sampled, and displayed. When the sampling +occurs is controlled in various ways. + +## Documentation + +The [`pw` man page](../tree/pw.1) has all the usage details. + +## Demo Video + +
-- cgit v1.2.3