]> 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:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
README: Add feature list, Usage section
[etc/awesome.git] / doc / gettime.md
diff --git a/doc/gettime.md b/doc/gettime.md
index 758be60393f9f1656a79a5b194fa47a6dd2476a3..faabfb417445f13b85c2bd281f2c8fb04e767dbe 100644 (file)
--- 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
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.