X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/1efce446b9459b475f2c8f73d9627ff75bee55c2..4c342db811aa99e6438e6dd9dff4498e1dcbd87c:/doc/gettime.md

diff --git a/doc/gettime.md b/doc/gettime.md
index 758be60..faabfb4 100644
--- a/doc/gettime.md
+++ b/doc/gettime.md
@@ -2,10 +2,22 @@
 
 A module to get the current time.
 
+Uses the most precise method available (in order:)
 
-## `gettime ( )`
+  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access
+  	  - `clock_gettime(2)` called with `CLOCK_REALTIME`
+  	  - `gettimeofday(2)`
+  - [luasocket](http://w3.impa.br/~diego/software/luasocket/)'s `socket.gettime`
+  - [`os.time`](http://www.lua.org/manual/5.2/manual.html#pdf-os.time)
 
-Uses the most precise method available (in order:)
+### `source`
+
+The library/function currently in use.
+
+### `resolution`
+
+The smallest time resolution (in seconds) available from `gettime ( )` .
+
+### `gettime ( )`
 
-  - luasocket's `socket.gettime`
-  - `os.time`
+Returns the number of seconds since unix epoch (1970-01-01T00:00:00Z) as a lua number