diff options
| author | Kaz Kylheku <kaz@kylheku.com> | 2022-05-01 23:34:28 -0700 |
|---|---|---|
| committer | Kaz Kylheku <kaz@kylheku.com> | 2022-05-01 23:34:28 -0700 |
| commit | e81353b98e8dcebd1da3b5cf99118f5cf7563e8d (patch) | |
| tree | 1fdd1bc37fd5dad64739420568c8bb1978705ceb | |
| parent | 0f0780b0d711414ff6bd5ac484a29cf9892aa6ba (diff) | |
| download | pw-e81353b98e8dcebd1da3b5cf99118f5cf7563e8d.tar.gz pw-e81353b98e8dcebd1da3b5cf99118f5cf7563e8d.tar.bz2 pw-e81353b98e8dcebd1da3b5cf99118f5cf7563e8d.zip | |
Add markdown README.
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
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 + +<div style="padding:75% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/705257869?h=7e8d85a3c2&badge=0&autopause=0&player_id=0&app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="pipewatch-gnome-strace.mp4"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script> |