From 8db9986a6aa1ad1c67ba2836cde2ffc857d80fff Mon Sep 17 00:00:00 2001 From: akallabeth Date: Fri, 19 Jul 2024 13:11:51 +0200 Subject: [PATCH] [winpr,timezone] update documentation --- docs/README.timezones | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/README.timezones b/docs/README.timezones index 57b2a129e..ba0f62426 100644 --- a/docs/README.timezones +++ b/docs/README.timezones @@ -1,3 +1,24 @@ +## Timezone related options + +* WITH_TIMEZONE_COMPILED Use compiled in mapping extracted with tzextract (default ON) +* WITH_TIMEZONE_FROM_FILE Use JSON file mapping generated with tzextract (default OFF) +* WITH_TIMEZONE_ICU Use ICU to map IANA to windows timezones (default OFF) +* WITH_TIMEZONE_UPDATER Build the tzextract utility (default OFF) + +### Suggested usage + +* WITH_TIMEZONE_COMPILED is suggested for single binary builds (aka fully static) binaries that + can not rely on external files to exist. +* WITH_TIMEZONE_FROM_FILE is suggested for distribution packages as this allows updating timezone + mappings without a necessary recompile of the FreeRDP binaries. Set WITH_TIMEZONE_COMPILED=OFF + in such cases as both options can be used in combination. (entries from file taking preference + over compiled in versions) +* WITH_TIMEZONE_ICU is suggested if the target is already linked against ICU. This eliminates a + required mapping table generated from WindowsZones.xml. This option is only a fallback if the + compiled in or loaded from file mappings do not match any. + +## Keeping timezone mappings up to date + On an up to date windows machine run the following binary after a build with -DWITH_TIMEZONE_UPDATER=ON (from build directory): tzextract \winpr\libwinpr\timezone