aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2023-02-12 17:26:31 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2023-02-12 17:26:31 -0500
commit2fb1839b7cb30fe4710677d9e78e84b5bc97d9f7 (patch)
tree9204ceb4c6d4143ef991ef31135c3333af6dbfe0 /README.md
parentddc018b7860211b250ecd5ca80912497e09f1d36 (diff)
downloadmstat-2fb1839b7cb30fe4710677d9e78e84b5bc97d9f7.tar.gz
More stdout message modification
* Clear terminal (if possible) and pretty print all fields for each sample * Clean up usage statement(s) * mstat_find_program returns absolute path of "name" on success if "name" begins with "./" * Zero option structure(s) at runtime
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/README.md b/README.md
index b6f011a..0fe45b5 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,12 @@ Record the memory usage of a process over time.
```text
usage: mstat [OPTIONS] [-p PID] | {PROGRAM... ARGS}
--c clobber 'PID#.mstat' if it exists
--h this help message
--o DIR path to output directory (must exist)
--p PID process id to monitor
--s RATE samples per second (default: 1.00)
--v increased verbosity
+ -c clobber 'PID#.mstat' if it exists
+ -h this help message
+ -o DIR path to output directory (must exist)
+ -p PID process id to monitor
+ -s RATE samples per second (default: 1.00)
+ -v increased verbosity
```
## Monitor an existing process
@@ -47,6 +47,15 @@ Requires `gnuplot` to be installed.
- Arch Linux
- `pacman -S gnuplot`
+```text
+usage: mstat_plot [OPTIONS] {FILE}
+ -f NAME[,...] mstat field(s) to plot (default: rss,pss,swap)
+ -h this help message
+ -l list mstat fields
+ -v verbose mode
+```
+
+### Render
```shell
$ mstat_plot 12345.mstat