comparison: docs/Writerside/topics/install.md
docs/Writerside/topics/install.md
- branch
- docs/3.1
- changeset 1182
- 3ce4a58a3eea
- parent 1173
- 99fc65d2d22b
equal
deleted
inserted
replaced
| 1175:453a45647a32 | 1182:3ce4a58a3eea |
|---|---|
| 9 | 9 |
| 10 <tabs> | 10 <tabs> |
| 11 <tab title="Unix / Linux"> | 11 <tab title="Unix / Linux"> |
| 12 <procedure> | 12 <procedure> |
| 13 <step> | 13 <step> |
| 14 Download the latest source archive from <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> | 14 Download the latest source archive from |
| 15 and extract it somewhere on your machine. | 15 <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> and extract it somewhere on your machine. |
| 16 You can also use the command line to do this. | 16 You can also use the command line to do this. |
| 17 <code-block lang="sh"> | 17 <code-block lang="sh"> |
| 18 wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz | 18 wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz |
| 19 tar -xzf ucx-latest.tar.gz | 19 tar -xzf ucx-latest.tar.gz |
| 20 cd ucx-latest | 20 cd ucx-latest |
| 35 </procedure> | 35 </procedure> |
| 36 </tab> | 36 </tab> |
| 37 <tab title="Windows"> | 37 <tab title="Windows"> |
| 38 <procedure> | 38 <procedure> |
| 39 <step> | 39 <step> |
| 40 Download the latest source archive from <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> | 40 Download the latest source archive from |
| 41 and extract it somewhere on your machine. | 41 <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> and extract it somewhere on your machine. |
| 42 </step> | 42 </step> |
| 43 <step> | 43 <step> |
| 44 Navigate to the folder named <code>msvc</code> in the extracted directory structure. | 44 Navigate to the folder named <code>msvc</code> in the extracted directory structure. |
| 45 </step> | 45 </step> |
| 46 <step> | 46 <step> |
| 47 Open the contained <code>ucx.sln</code> in Visual Studio and build the solution. | 47 Open the contained <code>ucx.sln</code> in Visual Studio and build the solution. |
| 48 </step> | 48 </step> |
| 49 <step> | |
| 50 The libucx project in the solution will produce a libucx.lib that can be used for static linking | |
| 51 and the libucx_dll project will produce a libucx.dll and a libucx.dll.lib import lib for dynamic linking. | |
| 52 </step> | |
| 49 </procedure> | 53 </procedure> |
| 54 <note> | |
| 55 For native Windows projects it is recommended to statically link UCX. | |
| 56 </note> | |
| 50 </tab> | 57 </tab> |
| 51 </tabs> | 58 </tabs> |
| 52 | 59 |
| 53 ## Compile Time Options | 60 ## Compile Time Options |
| 54 | 61 |
| 73 always use an own implementation. | 80 always use an own implementation. |
| 74 <tip> | 81 <tip> |
| 75 This macro is defined when you use the <code>--disable-szmul-builtin</code> | 82 This macro is defined when you use the <code>--disable-szmul-builtin</code> |
| 76 option during configuration, so you do not need to define it manually. | 83 option during configuration, so you do not need to define it manually. |
| 77 </tip> | 84 </tip> |
| 85 </td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td>CX_WINDLL</td> | |
| 89 <td> | |
| 90 Define this macro during compilation of the project that is <emphasis>using</emphasis> | |
| 91 UCX as a Windows DLL to import the symbols. | |
| 92 In general it is recommended to use UCX as a static library under Windows, though. | |
| 93 </td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td>CX_WINDLL_EXPORT</td> | |
| 97 <td> | |
| 98 Define this macro during compilation of UCX to export symbols for a Windows DLL. | |
| 99 <tip>The Visual Studio Solution does that automatically.</tip> | |
| 78 </td> | 100 </td> |
| 79 </tr> | 101 </tr> |
| 80 </table> | 102 </table> |
| 81 | 103 |
| 82 ### Small Buffer Optimizations | 104 ### Small Buffer Optimizations |
