luatz/gettime: Use lunix if available

[etc/awesome.git] / doc / gettime.md

diff --git a/doc/gettime.md b/doc/gettime.md
index 2e3ef354417693ea76523c800c4c7de25586d9ba..355057773d48d2b91ed282e3f635faca37cb2dfb 100644 (file)
--- a/doc/gettime.md
+++ b/doc/gettime.md
@@ -1,23 +1,27 @@
-# `luatz.gettime`
+## `luatz.gettime` <!-- --> {#gettime}
 
 A module to get the current time.
 
 Uses the most precise method available (in order:)
 
-  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access
-         - `clock_gettime(2)` called with `CLOCK_REALTIME`
-         - `gettimeofday(2)`
+  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access `clock_gettime(2)` called with `CLOCK_REALTIME`
+  - [lunix](http://25thandclement.com/~william/projects/lunix.html)'s `unix.clock_gettime()` (Only on non-Apple systems)
+  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access `gettimeofday(2)`
+  - [lunix](http://25thandclement.com/~william/projects/lunix.html)'s `unix.gettimeofday()`
   - [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)
+  - [Openresty](http://openresty.org/)'s [`ngx.now`](http://wiki.nginx.org/HttpLuaModule#ngx.now)
+  - [`os.time`](http://www.lua.org/manual/5.3/manual.html#pdf-os.time)
 
-## `source`
+### `source` <!-- --> {#gettime.source}
 
-The library/function currently in use.
+The library/function currently in use by [`gettime()`](#gettime.gettime).
 
-## `resolution`
 
-The smallest time resolution (in seconds) available from `gettime ( )` .
+### `resolution` <!-- --> {#gettime.resolution}
 
-## `gettime ( )`
+The smallest time resolution (in seconds) available from [`gettime()`](#gettime.gettime).
+
+
+### `gettime()` <!-- --> {#gettime.gettime}
 
 Returns the number of seconds since unix epoch (1970-01-01T00:00:00Z) as a lua number