X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/86473212afa1a64fa691d4562902e916538dd47a..1f8c95ba28a59bf8459a15c8b2d52234e577e191:/doc/index.md?ds=sidebyside diff --git a/doc/index.md b/doc/index.md index 6c08c24..09e7d7d 100644 --- a/doc/index.md +++ b/doc/index.md @@ -10,17 +10,22 @@ The table includes the following sub modules, which have their own documentation ## `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. -## `get_tz ( timezone_name )` +## `get_tz ( [timezone_name] )` Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`. -This uses the local zoneinfo database; names are usually of the form `Country/Largest_City`. +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] )` -Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone -(as a string, e.g. "America/New_York") at the given UTC time (defaults to now). +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).