wtf/_site/content/posts/modules/clocks.md

title, date, draft

title	date	draft
Modules: Clocks	2018-05-07T19:47:31-07:00	false

Displays a configurable list of world clocks, the local time, and date.

Source Code

wtf/clocks/

Required ENV Variables

None.

Keyboard Commands

None.

Configuration

clocks:
  colors:
    rows:
      even: "lightblue"
      odd: "white"
  enabled: true
  locations:
    # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    Avignon: "Europe/Paris"
    Barcelona: "Europe/Madrid"
    Dubai: "Asia/Dubai"
    UTC: "Etc/UTC"
    Vancouver: "America/Vancouver"
    Toronto: "America/Toronto"
  position:
    top: 4
    left: 0
    height: 1
    width: 1
  refreshInterval: 15
  # Valid options are: alphabetical, chronological
  sort: "alphabetical"

Attributes

colors.rows.even
The foreground color for even-numbered rows.
Values: Any X11 color name.

colors.rows.odd
The foreground color for the odd-numbered rows.
Values: Any X11 color name.

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

locations
Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name.
Values: Any TZ database timezone.

position
Defines where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

sort
Defines the display order of the clocks in the widget.
Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.