client/X11/xfreerdp.1.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   2                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   3 <refentry>
   4   <refentryinfo>
   5     <date>2011-08-27</date>
   6     <author>
   7       <authorblurb><para>The FreeRDP Team</para></authorblurb>
   8     </author>
   9   </refentryinfo>
  10   <refmeta>
  11     <refentrytitle>xfreerdp</refentrytitle>
  12     <manvolnum>1</manvolnum>
  13     <refmiscinfo class="source">freerdp</refmiscinfo>
  14     <refmiscinfo class="manual">xfreerdp</refmiscinfo>
  15   </refmeta>
  16   <refnamediv>
  17     <refname><application>xfreerdp</application></refname>
  18     <refpurpose>FreeRDP X11 client</refpurpose>
  19   </refnamediv>
  20   <refsynopsisdiv>
  21     <refsynopsisdivinfo>
  22       <date>2011-08-27</date>
  23     </refsynopsisdivinfo>
  24     <para>
  25       <command>xfreerdp</command> [options] server[:port] [[options] server[:port] …]
  26     </para>
  27   </refsynopsisdiv>
  28   <refsect1>
  29     <refsect1info>
  30       <date>2011-08-27</date>
  31     </refsect1info>
  32     <title>DESCRIPTION</title>
  33     <para>
  34       <command>xfreerdp</command> is an X11 Remote Desktop Protocol (RDP)
  35       client which is part of the FreeRDP project. An RDP server is built-in
  36       to many editions of Windows. Alternative servers included xrdp and VRDP (VirtualBox).
  37     </para>
  38   </refsect1>
  39   <refsect1>
  40     <title>OPTIONS</title>
  41     <variablelist>
  42       <varlistentry>
  43         <term>-0</term>
  44         <listitem>
  45           <para>
  46             Attach to the admin console of the server.
  47           </para>
  48         </listitem>
  49       </varlistentry>
  50       <varlistentry>
  51         <term>-a <replaceable class="parameter">bpp</replaceable></term>
  52         <listitem>
  53           <para>
  54             Sets the color depth for the connection to <replaceable class="parameter">bpp</replaceable> bits per pixel.
  55             Valid values are 8, 15, 16, 24 and 32. The default value is the color depth of the FreeRDP-window.
  56           </para>
  57         </listitem>
  58       </varlistentry>
  59       <varlistentry id="WorkingDir">
  60         <term>-c <replaceable class="parameter">dir</replaceable></term>
  61         <listitem>
  62           <para>
  63             Sets the working-dir to <replaceable class="parameter">dir</replaceable>.
  64             This parameter is only used when an AlternateShell (<xref linkend="AlternateShell"/>) is requested.
  65             <replaceable class="parameter">dir</replaceable> should contain the executable file specified in the AlternateShell.
  66           </para>
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term>-D</term>
  71         <listitem>
  72           <para>
  73             Removes the windows decorations.
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term>-d</term>
  79         <listitem>
  80           <para>
  81             Domain used in authentication.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term>-f</term>
  87         <listitem>
  88           <para>
  89             start in full screen mode. This mode can always be en- and disabled using Ctrl-Alt-Enter.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93       <varlistentry>
  94         <term>-T <replaceable class="parameter">text</replaceable></term>
  95         <listitem>
  96           <para>
  97             Sets the window title to <replaceable class="parameter">text</replaceable>.
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101       <varlistentry>
 102         <term>-g <replaceable class="parameter">geometry</replaceable></term>
 103         <listitem>
 104           <para>
 105             Sets the size of the FreeRDP window (and of the remote desktop, when establishing a new connection).
 106             <replaceable class="parameter">geometry</replaceable> can have one of the following forms:
 107             <itemizedlist>
 108               <listitem>
 109                 <para>
 110                   <replaceable class="parameter">W</replaceable>x<replaceable class="parameter">H</replaceable> -
 111                   in this case the resulting window will be of
 112                   <replaceable class="parameter">W</replaceable>x<replaceable class="parameter">H</replaceable> pixels.
 113                 </para>
 114               </listitem>
 115               <listitem>
 116                 <para>
 117                   <replaceable class="parameter">P</replaceable>% -
 118                   in this case the resulting window will be <replaceable class="parameter">P</replaceable>%
 119                   of your screen.
 120                 </para>
 121               </listitem>
 122               <listitem>
 123                 <para>
 124                   The special keyword <emphasis>workarea</emphasis> -
 125                   in this case the resulting window will be of the same size as your workarea.
 126                 </para>
 127               </listitem>
 128             </itemizedlist>
 129           </para>
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term>-k <replaceable class="parameter">id</replaceable></term>
 134         <listitem>
 135           <para>
 136             Sets the keyboard-layout-id to <replaceable class="parameter">id</replaceable>.
 137           </para>
 138         </listitem>
 139       </varlistentry>
 140       <varlistentry>
 141         <term>-m</term>
 142         <listitem>
 143           <para>
 144             Don't send mouse motion events.
 145           </para>
 146         </listitem>
 147       </varlistentry>
 148       <varlistentry>
 149         <term>-n <replaceable class="parameter">hostname</replaceable></term>
 150         <listitem>
 151           <para>
 152             Set the reported client hostname to <replaceable class="parameter">hostname</replaceable>.
 153             Default is to automatically detect the hostname.
 154           </para>
 155         </listitem>
 156       </varlistentry>
 157       <varlistentry>
 158         <term>-o</term>
 159         <listitem>
 160           <para>
 161             Play audio on the console instead of redirecting to the client.
 162           </para>
 163         </listitem>
 164       </varlistentry>
 165       <varlistentry>
 166         <term>-p <replaceable class="parameter">password</replaceable></term>
 167         <listitem>
 168           <para>
 169             Password used in authentication.
 170           </para>
 171         </listitem>
 172       </varlistentry>
 173       <varlistentry id="AlternateShell">
 174         <term>-s <replaceable class="parameter">shell</replaceable></term>
 175         <listitem>
 176           <para>
 177             Sets the startup-shell to <replaceable class="parameter">shell</replaceable>.
 178             This parameter should contain a complete path to the alternate shell.
 179             If the alternete shell requires a different working directory use <xref linkend="WorkingDir"/>.
 180           </para>
 181         </listitem>
 182       </varlistentry>
 183       <varlistentry>
 184         <term>-t <replaceable class="parameter">port</replaceable></term>
 185         <listitem>
 186           <para>
 187             Connect to <replaceable class="parameter">port</replaceable>, instead of the default 3389.
 188           </para>
 189         </listitem>
 190       </varlistentry>
 191       <varlistentry>
 192         <term>-u <replaceable class="parameter">username</replaceable></term>
 193         <listitem>
 194           <para>
 195             Username used in authentication.
 196           </para>
 197         </listitem>
 198       </varlistentry>
 199       <varlistentry>
 200         <term>-x <replaceable class="parameter">flag</replaceable></term>
 201         <listitem>
 202           <para>
 203             Set the experiance performance flags.
 204             <replaceable class="parameter">flag</replaceable> can be one of:
 205             <itemizedlist>
 206               <listitem>
 207                 <para>
 208                   m - (modem): Equivalent to 15.
 209                 </para>
 210               </listitem>
 211               <listitem>
 212                 <para>
 213                   b - (broadband): Equivalent to 1.
 214                 </para>
 215               </listitem>
 216               <listitem>
 217                 <para>
 218                   l - (lan): Equivalent to 0.
 219                 </para>
 220               </listitem>
 221               <listitem>
 222                 <para>
 223                   <replaceable class="parameter">num</replaceable> - A hexadecimal number that
 224                   represents a bit-mask, were numbers mean the following
 225                   <footnote><para>Taken from <ulink url="http://msdn.microsoft.com/en-us/library/cc240476%28v=prot.10%29.aspx">
 226                   MS-RDPBCGR Section 2.2.1.11.1.1.1 - Extended Info Packet</ulink></para></footnote>:
 227                   <itemizedlist>
 228                     <listitem>
 229                       <para>1: Disable desktop wallpaper.</para>
 230                     </listitem>
 231                     <listitem>
 232                       <para>2: Disable full-window drag (only the window outline is displayed when the window is moved).</para>
 233                     </listitem>
 234                     <listitem>
 235                       <para>4: Disable menu animations.</para>
 236                     </listitem>
 237                     <listitem>
 238                       <para>8: Disable user interface themes.</para>
 239                     </listitem>
 240                     <listitem>
 241                       <para>20: Disable mouse cursor shadows.</para>
 242                     </listitem>
 243                     <listitem>
 244                       <para>40: Disable cursor blinking.</para>
 245                     </listitem>
 246                     <listitem>
 247                       <para>80: Enable font smoothing.</para>
 248                     </listitem>
 249                     <listitem>
 250                       <para>100: Enable Desktop Composition.</para>
 251                     </listitem>
 252                   </itemizedlist>
 253                 </para>
 254               </listitem>
 255             </itemizedlist>
 256           </para>
 257         </listitem>
 258       </varlistentry>
 259       <varlistentry>
 260         <term>-z</term>
 261         <listitem>
 262           <para>
 263             Enable compression.
 264           </para>
 265         </listitem>
 266       </varlistentry>
 267       <varlistentry>
 268         <term>--app</term>
 269         <listitem>
 270           <para>
 271             initialize a RemoteApp connection. This implies -g workarea.
 272           </para>
 273         </listitem>
 274       </varlistentry>
 275       <varlistentry>
 276         <term>--ext</term>
 277         <listitem>
 278           <para>
 279             load an extension
 280           </para>
 281         </listitem>
 282       </varlistentry>
 283       <varlistentry>
 284         <term>--no-auth</term>
 285         <listitem>
 286           <para>
 287             Skips authentication. This is useful e.g. for the current FreeRDP server that doesn't yet support server-side authentication.
 288           </para>
 289         </listitem>
 290       </varlistentry>
 291       <varlistentry>
 292         <term>--no-fastpath</term>
 293         <listitem>
 294           <para>
 295             Disables fast-path. Use slow-path packets instead, which have larger headers.
 296             It might be good for debugging certain issues when you suspect it might be
 297             linked to the parsing of one of the two header types.
 298           </para>
 299         </listitem>
 300       </varlistentry>
 301       <varlistentry>
 302         <term>--gdi</term>
 303         <listitem>
 304           <para>
 305             GDI rendering backend. <replaceable class="parameter">backend</replaceable> can be either sw (software) or hw (hardware).
 306           </para>
 307         </listitem>
 308       </varlistentry>
 309       <varlistentry>
 310         <term>--no-osb</term>
 311         <listitem>
 312           <para>
 313             Disable off screen bitmaps.
 314           </para>
 315         </listitem>
 316       </varlistentry>
 317       <varlistentry>
 318         <term>--no-bmp-cache</term>
 319         <listitem>
 320           <para>
 321             Disable bitmap cache.
 322           </para>
 323         </listitem>
 324       </varlistentry>
 325       <varlistentry>
 326         <term>--plugin</term>
 327         <listitem>
 328           <para>
 329             load a plugin
 330           </para>
 331         </listitem>
 332       </varlistentry>
 333       <varlistentry>
 334         <term>--rfx</term>
 335         <listitem>
 336           <para>
 337             Enable RemoteFX.
 338           </para>
 339         </listitem>
 340       </varlistentry>
 341       <varlistentry>
 342         <term>--rfx-mode</term>
 343         <listitem>
 344           <para>
 345             RemoteFX operational flags. <replaceable class="parameter">flags</replaceable> can be either v[ideo], i[mage]), default is video.
 346           </para>
 347         </listitem>
 348       </varlistentry>
 349       <varlistentry>
 350         <term>--nsc</term>
 351         <listitem>
 352           <para>
 353             Enable NSCodec.
 354           </para>
 355         </listitem>
 356       </varlistentry>
 357       <varlistentry>
 358         <term>--disable-wallpaper</term>
 359         <listitem>
 360           <para>
 361             Disable wallpaper.
 362           </para>
 363         </listitem>
 364       </varlistentry>
 365       <varlistentry>
 366         <term>--composition</term>
 367         <listitem>
 368           <para>
 369             Enable composition (RDVH only, not to be confused with remote composition).
 370           </para>
 371         </listitem>
 372       </varlistentry>
 373       <varlistentry>
 374         <term>--disable-full-window-drag</term>
 375         <listitem>
 376           <para>
 377             Disable full window drag.
 378           </para>
 379         </listitem>
 380       </varlistentry>
 381       <varlistentry>
 382         <term>--disable-menu-animations</term>
 383         <listitem>
 384           <para>
 385             Disable menu animations.
 386           </para>
 387         </listitem>
 388       </varlistentry>
 389       <varlistentry>
 390         <term>--disable-theming</term>
 391         <listitem>
 392           <para>
 393             Disable theming.
 394           </para>
 395         </listitem>
 396       </varlistentry>
 397       <varlistentry>
 398         <term>--no-rdp</term>
 399         <listitem>
 400           <para>
 401             Disable Standard RDP encryption.
 402           </para>
 403         </listitem>
 404       </varlistentry>
 405       <varlistentry>
 406         <term>--no-tls</term>
 407         <listitem>
 408           <para>
 409             Disable TLS encryption.
 410           </para>
 411         </listitem>
 412       </varlistentry>
 413       <varlistentry>
 414         <term>--no-nla</term>
 415         <listitem>
 416           <para>
 417             Disable network level authentication.
 418           </para>
 419         </listitem>
 420       </varlistentry>
 421       <varlistentry>
 422         <term>--sec <replaceable class="parameter">proto</replaceable></term>
 423         <listitem>
 424           <para>
 425             force protocol security. <replaceable class="parameter">proto</replaceable> can be one of rdp, tls or nla.
 426           </para>
 427         </listitem>
 428       </varlistentry>
 429       <varlistentry>
 430         <term>--ntlm</term>
 431         <listitem>
 432           <para>
 433             force NTLM protocol version. <replaceable class="parameter">version</replaceable> can be one of 1 or 2.
 434           </para>
 435         </listitem>
 436       </varlistentry>
 437       <varlistentry>
 438         <term>--ignore-certificate</term>
 439         <listitem>
 440           <para>
 441             ignore verification of logon certificate.
 442           </para>
 443         </listitem>
 444       </varlistentry>
 445       <varlistentry>
 446         <term>--version</term>
 447         <listitem>
 448           <para>
 449             Print version information.
 450           </para>
 451         </listitem>
 452       </varlistentry>
 453     </variablelist>
 454   </refsect1>
 455   <refsect1>
 456     <title>LINKS</title>
 457     <para>
 458       <ulink url="http://www.freerdp.com/">http://www.freerdp.com/</ulink>
 459     </para>
 460   </refsect1>
 461 </refentry>