mirrors/FreeRDP
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[winpr,timezone] update documentation

Browse Source
This commit is contained in:
akallabeth 2024-07-19 13:11:51 +02:00
parent 6133ee6da0
commit 8db9986a6a
No known key found for this signature in database
GPG Key ID: A49454A3FC909FD5
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/README.timezones
View File

@ -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): On an up to date windows machine run the following binary after a build with -DWITH_TIMEZONE_UPDATER=ON (from build directory):
tzextract <path to source>\winpr\libwinpr\timezone tzextract <path to source>\winpr\libwinpr\timezone