rainlance/AmiTimeKeeper
1
0
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity

Update headers

Carsten Sonne Larsen
2021-01-31 21:30:23 +01:00
parent c0122a0f20
commit 68804c4762
7 changed files with 61 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
ARexx-interface.md

@ -1,3 +1,5 @@
# ARexx Interface
TimeKeeper provides an ARexx port with a diverse set of commands.
The ARexx address is `TIMEKEEPER.1`
@ -19,13 +21,13 @@ The ARexx address is `TIMEKEEPER.1`
| SHUTDOWN | Shutdown TimeKeeper |
| LOGTRANS | Emit time zone transition map to log |
**Parameters**
## Parameters
`STATUS` accepts `NUMBER` as parameter. Result is instead formatted
as binary value.
`TIMEZONE` accepts a code as parameter. The code determines how
the result is formatted:
the result is formatted.
| Code | Description |
| ---- | ----------------------------------------------|
@ -46,6 +48,10 @@ the result is formatted:
`RFC1123`, `RFC2822`, `RFC3339` or `ISO8601` as first parameter. `DOS` is
assumed if parameter is not specified.
`LOCAL` and `UTC` are accepted as second parameter. `LOCAL` is assumed
if second parameter is not specified. `RFC850` and `RFC1123` are always
GMT.
| Style | Description |
| ------- | ------------------------------- |
| `DOS` | AmigaDOS style |
@ -53,10 +59,6 @@ assumed if parameter is not specified.
| `DATE` | ARexx formatted as sorted date |
| `TIME` | Time in seconds since midnight |
`LOCAL` and `UTC` are accepted as second parameter. `LOCAL` is assumed
if second parameter is not specified. `RFC850` and `RFC1123` are always
GMT.
`GET` accepts `SERVER`, `PORT`, `THRESHOLD`, `INTERVAL`, `CX_PRIORITY`,
`CX_POPKEY`, `CX_POPUP`, `READONLY`, `EXPERT`, `TIMEOUT`, `ACTIVE`, `NOLOG`,
`TZD`, `TZ`, `TZNAME`, `TZVALUE` and `TZDST` as parameter. `CX_POPUP`,
@ -68,7 +70,7 @@ addition value parameter.
`ID`, `VERSION`, `HELP`, `SHOW`, `HIDE`, `START`, `STOP`, `SHUTDOWN` and `LOGTRANS`
does not accept parameters.
**Error handling**
## Error Handling
The local variables `TIMEKEEPER.ERRORCODE` and `TIMEKEEPER.ERRORTEXT`
are set on each call too ARexx.
@ -87,7 +89,7 @@ There is a number of possible error codes.
| 20 | Synchronization is already active |
| 21 | Synchronization is already deactivated |
**Examples**
## Examples
Stop the the time synchronization process with:
> Address TIMEKEEPER.1 stop

40
Configuring-the-client.md

@ -1,4 +1,6 @@
**Server address**
## Configuring The Client
## Server Address
NTP servers are managed by several organizations. The pool.ntp.org
project and Network Time Foundation are probably the two most famous.
@ -13,18 +15,18 @@ Zones also exists for countries. To use a server in for example Germany
the server address should be set to de.pool.ntp.org. For Switzerland
the address should be ch.pool.ntp.org.
Network Time Foundation has a website on http://support.ntp.org/
The pool.ntp.org project website is located at https://www.ntppool.org/
Network Time Foundation has a website on <http://support.ntp.org/>
The pool.ntp.org project website is located at <https://www.ntppool.org/>
Pool server addresses will automatically be prefixed with 0, 1, 2 or 3
in order to lower the risk of choosing a none-responsive server.
**Server port**
## Server Port
NTP servers use port 123 as default. Only under special circumstances
is the NTP server port different from 123.
**Interval between requests**
## Interval Between Requests
The Amiga hardware clock will slowly drift away from true time. The
drift is determined by several factors and is small, but the drift
@ -37,7 +39,7 @@ parameter. The interval should be specified using milliseconds. One
thousand (1.000) milliseconds are equal to one second. The max value
is 172.800.000 equal to 48 hours.
**Adjustment threshold**
## Adjustment Threshold
Due to the accuracy of NTP servers and the nature of Amiga CPUs
it does not make sense to adjust the Amiga clock on every response
@ -47,20 +49,20 @@ threshold parameter. The threshold should be specified using micro-
seconds. One million microseconds (1.000.000) are equal to one
second.
**Read only**
## Read Only
It is possible to send request to the NTP server without setting the
Amiga hardware clock. This option can be handy when debugging time
zone setup and other time related parameters.
**Expert mode**
## Expert Mode
Advanced settings are hidden from the settings window when expert
mode is not enabled. The advanced settings are server port, interval
between requests, adjustment threshold, connection timeout, verbosity
level and commodity priority.
**Connection time out**
## Connection Timeout
In some cases, a connection to the NTP server cannot be established
or the NTP server simply does respond. To avoid an infinitive wait
@ -69,48 +71,48 @@ timeout interval should be specified using milliseconds. One thousand
(1.000) milliseconds are equal to one second. The max value is half
of the value of interval between requests.
**Logging**
## Logging
It is possible view log messages using the supplied tool @{i}TimeLogger@{ui}.
The logger facility can be turned off with the NOLOG switch.
It is possible view log messages using the supplied tool `TimeLogger`.
The logger facility can be turned off with the `NOLOG` switch.
**Automatically synchronization**
## Automatically Synchronization
Sometimes it is feasible to start without synchronization. The clock
is synchronized in the background, only when synchronization is
active. By default synchronization is not active.
**Time zone display**
## Time Zone Display
Different options for displaying the current time zone exists. The
most common is a combination of time zone name and time zone offset
from GMT. The ARexx documentation describes the time zone display
methods in details.
**Time zone**
## Time Zone
If the local time zone is expressed as a POSIX TZ compatible string,
an optional setting is available.
**Time zone value**
## Time Zone Value
The most simple way to expressed the local time zone is in hours
and minutes from Greenwich Mean Time (GMT) or UTC. One hour ahead
is equal to 100. One hour behind is equal to -100. Two and a half
hour ahead is equal to 230.
**Time zone abbreviation**
## Time Zone Abbreviation
If no name is given for the local time zone, the time zone is shown
as hours and minutes from Greenwich Mean Time (GMT). It is possible
to specify a time zone abbreviation for better readability.
**Daylight saving time**
## Daylight Saving Time
Sometimes is feasible to force a standard one hour ahead daylight
saving time (DST). Use this option if needed.
**Caveats**
## Caveats
TimeKeeper does not start as a background process. When started in
the startup-sequence it will by default block execution. Use the run

2
Control-utility.md

@ -1,3 +1,5 @@
# Control Utility
Controlling TimeKeeper without using ARexx is done through the
control utility `TimeCtrl`. The following commands are available.

1
Introduction.md

@ -1,3 +1,4 @@
# Introduction
AmiTimeKeeper is a small program which keeps the time right on
your machine. No installation is required. It is operated as a

20
Local-time-zone.md

@ -1,29 +1,37 @@
**Selecting time zone**
# Local Time Zone
## Selecting Time Zone
The local time zone is selected from 5 different options, in
the following order:
1. TZVALUE setting
2. TZ setting
3. Global TZ environment variable
4. Global TZONE environment variable
5. Workbench Locale Preferences
**TZVALUE setting**
## TZVALUE Setting
The local time zone value setting is available from CLI, icon
tool types and ARexx. The value is specified in hours and minutes
from GMT or UTC. One hour ahead is equal to 100. One hour
behind is equal to -100.
**TZ setting**
## TZ setting
The TZ setting is available from CLI, icon tool types and ARexx.
**Global TZ environment variable**
## Global TZ environment variable
The Amiga DOS global environment variable TZ containing a POSIX
TZ compliant string.
**Global TZONE environment variable**
## Global TZONE environment variable
The Amiga DOS environment global variable TZONE containing a
POSIX TZ compliant string.
**Workbench Locale Preferences**
## Workbench Locale Preferences
Amiga OS / Workbench Locale Preferences Editor

8
Saving-preferences.md

@ -1,12 +1,14 @@
# Saving Preferences
Preferences are saved in the file:
`ENV:AmiTimeKeeper/timekeeper.prefs`
Preferences are also persisted between reboots in the file:
`ENVARC:AmiTimeKeeper/timekeeper.prefs`
Depending on the setup the content of timekeeper.prefs could be:
Depending on the setup the content of `timekeeper.prefs` could be:
```
```sh
CX_POPUP=NO
CX_POPKEY=lshift control t
CX_PRIORITY=5
@ -23,7 +25,7 @@ NOLOG=YES
The preference file should not be edited under normal circumstances.
**Caveats**
## Caveats
Not only visible settings in the settings window are saved to the
preference file. All setting are saved includes default settings

7
The-POSIX-TZ-environment-variable.md

@ -1,3 +1,5 @@
# POSIX TZ Environment Variable
This is a list of time zone information for locations around the globe.
Information is represented in the POSIX TZ environment variable format.
The list originates from the IANA time zone database version 2019b.
@ -21,7 +23,10 @@ Set the TZ environment variable for Paris:
Save the TZ environment to the current system disk:
> COPY ENV:TZ ENVARC:TZ
```
## TZ Values
```sh
Africa/Abidjan TZ GMT0
Africa/Accra TZ GMT0