Release 1.08

Manual

@@ -1,5 +1,5 @@
 @database TimeKeeper.guide
-@$VER: TimeKeeper.guide 1.06 (2019-02-08)
+@$VER: TimeKeeper.guide 1.08 (2019-05-18)
 @(c) 2017-2019 Carsten Sonne Larsen <cs@innolan.net>
 @author Carsten Sonne Larsen
 
@@ -32,14 +32,17 @@
 @Next "Configuring the client"
 
 AmiTimeKeeper is a small program which keeps the time right on your
-machine. No installation is required.
+machine. No installation is required. It is operated as a commodity
+and is controlled by AmigaOS. An AmiTCP compatible TCP/IP stack is
+required for AmiTimeKeeper to work.
 
-AmiTimeKeeper is operated as a commodity and is controlled by AmigaOS.
-An AmiTCP compatible TCP/IP stack is required for AmiTimeKeeper to work.
+Several settings determine the behaviour. The settings are passed
+either directly from the command line or by using the tool types of
+an icon. Preferences can also be saved between reboots.
 
-AmiTimeKeeper can be configured through several settings. This can be
-done either directly from the command line or by using the tooltypes
-of an icon. Preferences can also be saved between reboots.
+The local time zone needs to be configured using Workbench preferences
+or a similar tool. in regular AmigaOS this is available through the
+Locale Preferences Editor.
 
 @{"Configuring the client" Link "Configuring the client"}
 @{"Using tooltypes of an icon" Link "Using tooltypes of an icon"}
@@ -54,7 +57,7 @@ of an icon. Preferences can also be saved between reboots.
 @Toc "Main"
 @Prev "Main"
 @Next "Using tooltypes of an icon"
-@{b}Server Address@{ub}
+@{b}Server address@{ub}
 
 NTP servers are managed by several organizations. The pool.ntp.org
 project and Network Time Foundation are probably the two most famous.
@@ -72,7 +75,10 @@ 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/
 
-@{b}Server Port@{ub}
+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.
+
+@{b}Server port@{ub}
 
 NTP servers use port 123 as default. Only under special circumstances
 are the NTP server port different from 123.
@@ -88,7 +94,7 @@ The requests are sent in certain intervals defined by the interval
 parameter. The interval should be specified using milliseconds. One
 thousand (1.000) milliseconds are equal to one second.
 
-@{b}Threshold@{ub}
+@{b}Adjustment threshold@{ub}
 
 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 from the NTP
@@ -97,13 +103,20 @@ The amount of accepted inaccuracy is set using the threshold parameter.
 The threshold should be specified using microsecond. One million
 microseconds (1.000.000) are equal to one second.
 
-@{b}Read Only@{ub}
+@{b}Read only@{ub}
 
 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.
 
-@{b}Connection Timeout@{ub}
+@{b}Expert mode@{ub}
+
+Advanced settings are hidden from the settings windown when expert mode
+is not enabled. The advanced settings are server port, interval between
+requests, adjustment threshold, connection timeout, verbosity level and
+commodity priority.
+
+@{b}Connection timeout@{ub}
 
 In some cases, a connection to the NTP server cannot be established or
 the NTP server simply does respond. To avoid an infinitive wait for a
@@ -111,7 +124,7 @@ response the connection will instead make a time out. The timeout
 interval should be specified using milliseconds. One thousand (1.000)
 milliseconds are equal to one second.
 
-@{b}Verbosity@{ub}
+@{b}Verbosity level@{ub}
 
 The level of logging can be adjusted from none to all. Expressed as a
 numeric value verbose can be 0, 1, 2 or 3, where 0 is equal to none and
@@ -138,13 +151,16 @@ The available tooltypes are the same as the available command line
 parameters.
 
 @{b}Parameter@{ub}   | @{b}Short description@{ub}
------------------------------------------
-SERVER      | Server Address
-PORT        | Server Port
+-------------------------------------------------
+SERVER      | NTP server Address
+PORT        | NTP server Port
 THRESHOLD   | Adjustment threshold
 INTERVAL    | Interval between requests
+CX_POPUP    | Show settings window on startup
+CX_POPKEY   | Settings window keyboard shortcut
 CX_PRIORITY | Commodity priority
-READONLY    | Read only option
+READONLY    | Do not set clock
+EXPERT      | Show advanced options
 TIMEOUT     | Connection Timeout
 VERBOSE     | Log verbosity
 LOGFILE     | Log file location
@@ -153,11 +169,13 @@ LOGFILE     | Log file location
 
 Settings can be overridden and are set in the following order:
 1. Preference file
-2. Icon tooltypes
-3. CLI parameters
+2. Icon tooltypes / CLI parameters
 
-CLI parameters has highest precedence and will always override settings
-from icon tooltypes and from the preference file.
+CLI parameters and icon tooltypes has highest precedence and will
+always override settings from the preference file.
+
+Settings from icon tooltypes are used when starting from Workbench.
+Settings from CLI are used only when starting from shell.
 
 @EndNode
 
@@ -174,6 +192,8 @@ ENVARC:timekeeper.prefs
 
 Depending on the setup the content of timekeeper.prefs could be:
 
+CX_POPUP=NO
+CX_POPKEY=lshift control t
 CX_PRIORITY=25
 THRESHOLD=1000000
 SERVER=de.pool.ntp.org
@@ -181,7 +201,8 @@ PORT=123
 TIMEOUT=5000
 INTERVAL=17500
 VERBOSE=3
-READONLY=0
+READONLY=NO
+EXPERT=NO
 LOGFILE=RAM:log
 
 The preference file should not be edited under normal circumstances.
@@ -189,7 +210,7 @@ The preference file should not be edited under normal circumstances.
 @{b}Caveats@{ub}
 
 If LOGFILE is set in the preference file, no messages will be emitted
-to screen (unless overridden by CLI or Icon tooltype with LOGFILE=NO).
+to screen (unless overridden by CLI or icon tooltype with LOGFILE=NO).
 
 @EndNode
 
@@ -198,10 +219,29 @@ to screen (unless overridden by CLI or Icon tooltype with LOGFILE=NO).
 @Prev "Saving preferences"
 @Next "Software License"
 
+Version 1.05, dated 06.08.2018, has proved itself to be a stable version
+and has been promoted to Long Term Support. It is distributed along with
+the latest version of AmiTimeKeeper.
+
+A custom build version has been integrated into the Icaros Desktop system.
+The author encourages all developers with an interest to make their own
+build.
+
+@{b}v1.08 18.05.2019@{ub}
+  - When using pool server cycle with prefix 0 to 3
+  - Display of wrong signes in time zone fixed
+  - Faulty log messages about settings fixed
+  - Timer bug causing infitive loop fixed
+  - Memory leak in settings window fixed
+
+@{b}v1.07 15.02.2019@{ub}
+  - Support commodity hotkey and popup options
+  - Hide advanced settings with new expert option
+
 @{b}v1.06 08.02.2019@{ub}
   - Adjust layout in settings window
 
-@{b}v1.05 06.08.2018@{ub}
+@{b}v1.05 06.08.2018 LTS@{ub}
   - Preferences can now be saved from settings window
   - Time zone is shown as UTC offset in settings window
   - Running multiple instances no longer create zombie processes