
Syntax for configuring RDP redirection modules
==============================================

General
-------

All redirection is configured using the -r option. The general syntax
is:

-r <module>:<string>

<module> is the name of the redirection module. The following names
are valid: disk, printer, lptport, comport, clipboard, sound. 

<string> is interpreted by each redirection module. 

The redirection modules are described below.


disk mapping
-------------
Multiple mappings possible: yes
Default: no disk redirected
Syntax: -r disk:<sharename>=<path>
Example: -r disk:home=/home/johndoe


printer mapping
---------------
Multiple mappings possible: yes
Default: no printers redirected
Syntax: -r printer:<printername>[=<driver>]
Example: -r printer:mydeskjet

The optional driver name is the driver that the server should use for the
redirected printer. If omitted, rdesktop asks for a simple PostScript driver.
Printer redirection passes the server-generated printer data to the local
print queue. If the selected server-side driver generates data that the local
queue or printer cannot handle, the printer can output unreadable pages. In
that case, select a matching server-side driver or configure the local queue to
accept the generated format.



LPT port mapping
----------------
Multiple mappings possible: yes
Default: no LPT ports redirected
Syntax: -r lptport:<lptport>=<device>
Example: -r lptport:LPT1=/dev/lp0


COM port mapping
----------------
Multiple mappings possible: yes
Default: no COM ports redirected
Syntax: -r comport:<comport>=<device>
Example: -r comport:COM1=/dev/ttyS0


clipboard mapping
-----------------
Multiple mappings possible: no
Default: yes
Syntax: -r clipboard:[yes|no]
Example: -r clipboard:no


sound mapping
-------------
Multiple mappings possible: no
Default: off
Syntax: -r sound:[local|off|remote]

"local" means "Bring to this computer"
"off" means "Do not play"
"remote" means "Leave at remote computer"

Example: -r sound:remote




Microphone input
================

When sound redirection is enabled with `-r sound:local`, rdesktop also registers
the RDP AUDIO_INPUT dynamic virtual channel. If the server requests microphone
recording and the selected local audio driver supports capture, rdesktop opens
the local recording device and sends PCM audio to the server. The PulseAudio and
ALSA drivers provide capture hooks.
