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">
|
---|
8 | <!ENTITY freerdp-md5sum "b1674bac82fecf8d3c9783e21ad247f2">
|
---|
9 | <!ENTITY freerdp-size "9.7 MB">
|
---|
10 | <!ENTITY freerdp-buildsize "130 MB">
|
---|
11 | <!ENTITY freerdp-time "0.7 SBU">
|
---|
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 |
|
---|
34 | &lfs121_checked;
|
---|
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"/>,
|
---|
91 | <xref linkend="lame"/>,
|
---|
92 | <xref linkend="linux-pam"/>,
|
---|
93 | <xref linkend="pulseaudio"/>,
|
---|
94 | <ulink url="https://github.com/DaveGamble/cJSON">cJSON</ulink>,
|
---|
95 | <ulink url="https://www.quut.com/gsm/">GSM</ulink>,
|
---|
96 | <ulink url="https://github.com/OCL-dev/ocl-icd">ocl-icd</ulink>,
|
---|
97 | <ulink url="https://github.com/Mbed-TLS/mbedtls">mbedTLS</ulink>,
|
---|
98 | <ulink url="https://www.openh264.org/">openh264</ulink>,
|
---|
99 | <ulink url="https://pcsclite.apdu.fr/">pcsclite</ulink>,
|
---|
100 | <ulink url="https://github.com/libsdl-org/SDL_ttf">SDL_ttf</ulink>,
|
---|
101 | <ulink url="https://github.com/chirlu/soxr">soxr</ulink>, and
|
---|
102 | <ulink url="https://github.com/uriparser/uriparser">uriparser</ulink>
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="installation">
|
---|
108 | <title>Installation of FreeRDP</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | Install <application>FreeRDP</application> by running the following
|
---|
112 | commands:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen><userinput>mkdir build &&
|
---|
116 | cd build &&
|
---|
117 |
|
---|
118 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
119 | -D CMAKE_SKIP_INSTALL_RPATH=OFF \
|
---|
120 | -D CMAKE_BUILD_TYPE=Release \
|
---|
121 | -D WITH_CAIRO=ON \
|
---|
122 | -D WITH_CLIENT_SDL=OFF \
|
---|
123 | -D WITH_DSP_FFMPEG=ON \
|
---|
124 | -D WITH_FFMPEG=ON \
|
---|
125 | -D WITH_PCSC=OFF \
|
---|
126 | -D WITH_SERVER=ON \
|
---|
127 | -D WITH_SERVER_CHANNELS=ON \
|
---|
128 | -D DOCBOOKXSL_DIR=/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; \
|
---|
129 | -W no-dev \
|
---|
130 | -G Ninja .. &&
|
---|
131 | ninja</userinput></screen>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | This package does not come with a test suite.
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <para>
|
---|
138 | Now, as the &root; user:
|
---|
139 | </para>
|
---|
140 |
|
---|
141 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="commands">
|
---|
146 | <title>Command Explanations</title>
|
---|
147 |
|
---|
148 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
149 | href="../../xincludes/cmake-skip-install-rpath.xml"/>
|
---|
150 |
|
---|
151 | <para>
|
---|
152 | <parameter>-D DOCBOOKXSL_DIR=/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;</parameter>:
|
---|
153 | This parameter points CMake to the location of the Docbook XSL
|
---|
154 | stylesheets, and is needed because BLFS does not use namespaced versions
|
---|
155 | of the stylesheets. This is needed to create man pages. If you do not
|
---|
156 | want manpages, pass -D WITH_MANPAGES=OFF to CMake instead.
|
---|
157 | </para>
|
---|
158 |
|
---|
159 | <para>
|
---|
160 | <parameter>-D WITH_CAIRO=ON</parameter>: This parameter uses Cairo for
|
---|
161 | HighDPI and window resizing support.
|
---|
162 | </para>
|
---|
163 |
|
---|
164 | <para>
|
---|
165 | <parameter>-D WITH_CLIENT_SDL=OFF</parameter>: This parameter disables
|
---|
166 | using SDL to draw the window when using the FreeRDP client. This is
|
---|
167 | disabled because it depends on
|
---|
168 | <ulink url="https://github.com/libsdl-org/SDL_ttf">SDL_ttf</ulink>.
|
---|
169 | Remove this switch if you have the SDL_ttf package installed.
|
---|
170 | </para>
|
---|
171 |
|
---|
172 | <para>
|
---|
173 | <parameter>-D WITH_FFMPEG=ON</parameter>: This parameter enables support
|
---|
174 | for using ffmpeg for the H.264 graphics rendering mode, which is required
|
---|
175 | when connecting via RDP to Windows Server 2012 (or Windows 8) or later
|
---|
176 | hosts.
|
---|
177 | </para>
|
---|
178 |
|
---|
179 | <para>
|
---|
180 | <parameter>-D WITH_DSP_FFMPEG=ON</parameter>: This parameter enables
|
---|
181 | support for using ffmpeg for sound and microphone redirection.
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <para>
|
---|
185 | <parameter>-D WITH_PCSC=OFF</parameter>: This parameter disables support
|
---|
186 | for SmartCards since BLFS does not have the required dependency for it.
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | <para>
|
---|
190 | <parameter>-D WITH_SERVER=ON</parameter>: This parameter enables building
|
---|
191 | the FreeRDP server components. Remove this parameter if you do not want
|
---|
192 | to use the FreeRDP server.
|
---|
193 | </para>
|
---|
194 |
|
---|
195 | <para>
|
---|
196 | <parameter>-D WITH_SERVER_CHANNELS=ON</parameter>: This parameter builds
|
---|
197 | additional plugins for the FreeRDP server.
|
---|
198 | </para>
|
---|
199 |
|
---|
200 | <para>
|
---|
201 | <option>-D WITH_LAME=ON</option>: Use this option if you wish to enable
|
---|
202 | support for using LAME to provide MP3 Audio Codec support.
|
---|
203 | </para>
|
---|
204 |
|
---|
205 | <para>
|
---|
206 | <option>-D WITH_FAAC=ON</option>: Use this option if you wish to enable
|
---|
207 | support for using FAAC to provide AAC Audio Codec support.
|
---|
208 | </para>
|
---|
209 |
|
---|
210 | <para>
|
---|
211 | <option>-D WITH_FAAD2=ON</option>: Use this option if you wish to enable
|
---|
212 | support for using FAAD2 to provide AAC Audio Codec support.
|
---|
213 | </para>
|
---|
214 |
|
---|
215 | <para>
|
---|
216 | <option>-D WITH_MBEDTLS=ON</option>: Use this option if you have the
|
---|
217 | optional dependency
|
---|
218 | <ulink url="https://github.com/Mbed-TLS/mbedtls">mbedTLS</ulink> installed
|
---|
219 | and wish to use it as an alternative to OpenSSL for cryptography support.
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | <para>
|
---|
223 | <option>-D WITH_OPENCL=ON</option>: Use this option if you have the
|
---|
224 | optional dependency
|
---|
225 | <ulink url="https://github.com/OCL-dev/ocl-icd">ocl-icd</ulink>
|
---|
226 | installed and wish to use OpenCL support.
|
---|
227 | </para>
|
---|
228 |
|
---|
229 | <para>
|
---|
230 | <option>-D WITH_OPENH264=ON</option>: Use this option if you have
|
---|
231 | the optional dependency
|
---|
232 | <ulink url="https://www.openh264.org/">openh264</ulink> installed and
|
---|
233 | wish to use it for H.264 support instead of ffmpeg.
|
---|
234 | </para>
|
---|
235 |
|
---|
236 | <para>
|
---|
237 | <option>-D WITH_GSM=ON</option>: Use this option if you have the optional
|
---|
238 | dependency <ulink url="https://www.quut.com/gsm/">GSM</ulink> installed
|
---|
239 | and wish to use GSM as an audio codec.
|
---|
240 | </para>
|
---|
241 |
|
---|
242 | <para>
|
---|
243 | <option>-D WITH_SOXR=ON</option>: Use this option if you have the optional
|
---|
244 | dependency <ulink url="https://github.com/chirlu/soxr">soxr</ulink>
|
---|
245 | installed and wish to use it instead of ffmpeg for multimedia redirection.
|
---|
246 | </para>
|
---|
247 |
|
---|
248 | </sect2>
|
---|
249 |
|
---|
250 | <sect2 role="content">
|
---|
251 | <title>Contents</title>
|
---|
252 |
|
---|
253 | <segmentedlist>
|
---|
254 | <segtitle>Installed Programs</segtitle>
|
---|
255 | <segtitle>Installed Libraries</segtitle>
|
---|
256 | <segtitle>Installed Directories</segtitle>
|
---|
257 |
|
---|
258 | <seglistitem>
|
---|
259 | <seg>
|
---|
260 | freerdp-proxy,
|
---|
261 | freerdp-shadow-cli,
|
---|
262 | sfreerdp,
|
---|
263 | sfreerdp-server,
|
---|
264 | winpr-hash,
|
---|
265 | winpr-makecert,
|
---|
266 | wlfreerdp,
|
---|
267 | xfreerdp
|
---|
268 | </seg>
|
---|
269 | <seg>
|
---|
270 | libfreerdp3.so,
|
---|
271 | libfreerdp-client3.so,
|
---|
272 | libfreerdp-server3.so,
|
---|
273 | libfreerdp-server-proxy3.so,
|
---|
274 | libfreerdp-shadow3.so,
|
---|
275 | libfreerdp-shadow-subsystem3.so,
|
---|
276 | librtdk0.so,
|
---|
277 | libuwac0.so,
|
---|
278 | libwinpr3.so, and
|
---|
279 | libwinpr-tools3.so
|
---|
280 | </seg>
|
---|
281 | <seg>
|
---|
282 | /usr/include/{freerdp3,rdtk0,uwac0,winpr3},
|
---|
283 | /usr/lib/cmake/{FreeRDP3,FreeRDP-Client3,FreeRDP-Proxy3,FreeRDP-Server3,rdtk0,uwac0,WinPR3,WinPR-tools3},
|
---|
284 | /usr/lib/freerdp3,
|
---|
285 | /usr/share/FreeRDP
|
---|
286 | </seg>
|
---|
287 | </seglistitem>
|
---|
288 | </segmentedlist>
|
---|
289 |
|
---|
290 | <variablelist>
|
---|
291 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
292 | <?dbfo list-presentation="list"?>
|
---|
293 | <?dbhtml list-presentation="table"?>
|
---|
294 |
|
---|
295 | <!-- If the program or library name conflicts with (is the same as) the
|
---|
296 | package name, add -prog or -lib to the varlistentry entity id
|
---|
297 | and the 2nd entry of the indexterm zone entity -->
|
---|
298 |
|
---|
299 | <varlistentry id="freerdp-proxy">
|
---|
300 | <term><command>freerdp-proxy</command></term>
|
---|
301 | <listitem>
|
---|
302 | <para>
|
---|
303 | configures FreeRDP to use a proxy server
|
---|
304 | </para>
|
---|
305 | <indexterm zone="freerdp freerdp-proxy">
|
---|
306 | <primary sortas="b-freerdp-proxy">freerdp-proxy</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="freerdp-shadow-cli">
|
---|
312 | <term><command>freerdp-shadow-cli</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>
|
---|
315 | interfaces with the shadow functionality in FreeRDP
|
---|
316 | </para>
|
---|
317 | <indexterm zone="freerdp freerdp-shadow-cli">
|
---|
318 | <primary sortas="b-freerdp-shadow-cli">freerdp-shadow-cli</primary>
|
---|
319 | </indexterm>
|
---|
320 | </listitem>
|
---|
321 | </varlistentry>
|
---|
322 |
|
---|
323 | <varlistentry id="sfreerdp">
|
---|
324 | <term><command>sfreerdp</command></term>
|
---|
325 | <listitem>
|
---|
326 | <para>
|
---|
327 | is a utility for sharing an X display over RDP
|
---|
328 | </para>
|
---|
329 | <indexterm zone="freerdp sfreerdp">
|
---|
330 | <primary sortas="b-sfreerdp">sfreerdp</primary>
|
---|
331 | </indexterm>
|
---|
332 | </listitem>
|
---|
333 | </varlistentry>
|
---|
334 |
|
---|
335 | <varlistentry id="sfreerdp-server">
|
---|
336 | <term><command>sfreerdp-server</command></term>
|
---|
337 | <listitem>
|
---|
338 | <para>
|
---|
339 | is a utility for sharing an X display over RDP
|
---|
340 | </para>
|
---|
341 | <indexterm zone="freerdp sfreerdp-server">
|
---|
342 | <primary sortas="b-sfreerdp-server">sfreerdp-server</primary>
|
---|
343 | </indexterm>
|
---|
344 | </listitem>
|
---|
345 | </varlistentry>
|
---|
346 |
|
---|
347 | <varlistentry id="winpr-hash">
|
---|
348 | <term><command>winpr-hash</command></term>
|
---|
349 | <listitem>
|
---|
350 | <para>
|
---|
351 | creates a NTLM hash from a username and password pair
|
---|
352 | </para>
|
---|
353 | <indexterm zone="freerdp winpr-hash">
|
---|
354 | <primary sortas="b-winpr-hash">winpr-hash</primary>
|
---|
355 | </indexterm>
|
---|
356 | </listitem>
|
---|
357 | </varlistentry>
|
---|
358 |
|
---|
359 | <varlistentry id="winpr-makecert">
|
---|
360 | <term><command>winpr-makecert</command></term>
|
---|
361 | <listitem>
|
---|
362 | <para>
|
---|
363 | creates X.509 certificates for use with FreeRDP
|
---|
364 | </para>
|
---|
365 | <indexterm zone="freerdp winpr-makecert">
|
---|
366 | <primary sortas="b-winpr-makecert">winpr-makecert</primary>
|
---|
367 | </indexterm>
|
---|
368 | </listitem>
|
---|
369 | </varlistentry>
|
---|
370 |
|
---|
371 | <varlistentry id="wlfreerdp">
|
---|
372 | <term><command>wlfreerdp</command></term>
|
---|
373 | <listitem>
|
---|
374 | <para>
|
---|
375 | is a RDP client for Wayland
|
---|
376 | </para>
|
---|
377 | <indexterm zone="freerdp wlfreerdp">
|
---|
378 | <primary sortas="b-wlfreerdp">wlfreerdp</primary>
|
---|
379 | </indexterm>
|
---|
380 | </listitem>
|
---|
381 | </varlistentry>
|
---|
382 |
|
---|
383 | <varlistentry id="xfreerdp">
|
---|
384 | <term><command>xfreerdp</command></term>
|
---|
385 | <listitem>
|
---|
386 | <para>
|
---|
387 | is a RDP client for X11
|
---|
388 | </para>
|
---|
389 | <indexterm zone="freerdp xfreerdp">
|
---|
390 | <primary sortas="b-xfreerdp">xfreerdp</primary>
|
---|
391 | </indexterm>
|
---|
392 | </listitem>
|
---|
393 | </varlistentry>
|
---|
394 |
|
---|
395 | <varlistentry id="libfreerdp3">
|
---|
396 | <term><filename class="libraryfile">libfreerdp3.so</filename></term>
|
---|
397 | <listitem>
|
---|
398 | <para>
|
---|
399 | contains functions that provide RDP client and server functionality
|
---|
400 | </para>
|
---|
401 | <indexterm zone="freerdp libfreerdp3">
|
---|
402 | <primary sortas="c-libfreerdp3">libfreerdp3.so</primary>
|
---|
403 | </indexterm>
|
---|
404 | </listitem>
|
---|
405 | </varlistentry>
|
---|
406 | </variablelist>
|
---|
407 | </sect2>
|
---|
408 | </sect1>
|
---|