summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2018-10-11 10:14:37 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2018-10-11 10:14:37 +0200
commitee0f937a5321378ed46a51586bfa281c9a5941d7 (patch)
treeca91792e60f9dca5a623ea0422efa6beeaecfc8d /doc
parent6c568a521fbaa1b35b3f4f4711f23d828543d02f (diff)
downloaddabmux-ee0f937a5321378ed46a51586bfa281c9a5941d7.tar.gz
dabmux-ee0f937a5321378ed46a51586bfa281c9a5941d7.tar.bz2
dabmux-ee0f937a5321378ed46a51586bfa281c9a5941d7.zip
Store leap-second cache in /var/tmp
Diffstat (limited to 'doc')
-rw-r--r--doc/advanced.mux14
-rw-r--r--doc/example.mux20
2 files changed, 21 insertions, 13 deletions
diff --git a/doc/advanced.mux b/doc/advanced.mux
index a5b290d..cdc7768 100644
--- a/doc/advanced.mux
+++ b/doc/advanced.mux
@@ -375,19 +375,7 @@ outputs {
edi {
; EDI uses the UDP protocol. This implementation of EDI does not support
; EDI Packet Resend.
- ;
- ; When both EDI and TIST are enabled, ODR-DabMux will download leap-second
- ; information from the IETF website, and cache it locally in /tmp.
- ;
- ; 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
- ; and save it to
- ; /tmp/odr-dabmux-leap-seconds.cache
- ;
- ; Use the RC interface 'get clocktai expiry' command to check how long
- ; your file is still valid. Refresh the file before expiry otherwise
- ; ODR-DabMux will abort.
+ ; If TIST is enabled, requires leap-second information (see example.mux)
destinations {
; The names you give to the destinations have no meaning,
; but have to be unique. You can give them meaningful names to help
diff --git a/doc/example.mux b/doc/example.mux
index 7bd9e3e..1ecffaf 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -31,6 +31,23 @@ general {
; Enable timestamp definition necessary for SFN
; 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.
+ ;
+ ; 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
+ ; and save it to
+ ; /var/tmp/odr-dabmux-leap-seconds.cache
+ ; Refresh the file before expiry otherwise ODR-DabMux will abort!
+ ;
+ ; Use the RC interface 'get clocktai expiry' command to check how long
+ ; your file is still valid.
tist false
; The management server is a simple TCP server that can present
@@ -189,6 +206,9 @@ outputs {
; Transmit backward compatible metadata containing
; EDI time and UTC offset when TIST is enabled.
+ ;
+ ; If TIST is enabled, requires leap-second information (see example.mux)
+ ;
; WARNING! requires ODR-DabMux to be compiled with
; EDI output, and this will enable leap second download
; as for the EDI output!