]> git.madduck.net Git - etc/awesome.git/blobdiff - doc/gettime.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

doc/index.md: Fix internal link
[etc/awesome.git] / doc / gettime.md
index 0457855cdcf384cd0ffc760ff0082f1f2fa0c1b6..355057773d48d2b91ed282e3f635faca37cb2dfb 100644 (file)
@@ -1,24 +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`
   - [Openresty](http://openresty.org/)'s [`ngx.now`](http://wiki.nginx.org/HttpLuaModule#ngx.now)
-  - [`os.time`](http://www.lua.org/manual/5.2/manual.html#pdf-os.time)
+  - [`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