README: Add Installation instructions

[etc/awesome.git] / luatz / init.lua

diff --git a/luatz/init.lua b/luatz/init.lua
index 1f223d10c9022916ebcc4d059c8a049de848f8af..923e4d6047fc1273b6b2614aaf5dac2b738a026e 100644 (file)
--- a/luatz/init.lua
+++ b/luatz/init.lua
@@ -1,12 +1,35 @@
-local get_tz = require "luatz.tzcache".get_tz
+local _M = {
+       gettime = require "luatz.gettime" ;
+       parse = require "luatz.parse" ;
+       strftime = require "luatz.strftime" ;
+       timetable = require "luatz.timetable" ;
+       tzcache = require "luatz.tzcache" ;
+}
+
+--- Top-level aliases for common functions
+
+_M.time = _M.gettime.gettime
+_M.get_tz = _M.tzcache.get_tz
 
-local function gettimein ( tz , now )
-       return get_tz ( tz ):localize ( now )
+--- Handy functions
+
+_M.time_in = function ( tz , now )
+       return _M.get_tz ( tz ):localize ( now )
 end
 
-return {
-       get_tz    = get_tz ;
-       gettime   = require "luatz.gettime".gettime ;
-       gettimein = gettimein ;
-       timetable = require "luatz.timetable" ;
-}
+--- C-like functions
+
+_M.gmtime = function ( ts )
+       return _M.timetable.new_from_timestamp ( ts )
+end
+
+_M.localtime = function ( ts )
+       ts = _M.time_in ( nil , ts )
+       return _M.gmtime ( ts )
+end
+
+_M.ctime = function ( ts )
+       return _M.strftime.asctime ( _M.localtime ( ts ) )
+end
+
+return _M