comparison: docs/Writerside/topics/install.md
docs/Writerside/topics/install.md
- changeset 1704
- 7bc94a96a621
- parent 1555
- 8972247f54e8
equal
deleted
inserted
replaced
| 1703:bbbcf550f1ed | 1704:7bc94a96a621 |
|---|---|
| 53 For native Windows projects it is recommended to statically link UCX. | 53 For native Windows projects it is recommended to statically link UCX. |
| 54 </note> | 54 </note> |
| 55 </tab> | 55 </tab> |
| 56 </tabs> | 56 </tabs> |
| 57 | 57 |
| 58 ## Using UCX | |
| 59 | |
| 60 You can use UCX by either statically or dynamically linking the library. | |
| 61 With standard file extensions, the static library is `libucx.a` and the dynamic library is `libucx.so`. | |
| 62 In system-wide installations you usually only need to pass `-lucx` to the linker. | |
| 63 But to be sure, it is also possible to use `pkgconf` to determine the exact flags. | |
| 64 | |
| 65 ### Microsoft Windows Specific | |
| 66 | |
| 67 You need to define the `CX_WINDLL` macro during compilation of the project that is using | |
| 68 UCX as a Windows DLL to import the symbols. | |
| 69 In general, it is recommended to use UCX as a static library under Windows, though. | |
| 70 | |
| 58 ## Compile Time Options | 71 ## Compile Time Options |
| 59 | 72 |
| 60 When compiling UCX, you can tweak several compile time variables via macro definitions. | 73 When compiling UCX (not the program that is *using* UCX), |
| 74 you can tweak several compile time variables via macro definitions. | |
| 61 | 75 |
| 62 ### Features Defines | 76 ### Features Defines |
| 63 | 77 |
| 64 The following macros are not defined by default. | 78 The following macros are not defined by default. |
| 65 The effect when they are defined is described in the table. | 79 The effect when they are defined is described in the table. |
| 78 always use an own implementation. | 92 always use an own implementation. |
| 79 <tip> | 93 <tip> |
| 80 This macro is defined when you use the <code>--disable-szmul-builtin</code> | 94 This macro is defined when you use the <code>--disable-szmul-builtin</code> |
| 81 option during configuration, so you do not need to define it manually. | 95 option during configuration, so you do not need to define it manually. |
| 82 </tip> | 96 </tip> |
| 83 </td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td>CX_WINDLL</td> | |
| 87 <td> | |
| 88 Define this macro during compilation of the project that is <emphasis>using</emphasis> | |
| 89 UCX as a Windows DLL to import the symbols. | |
| 90 In general it is recommended to use UCX as a static library under Windows, though. | |
| 91 </td> | 97 </td> |
| 92 </tr> | 98 </tr> |
| 93 <tr> | 99 <tr> |
| 94 <td>CX_WINDLL_EXPORT</td> | 100 <td>CX_WINDLL_EXPORT</td> |
| 95 <td> | 101 <td> |
