[25c7b8d] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY freerdp-download-http "https://github.com/freerdp/freerdp/archive/&freerdp-version;/FreeRDP-&freerdp-version;.tar.gz">
|
---|
[656007f] | 8 | <!ENTITY freerdp-md5sum "07126ef3637f2740846a296d40eef203">
|
---|
[da609609] | 9 | <!ENTITY freerdp-size "9.8 MB">
|
---|
[656007f] | 10 | <!ENTITY freerdp-buildsize "197 MB">
|
---|
[da609609] | 11 | <!ENTITY freerdp-time "0.6 SBU">
|
---|
[25c7b8d] | 12 | ]>
|
---|
| 13 |
|
---|
| 14 | <sect1 id="freerdp" xreflabel="FreeRDP-&freerdp-version;">
|
---|
| 15 | <?dbhtml filename="freerdp.html"?>
|
---|
| 16 |
|
---|
| 17 | <title>FreeRDP-&freerdp-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="freerdp">
|
---|
| 20 | <primary sortas="a-freerdp">FreeRDP</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title>Introduction to FreeRDP</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>FreeRDP</application> package contains libraries and
|
---|
| 28 | utilities for utilizing the Remote Desktop Protocol. This includes tools
|
---|
| 29 | to run an RDP server as well as connecting to a computer using RDP. This
|
---|
| 30 | is primarily used for connecting to Microsoft Windows computers, but can
|
---|
| 31 | also be used on Linux and macOS.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[1cd77c3] | 34 | &lfs122_checked;
|
---|
[25c7b8d] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&freerdp-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download MD5 sum: &freerdp-md5sum;
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download size: &freerdp-size;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Estimated disk space required: &freerdp-buildsize;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated build time: &freerdp-time;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
| 65 | <bridgehead renderas="sect3">FreeRDP Dependencies</bridgehead>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 68 | <para role="required">
|
---|
| 69 | <xref linkend="ffmpeg"/>,
|
---|
| 70 | <xref linkend="icu"/>, and
|
---|
| 71 | <xref linkend="xorg7-lib"/>
|
---|
| 72 | </para>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 75 | <para role="recommended">
|
---|
| 76 | <xref linkend="cairo"/>,
|
---|
| 77 | <xref linkend="docbook-xsl"/>,
|
---|
| 78 | <xref linkend="fuse3"/>,
|
---|
| 79 | <xref linkend="json-c"/>,
|
---|
| 80 | <xref linkend="mitkrb"/>,
|
---|
| 81 | <xref linkend="libusb"/>,
|
---|
| 82 | <xref linkend="libxkbcommon"/>, and
|
---|
| 83 | <xref linkend="wayland"/>
|
---|
| 84 | </para>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 87 | <para role="optional">
|
---|
| 88 | <xref linkend="cups"/>,
|
---|
| 89 | <xref linkend="faac"/>,
|
---|
| 90 | <xref linkend="faad2"/>,
|
---|
[da609609] | 91 | <xref linkend="fdk-aac"/>,
|
---|
| 92 | <xref linkend="freerdp"/>,
|
---|
[25c7b8d] | 93 | <xref linkend="lame"/>,
|
---|
| 94 | <xref linkend="linux-pam"/>,
|
---|
| 95 | <xref linkend="pulseaudio"/>,
|
---|
| 96 | <ulink url="https://github.com/DaveGamble/cJSON">cJSON</ulink>,
|
---|
| 97 | <ulink url="https://www.quut.com/gsm/">GSM</ulink>,
|
---|
| 98 | <ulink url="https://github.com/OCL-dev/ocl-icd">ocl-icd</ulink>,
|
---|
| 99 | <ulink url="https://github.com/Mbed-TLS/mbedtls">mbedTLS</ulink>,
|
---|
| 100 | <ulink url="https://www.openh264.org/">openh264</ulink>,
|
---|
| 101 | <ulink url="https://pcsclite.apdu.fr/">pcsclite</ulink>,
|
---|
| 102 | <ulink url="https://github.com/libsdl-org/SDL_ttf">SDL_ttf</ulink>,
|
---|
| 103 | <ulink url="https://github.com/chirlu/soxr">soxr</ulink>, and
|
---|
| 104 | <ulink url="https://github.com/uriparser/uriparser">uriparser</ulink>
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="installation">
|
---|
| 110 | <title>Installation of FreeRDP</title>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
| 113 | Install <application>FreeRDP</application> by running the following
|
---|
| 114 | commands:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <screen><userinput>mkdir build &&
|
---|
| 118 | cd build &&
|
---|
| 119 |
|
---|
[5a82b8c1] | 120 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 121 | -D CMAKE_SKIP_INSTALL_RPATH=ON \
|
---|
| 122 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 123 | -D WITH_CAIRO=ON \
|
---|
| 124 | -D WITH_CLIENT_SDL=OFF \
|
---|
| 125 | -D WITH_DSP_FFMPEG=ON \
|
---|
| 126 | -D WITH_FFMPEG=ON \
|
---|
| 127 | -D WITH_PCSC=OFF \
|
---|
| 128 | -D WITH_SERVER=ON \
|
---|
| 129 | -D WITH_SERVER_CHANNELS=ON \
|
---|
[25c7b8d] | 130 | -D DOCBOOKXSL_DIR=/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; \
|
---|
[5a82b8c1] | 131 | -W no-dev \
|
---|
| 132 | -G Ninja .. &&
|
---|
[25c7b8d] | 133 | ninja</userinput></screen>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | This package does not come with a test suite.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | Now, as the &root; user:
|
---|
| 141 | </para>
|
---|
| 142 |
|
---|
| 143 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 144 |
|
---|
| 145 | </sect2>
|
---|
| 146 |
|
---|
| 147 | <sect2 role="commands">
|
---|
| 148 | <title>Command Explanations</title>
|
---|
| 149 |
|
---|
| 150 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 151 | href="../../xincludes/cmake-skip-install-rpath.xml"/>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
| 154 | <parameter>-D DOCBOOKXSL_DIR=/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;</parameter>:
|
---|
| 155 | This parameter points CMake to the location of the Docbook XSL
|
---|
| 156 | stylesheets, and is needed because BLFS does not use namespaced versions
|
---|
| 157 | of the stylesheets. This is needed to create man pages. If you do not
|
---|
[cbfa153] | 158 | want manpages, pass -D WITH_MANPAGES=OFF to CMake instead.
|
---|
[25c7b8d] | 159 | </para>
|
---|
| 160 |
|
---|
| 161 | <para>
|
---|
| 162 | <parameter>-D WITH_CAIRO=ON</parameter>: This parameter uses Cairo for
|
---|
| 163 | HighDPI and window resizing support.
|
---|
| 164 | </para>
|
---|
| 165 |
|
---|
| 166 | <para>
|
---|
| 167 | <parameter>-D WITH_CLIENT_SDL=OFF</parameter>: This parameter disables
|
---|
| 168 | using SDL to draw the window when using the FreeRDP client. This is
|
---|
| 169 | disabled because it depends on
|
---|
| 170 | <ulink url="https://github.com/libsdl-org/SDL_ttf">SDL_ttf</ulink>.
|
---|
| 171 | Remove this switch if you have the SDL_ttf package installed.
|
---|
| 172 | </para>
|
---|
| 173 |
|
---|
| 174 | <para>
|
---|
| 175 | <parameter>-D WITH_FFMPEG=ON</parameter>: This parameter enables support
|
---|
| 176 | for using ffmpeg for the H.264 graphics rendering mode, which is required
|
---|
| 177 | when connecting via RDP to Windows Server 2012 (or Windows 8) or later
|
---|
| 178 | hosts.
|
---|
| 179 | </para>
|
---|
| 180 |
|
---|
| 181 | <para>
|
---|
| 182 | <parameter>-D WITH_DSP_FFMPEG=ON</parameter>: This parameter enables
|
---|
| 183 | support for using ffmpeg for sound and microphone redirection.
|
---|
| 184 | </para>
|
---|
| 185 |
|
---|
| 186 | <para>
|
---|
| 187 | <parameter>-D WITH_PCSC=OFF</parameter>: This parameter disables support
|
---|
| 188 | for SmartCards since BLFS does not have the required dependency for it.
|
---|
| 189 | </para>
|
---|
| 190 |
|
---|
| 191 | <para>
|
---|
| 192 | <parameter>-D WITH_SERVER=ON</parameter>: This parameter enables building
|
---|
| 193 | the FreeRDP server components. Remove this parameter if you do not want
|
---|
| 194 | to use the FreeRDP server.
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <para>
|
---|
| 198 | <parameter>-D WITH_SERVER_CHANNELS=ON</parameter>: This parameter builds
|
---|
| 199 | additional plugins for the FreeRDP server.
|
---|
| 200 | </para>
|
---|
| 201 |
|
---|
| 202 | <para>
|
---|
| 203 | <option>-D WITH_LAME=ON</option>: Use this option if you wish to enable
|
---|
| 204 | support for using LAME to provide MP3 Audio Codec support.
|
---|
| 205 | </para>
|
---|
| 206 |
|
---|
| 207 | <para>
|
---|
| 208 | <option>-D WITH_FAAC=ON</option>: Use this option if you wish to enable
|
---|
| 209 | support for using FAAC to provide AAC Audio Codec support.
|
---|
| 210 | </para>
|
---|
| 211 |
|
---|
| 212 | <para>
|
---|
| 213 | <option>-D WITH_FAAD2=ON</option>: Use this option if you wish to enable
|
---|
| 214 | support for using FAAD2 to provide AAC Audio Codec support.
|
---|
| 215 | </para>
|
---|
[da609609] | 216 |
|
---|
| 217 | <para>
|
---|
| 218 | <option>-D WITH_FDK_AAC=ON</option>: Use this option if you wish to
|
---|
| 219 | enable support for using fdk-aac to provide AAC Audio Codec support.
|
---|
| 220 | </para>
|
---|
| 221 |
|
---|
[25c7b8d] | 222 | <para>
|
---|
| 223 | <option>-D WITH_MBEDTLS=ON</option>: Use this option if you have the
|
---|
| 224 | optional dependency
|
---|
| 225 | <ulink url="https://github.com/Mbed-TLS/mbedtls">mbedTLS</ulink> installed
|
---|
| 226 | and wish to use it as an alternative to OpenSSL for cryptography support.
|
---|
| 227 | </para>
|
---|
| 228 |
|
---|
| 229 | <para>
|
---|
| 230 | <option>-D WITH_OPENCL=ON</option>: Use this option if you have the
|
---|
| 231 | optional dependency
|
---|
| 232 | <ulink url="https://github.com/OCL-dev/ocl-icd">ocl-icd</ulink>
|
---|
| 233 | installed and wish to use OpenCL support.
|
---|
| 234 | </para>
|
---|
| 235 |
|
---|
| 236 | <para>
|
---|
| 237 | <option>-D WITH_OPENH264=ON</option>: Use this option if you have
|
---|
| 238 | the optional dependency
|
---|
| 239 | <ulink url="https://www.openh264.org/">openh264</ulink> installed and
|
---|
| 240 | wish to use it for H.264 support instead of ffmpeg.
|
---|
| 241 | </para>
|
---|
| 242 |
|
---|
| 243 | <para>
|
---|
| 244 | <option>-D WITH_GSM=ON</option>: Use this option if you have the optional
|
---|
| 245 | dependency <ulink url="https://www.quut.com/gsm/">GSM</ulink> installed
|
---|
| 246 | and wish to use GSM as an audio codec.
|
---|
| 247 | </para>
|
---|
| 248 |
|
---|
| 249 | <para>
|
---|
| 250 | <option>-D WITH_SOXR=ON</option>: Use this option if you have the optional
|
---|
| 251 | dependency <ulink url="https://github.com/chirlu/soxr">soxr</ulink>
|
---|
| 252 | installed and wish to use it instead of ffmpeg for multimedia redirection.
|
---|
| 253 | </para>
|
---|
| 254 |
|
---|
| 255 | </sect2>
|
---|
| 256 |
|
---|
| 257 | <sect2 role="content">
|
---|
| 258 | <title>Contents</title>
|
---|
| 259 |
|
---|
| 260 | <segmentedlist>
|
---|
| 261 | <segtitle>Installed Programs</segtitle>
|
---|
| 262 | <segtitle>Installed Libraries</segtitle>
|
---|
| 263 | <segtitle>Installed Directories</segtitle>
|
---|
| 264 |
|
---|
| 265 | <seglistitem>
|
---|
| 266 | <seg>
|
---|
| 267 | freerdp-proxy,
|
---|
| 268 | freerdp-shadow-cli,
|
---|
| 269 | sfreerdp,
|
---|
| 270 | sfreerdp-server,
|
---|
| 271 | winpr-hash,
|
---|
| 272 | winpr-makecert,
|
---|
| 273 | wlfreerdp,
|
---|
| 274 | xfreerdp
|
---|
| 275 | </seg>
|
---|
| 276 | <seg>
|
---|
| 277 | libfreerdp3.so,
|
---|
| 278 | libfreerdp-client3.so,
|
---|
| 279 | libfreerdp-server3.so,
|
---|
| 280 | libfreerdp-server-proxy3.so,
|
---|
| 281 | libfreerdp-shadow3.so,
|
---|
| 282 | libfreerdp-shadow-subsystem3.so,
|
---|
| 283 | librtdk0.so,
|
---|
| 284 | libuwac0.so,
|
---|
| 285 | libwinpr3.so, and
|
---|
| 286 | libwinpr-tools3.so
|
---|
| 287 | </seg>
|
---|
| 288 | <seg>
|
---|
| 289 | /usr/include/{freerdp3,rdtk0,uwac0,winpr3},
|
---|
| 290 | /usr/lib/cmake/{FreeRDP3,FreeRDP-Client3,FreeRDP-Proxy3,FreeRDP-Server3,rdtk0,uwac0,WinPR3,WinPR-tools3},
|
---|
| 291 | /usr/lib/freerdp3,
|
---|
| 292 | /usr/share/FreeRDP
|
---|
| 293 | </seg>
|
---|
| 294 | </seglistitem>
|
---|
| 295 | </segmentedlist>
|
---|
| 296 |
|
---|
| 297 | <variablelist>
|
---|
| 298 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 299 | <?dbfo list-presentation="list"?>
|
---|
| 300 | <?dbhtml list-presentation="table"?>
|
---|
| 301 |
|
---|
| 302 | <!-- If the program or library name conflicts with (is the same as) the
|
---|
| 303 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 304 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 305 |
|
---|
| 306 | <varlistentry id="freerdp-proxy">
|
---|
| 307 | <term><command>freerdp-proxy</command></term>
|
---|
| 308 | <listitem>
|
---|
| 309 | <para>
|
---|
| 310 | configures FreeRDP to use a proxy server
|
---|
| 311 | </para>
|
---|
| 312 | <indexterm zone="freerdp freerdp-proxy">
|
---|
| 313 | <primary sortas="b-freerdp-proxy">freerdp-proxy</primary>
|
---|
| 314 | </indexterm>
|
---|
| 315 | </listitem>
|
---|
| 316 | </varlistentry>
|
---|
| 317 |
|
---|
| 318 | <varlistentry id="freerdp-shadow-cli">
|
---|
| 319 | <term><command>freerdp-shadow-cli</command></term>
|
---|
| 320 | <listitem>
|
---|
| 321 | <para>
|
---|
| 322 | interfaces with the shadow functionality in FreeRDP
|
---|
| 323 | </para>
|
---|
| 324 | <indexterm zone="freerdp freerdp-shadow-cli">
|
---|
| 325 | <primary sortas="b-freerdp-shadow-cli">freerdp-shadow-cli</primary>
|
---|
| 326 | </indexterm>
|
---|
| 327 | </listitem>
|
---|
| 328 | </varlistentry>
|
---|
| 329 |
|
---|
| 330 | <varlistentry id="sfreerdp">
|
---|
| 331 | <term><command>sfreerdp</command></term>
|
---|
| 332 | <listitem>
|
---|
| 333 | <para>
|
---|
| 334 | is a utility for sharing an X display over RDP
|
---|
| 335 | </para>
|
---|
| 336 | <indexterm zone="freerdp sfreerdp">
|
---|
| 337 | <primary sortas="b-sfreerdp">sfreerdp</primary>
|
---|
| 338 | </indexterm>
|
---|
| 339 | </listitem>
|
---|
| 340 | </varlistentry>
|
---|
| 341 |
|
---|
| 342 | <varlistentry id="sfreerdp-server">
|
---|
| 343 | <term><command>sfreerdp-server</command></term>
|
---|
| 344 | <listitem>
|
---|
| 345 | <para>
|
---|
| 346 | is a utility for sharing an X display over RDP
|
---|
| 347 | </para>
|
---|
| 348 | <indexterm zone="freerdp sfreerdp-server">
|
---|
| 349 | <primary sortas="b-sfreerdp-server">sfreerdp-server</primary>
|
---|
| 350 | </indexterm>
|
---|
| 351 | </listitem>
|
---|
| 352 | </varlistentry>
|
---|
| 353 |
|
---|
| 354 | <varlistentry id="winpr-hash">
|
---|
| 355 | <term><command>winpr-hash</command></term>
|
---|
| 356 | <listitem>
|
---|
| 357 | <para>
|
---|
| 358 | creates a NTLM hash from a username and password pair
|
---|
| 359 | </para>
|
---|
| 360 | <indexterm zone="freerdp winpr-hash">
|
---|
| 361 | <primary sortas="b-winpr-hash">winpr-hash</primary>
|
---|
| 362 | </indexterm>
|
---|
| 363 | </listitem>
|
---|
| 364 | </varlistentry>
|
---|
| 365 |
|
---|
| 366 | <varlistentry id="winpr-makecert">
|
---|
| 367 | <term><command>winpr-makecert</command></term>
|
---|
| 368 | <listitem>
|
---|
| 369 | <para>
|
---|
| 370 | creates X.509 certificates for use with FreeRDP
|
---|
| 371 | </para>
|
---|
| 372 | <indexterm zone="freerdp winpr-makecert">
|
---|
| 373 | <primary sortas="b-winpr-makecert">winpr-makecert</primary>
|
---|
| 374 | </indexterm>
|
---|
| 375 | </listitem>
|
---|
| 376 | </varlistentry>
|
---|
| 377 |
|
---|
| 378 | <varlistentry id="wlfreerdp">
|
---|
| 379 | <term><command>wlfreerdp</command></term>
|
---|
| 380 | <listitem>
|
---|
| 381 | <para>
|
---|
| 382 | is a RDP client for Wayland
|
---|
| 383 | </para>
|
---|
| 384 | <indexterm zone="freerdp wlfreerdp">
|
---|
| 385 | <primary sortas="b-wlfreerdp">wlfreerdp</primary>
|
---|
| 386 | </indexterm>
|
---|
| 387 | </listitem>
|
---|
| 388 | </varlistentry>
|
---|
| 389 |
|
---|
| 390 | <varlistentry id="xfreerdp">
|
---|
| 391 | <term><command>xfreerdp</command></term>
|
---|
| 392 | <listitem>
|
---|
| 393 | <para>
|
---|
| 394 | is a RDP client for X11
|
---|
| 395 | </para>
|
---|
| 396 | <indexterm zone="freerdp xfreerdp">
|
---|
| 397 | <primary sortas="b-xfreerdp">xfreerdp</primary>
|
---|
| 398 | </indexterm>
|
---|
| 399 | </listitem>
|
---|
| 400 | </varlistentry>
|
---|
| 401 |
|
---|
| 402 | <varlistentry id="libfreerdp3">
|
---|
| 403 | <term><filename class="libraryfile">libfreerdp3.so</filename></term>
|
---|
| 404 | <listitem>
|
---|
| 405 | <para>
|
---|
| 406 | contains functions that provide RDP client and server functionality
|
---|
| 407 | </para>
|
---|
| 408 | <indexterm zone="freerdp libfreerdp3">
|
---|
| 409 | <primary sortas="c-libfreerdp3">libfreerdp3.so</primary>
|
---|
| 410 | </indexterm>
|
---|
| 411 | </listitem>
|
---|
| 412 | </varlistentry>
|
---|
| 413 | </variablelist>
|
---|
| 414 | </sect2>
|
---|
| 415 | </sect1>
|
---|