diff -r bbbcf550f1ed -r 7bc94a96a621 docs/Writerside/topics/install.md --- a/docs/Writerside/topics/install.md Wed Jan 21 22:39:04 2026 +0100 +++ b/docs/Writerside/topics/install.md Wed Jan 21 22:47:18 2026 +0100 @@ -55,9 +55,23 @@ +## Using UCX + +You can use UCX by either statically or dynamically linking the library. +With standard file extensions, the static library is `libucx.a` and the dynamic library is `libucx.so`. +In system-wide installations you usually only need to pass `-lucx` to the linker. +But to be sure, it is also possible to use `pkgconf` to determine the exact flags. + +### Microsoft Windows Specific + +You need to define the `CX_WINDLL` macro during compilation of the project that is using +UCX as a Windows DLL to import the symbols. +In general, it is recommended to use UCX as a static library under Windows, though. + ## Compile Time Options -When compiling UCX, you can tweak several compile time variables via macro definitions. +When compiling UCX (not the program that is *using* UCX), +you can tweak several compile time variables via macro definitions. ### Features Defines @@ -83,14 +97,6 @@ - CX_WINDLL - - Define this macro during compilation of the project that is using - UCX as a Windows DLL to import the symbols. - In general it is recommended to use UCX as a static library under Windows, though. - - - CX_WINDLL_EXPORT Define this macro during compilation of UCX to export symbols for a Windows DLL.