aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 442ac76..40644a7 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
`pw` stands for Pipe Watch. Pipe-Watch is a new monitoring utility for
Unix-like systems, developed starting in April 2022.
+Scroll down for a demo video.
+
`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.
@@ -12,6 +14,16 @@ 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.
+`pw` is a little over 1200 lines of code, all in one source file, compiling to
+a tiny executable. It depends on no libraries other than the POSIX standard
+functions; all terminal control is via ANSI sequences. It does like to have a
+`struct winsize` and an `ioctl` to fill it in. Since it only retains the last
+portion of the real-time input, it doesn't need a lot of memory. There is
+a seven line GNU Makefile to build it. If that doesn't work for you, try it
+some other way. It tested it on on Solaris 10, and older Mac OS, Cygwin and a
+few GNU/Linuxes. It built on OpenBSD, but didn't run properly; I didn't
+investigate into it. Patches welcome.
+
## Documentation
The [`pw` man page](../tree/pw.1) has all the usage details.