]> git.madduck.net Git - etc/awesome.git/blob - doc/index.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: Improve get_tz documentation around timezone_name
[etc/awesome.git] / doc / index.md
1 # `luatz`
2
3 Requiring the base luatz module will give you a table of commonly used functions and submodules.
4
5 The table includes the following sub modules, which have their own documentation:
6
7   - `parse`: Parses common date/time formats
8   - `timetable`: Class for date/time objects supporting normalisation
9
10
11 ## `time ( )`
12
13 Returns the current unix timestamp using the most accurate source available.
14 See `gettime` for more information.
15
16
17 ## `get_tz ( [timezone_name] )`
18
19 Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`.
20 If `timezone_name` is `nil` then the local timezone is used.
21
22 This uses the local [zoneinfo database](https://www.iana.org/time-zones); 
23 names are usually of the form `Country/Largest_City` e.g. "America/New_York".
24 Check [wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for an example list.
25
26
27 ## `time_in ( timezone_name [, utc_ts] )`
28
29 Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone as a string,
30 (same semantics as `get_tz`) at the given UTC time (defaults to now).