Skip to content
Snippets Groups Projects
Commit b369bde0 authored by ghuter's avatar ghuter
Browse files

make the README file as complete as possible

parent 598d2f8e
No related branches found
No related tags found
4 merge requests!9fix sensor example (doc),!4Amd, Tests, Doc, CI/CD,!2build system (v0), add long options,!1build system (v0), add long options, corrections
...@@ -6,18 +6,35 @@ MojitO/S runs on GNU/Linux ...@@ -6,18 +6,35 @@ MojitO/S runs on GNU/Linux
## Usage ## Usage
```bash ```bash
Usage : mojitos [-Rsu] [-t time] [-f freq] [-p perf_list] \ Usage : mojitos [-rsu] [-t time] [-f freq] [-p perf_list] \
[-u] [-d network_device] [-o logfile] [-e command arguments...] [-d network_device] [-o logfile] [-e command arguments...]
mojitos [-l] 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 ## Installation Instructions
...@@ -88,3 +105,9 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s ...@@ -88,3 +105,9 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s
1036991.000182835 525984292 3592582 691221 1385982 272182 1036991.000182835 525984292 3592582 691221 1385982 272182
1036992.000165117 397678789 2770561 444030 1375729 510379 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">
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
.Op Fl l .Op Fl l
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .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. It runs on GNU/Linux.
.Pp .Pp
.Nm .Nm
...@@ -103,5 +103,8 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s ...@@ -103,5 +103,8 @@ $ ./mojitos -t 5 -f 1 -p cpu_cycles -r -s
.Xr lscpu 1 , .Xr lscpu 1 ,
.Xr sysfs 5 , .Xr sysfs 5 ,
.Xr proc 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 .Sh BUGS
Yes. Yes.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment