]>
git.madduck.net Git - etc/awesome.git/blobdiff - 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:
Requiring the base luatz module will give you a table of commonly used functions and submodules.
The table includes the following sub modules, which have their own documentation:
Requiring the base luatz module will give you a table of commonly used functions and submodules.
The table includes the following sub modules, which have their own documentation:
- - `parse` : Parses common date/time formats
- - `timetable` : Class for date/time objects supporting normalisation
+ - [`parse`](#parse) : Parses common date/time formats
+ - [`timetable`](#timetable) : Class for date/time objects supporting normalisation
+### `time()` <!-- --> {#luatz.time}
Returns the current unix timestamp using the most precise source available.
Returns the current unix timestamp using the most precise source available.
-See `gettime` for more information.
+See [`gettime`](#luatz.gettime) for more information.
+
+
+### `now()` <!-- --> {#luatz.now}
+
+Returns the current time as a timetable object
+See `timetable` for more information
-## `get_tz ( [timezone_name] )`
+### `get_tz([timezone_name])` <!-- --> {#luatz.get_tz}
Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`.
If `timezone_name` is `nil` then the local timezone is used.
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.
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])` <!-- --> {#luatz.time_in}
Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone as a string,
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).
+(same semantics as [`get_tz`](#luatz.get_tz)) at the given UTC time (defaults to now).
+
+
+### `gmtime(ts)` <!-- --> {#luatz.gmtime}
+
+As in the C standard library
+
+
+### `localtime(ts)` <!-- --> {#luatz.localtime}
+
+As in the C standard library
+
+
+### `ctime(ts)` <!-- --> {#luatz.ctime}
+
+As in the C standard library