From 2a41abbed0dfb70447a9c83b17b6d98fcb3c65c6 Mon Sep 17 00:00:00 2001
From: Matias Linares <matiaslina@openmailbox.org>
Date: Mon, 4 Jan 2016 23:28:01 -0300
Subject: Finish struct rusage struct fields.

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 38 insertions(+), 21 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 43df49b..1d33006 100644
--- a/README.md
+++ b/README.md
@@ -4,31 +4,48 @@ Profile a single program giving stats for CPU, memory and other things (see man
 2 getrusage). The standard input is closed for the child process, so programs
 like `cat` or `xargs` can't be profiled (for now).
 
-## Example
+The following list is the data that this software can tell you (on Linux
+systems). The second list is all the features that are unmaintained for linux,
+maybe on other systems it could be useful.
+
+* user CPU time used
+* system CPU time used
+* maximum resident set size
+* page reclaims (soft page faults)
+* page faults (hard page faults)
+* block input operations
+* block output operations
+* voluntary context switches
+* involuntary context switches
+
+### Unmaintained fields
 
-    > ./profile echo hello world                                                                   
-    user CPU time used:     0 3333
-    system CPU time used:   0 0
-    residet set size used: 2336
+* integral shared memory size
+* integral unshared data size
+* integral unshared stack size
+* swaps
+* IPC messages sent
+* IPC messages received
+* signals received
 
 ## TODO
 
-* [x] user CPU time used
-* [x] system CPU time used 
-* [x] maximum resident set size 
-* [ ] integral shared memory size 
-* [ ] integral unshared data size 
-* [ ] integral unshared stack size 
-* [ ] page reclaims (soft page faults) 
-* [ ] page faults (hard page faults) 
-* [ ] swaps 
-* [ ] block input operations 
-* [ ] block output operations 
-* [ ] IPC messages sent 
-* [ ] IPC messages received 
-* [ ] signals received 
-* [ ] voluntary context switches 
-* [ ] involuntary context switches 
+* Express the CPU time on CPU cycles.
+* Check if there are another function/library that could tell us more info about
+  a child process.
+
+## Example
+
+    > ./profile thunar
+    user CPU time used:                 0s 206666us
+    system CPU time used:               0s 49999us
+    residet set size used:              35864
+    page reclaims (soft page faults):   3979
+    page faults (hard page faults):     0
+    block input operations:             0
+    block output operations:            16
+    voluntary context switches:         343
+    involuntary context switches:       26
 
 ## Copyright
 
-- 
cgit v1.2.3-70-g09d2