From b369bde06c0d49538b72ef0cde1c8d320b1d24da Mon Sep 17 00:00:00 2001
From: ghuter <ghuter@disroot.org>
Date: Mon, 16 Jan 2023 11:26:35 +0100
Subject: [PATCH] make the README file as complete as possible
---
README.md | 37 ++++++++++++++++++++++++++++++-------
doc/mojitos.1 | 5 ++++-
2 files changed, 34 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index a344fe0..6422ce0 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,35 @@ MojitO/S runs on GNU/Linux
## Usage
```bash
-Usage : mojitos [-Rsu] [-t time] [-f freq] [-p perf_list] \
- [-u] [-d network_device] [-o logfile] [-e command arguments...]
+Usage : mojitos [-rsu] [-t time] [-f freq] [-p perf_list] \
+ [-d network_device] [-o logfile] [-e command arguments...]
mojitos [-l]
-```
-For more information, see [mojitos(1)](doc/mojitos.1) under [doc/](doc).
+ -s Enable overhead statistics (in nanoseconds).
-## License
+ -u Enable system-level load monitoring.
-MojitO/S is published under the GPL3 license and is part of the [Energumen Project](https://www.irit.fr/energumen/)
+ -r Enable RAPL.
-<img src="https://www.irit.fr/energumen/images/energumen.png" width="100">
+ -p perf_list
+ Enable performance counters. The argument is a coma separated
+ list of performance counters.
+
+ -d net_device
+ Enable network monitoring.
+
+ -l List the available performance counters and quit.
+
+ -t time
+ Set duration value (in seconds). If 0, then loops indefinitely.
+
+ -f freq
+ Set amount of measurements per second.
+
+ -e cmd ...
+ Execute a command with optional arguments. If this option is
+ used, any usage of -t or -f is ignored.
+```
## Installation Instructions
@@ -88,3 +105,9 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s
1036991.000182835 525984292 3592582 691221 1385982 272182
1036992.000165117 397678789 2770561 444030 1375729 510379
```
+
+## License
+
+MojitO/S is published under the GPL3 license and is part of the [Energumen Project](https://www.irit.fr/energumen/)
+
+<img src="https://www.irit.fr/energumen/images/energumen.png" width="100">
diff --git a/doc/mojitos.1 b/doc/mojitos.1
index 37e1876..a7927e8 100644
--- a/doc/mojitos.1
+++ b/doc/mojitos.1
@@ -17,7 +17,7 @@
.Op Fl l
.Sh DESCRIPTION
.Nm
-enables to monitor the system, its energy comsumption and the network activity, at the OS level.
+enables monitoring the system, its energy comsumption and the network activity, at the OS level.
It runs on GNU/Linux.
.Pp
.Nm
@@ -103,5 +103,8 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s
.Xr lscpu 1 ,
.Xr sysfs 5 ,
.Xr proc 5
+.Sh LICENSE
+MojitO/S is published under the GPL3 license and is part of the
+.Lk https://www.irit.fr/energumen/ [Energumen Project]
.Sh BUGS
Yes.
--
GitLab