X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/7fe56712a4d4338cfb23d13e1ec3c6264a3e450e..da2aacaa8924d93ed7f80b167036e162e4d4e110:/doc/index.md?ds=sidebyside diff --git a/doc/index.md b/doc/index.md index d12f09b..e0ece6a 100644 --- a/doc/index.md +++ b/doc/index.md @@ -8,23 +8,39 @@ The table includes the following sub modules, which have their own documentation - `timetable`: Class for date/time objects supporting normalisation -## `time ( )` +### `time ( )` -Returns the current unix timestamp using the most accurate source available. +Returns the current unix timestamp using the most precise source available. See `gettime` for more information. +### `now ( )` -## `get_tz ( [timezone_name] )` +Returns the current time as a timetable object +See `timetable` for more information + + +### `get_tz ( [timezone_name] )` Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`. If `timezone_name` is `nil` then the local timezone is used. +If `timezone_name` is an absolute path, then that `tzinfo` file is used This uses the local [zoneinfo database](https://www.iana.org/time-zones); names are usually of the form `Country/Largest_City` e.g. "America/New_York". Check [wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for an example list. -## `time_in ( timezone_name [, utc_ts] )` +### `time_in ( timezone_name [, utc_ts] )` Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone as a string, (same semantics as `get_tz`) at the given UTC time (defaults to now). + + +## As in the C standard library + +### `gmtime ( ts )` + +### `localtime ( ts )` + +### `ctime ( ts )` +