summaryrefslogtreecommitdiffstats
path: root/doc/example.mux
diff options
context:
space:
mode:
Diffstat (limited to 'doc/example.mux')
-rw-r--r--doc/example.mux19
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/example.mux b/doc/example.mux
index 9a5686b..383a2ab 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -36,18 +36,21 @@ general {
; This also enables time encoding using the MNSC.
;
; When TIST is enabled, and either EDI or a ZMQ output with metadata is used,
- ; ODR-DabMux will download leap-second information from the IETF website,
- ; and cache it locally in /var/tmp. It will refresh the data by itself
- ; before it expires.
+ ; ODR-DabMux will download the leap-second information bulletin,
+ ; and cache it locally in /var/tmp.
+ ; It will refresh the bulletin by itself before it expires. If that fails,
+ ; ODR-DabMux will continue running with the current TAI-UTC clock offset.
;
; If it cannot load this information, ODR-DabMux cannot start up!
;
; If your system doesn't have access to internet, you have to take care
; to create the file before ODR-DabMux startup. Get it from
- ; http://www.ietf.org/timezones/data/leap-seconds.list
+ ; https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list
; and save it to
; /var/tmp/odr-dabmux-leap-seconds.cache
- ; Refresh the file before expiry otherwise ODR-DabMux will abort!
+ ;
+ ; ODR-DabMux will start up even with an expired bulletin in cache, but will
+ ; output a warning.
;
; Use the RC interface 'get clocktai expiry' command to check how long
; your file is still valid.
@@ -60,7 +63,11 @@ general {
; The URLs used to fetch the TAI bulletin can be overridden if needed.
; URLs are given as a pipe-separated list, and the default value is:
- ;tai_clock_bulletins "https://www.ietf.org/timezones/data/leap-seconds.list|https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list"
+ ;tai_clock_bulletins "https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list"
+ ;
+ ; Through RC, use `set clocktai url <LIST_OF_URLS>` to change the URLs used to download the bulletin
+ ; during runtime.
+ ; You may also override the bulletin using `set clocktai tai_utc_offset 37` to set a TAI-UTC offset manually.
;
; You may also use a file:// URL if you take care of updating the file
; yourself and store it locally.