aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2022-09-14 15:54:37 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2022-09-14 15:54:37 -0400
commit7971cc02be59a7d9115a8e436474433807588c6c (patch)
tree4376277edec4dfe00599c4a8a17e316b287a4778 /README.md
downloadmstat-7971cc02be59a7d9115a8e436474433807588c6c.tar.gz
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a9a1943
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# MSTAT
+
+Record the memory usage of a process over time.
+
+# How to use MSTAT
+
+```shell
+mstat <pid_here>
+```
+
+## Plotting
+
+Requires `gnuplot` to be installed
+
+```shell
+mstat_plot <pid_here>.mstat
+```
+
+## CSV export
+
+```shell
+mstat_export <pid_here>.mstat > data.csv
+```
+