--- sourceforge.net/trunk/rdesktop/doc/rdesktop.1 2002/10/06 13:30:30 213 +++ sourceforge.net/trunk/rdesktop/doc/rdesktop.1 2005/06/30 22:29:16 936 @@ -1,106 +1,186 @@ -.TH RDESKTOP 1 "September 2002" "Manual page for rdesktop" -.\" -.\" Man page author: -.\" Hugo Trippaers -.\" Peter Åstrand +.TH rdesktop 1 "March 2005" .SH NAME .I rdesktop \- Remote Desktop Protocol client .SH SYNOPSIS -.B rdesktop [options] server +.B rdesktop [options] server[:port] .br .SH DESCRIPTION .I rdesktop -is a client for Windows NT4 Terminal Server and Windows 2000 Terminal -Services. rdesktop implements the RDP version 4 protocol, which used -by Windows NT4 Terminal Server, and parts of RDP version 5, which is -used by Windows 2000 Terminal Services. +is a client for Remote Desktop Protocol (RDP), used in a number of Microsoft +products including Windows NT Terminal Server, Windows 2000 Server, Windows XP +and Windows 2003 Server. .SH OPTIONS .TP .BR "-u " -The username for authentication on the terminal server, together with -p -this can be used for autologon. +Username for authentication on the server. .TP .BR "-d " -The domain to to which the user belongs. +Domain for authentication. .TP .BR "-s " -The startup shell for the user. Use this to start a specific application, -instead of a regular desktop. +Startup shell for the user - starts a specific application instead of Explorer. .TP .BR "-c " -The current working directory for the user. Often used in combination with -s -to setup a fixed environment for the user after logon. +The initial working directory for the user. Often used in combination with -s +to set up a fixed login environment. .TP .BR "-p " -The password to authenticate with. Use -p - to make rdesktop request a -password at startup (from standard input). -WARNING: if you specify a password on the command line it may be visible -to other users when they use tools like ps. -.TP -.BR "-n " -Client name. The default is the hostname. +The password to authenticate with. Note that this may have no effect if +"Always prompt for password" is enabled on the server. WARNING: if you specify +a password on the command line it may be visible to other users when they use +tools like ps. Use -p - to make rdesktop request a password at startup (from +standard input). +.TP +.BR "-n " +Client hostname. Normally rdesktop automatically obtains the hostname of the +client. .TP .BR "-k " -keyboard layout on terminal server (us,sv,gr etc.) +Keyboard layout to emulate. This requires a corresponding keymap file to be +installed. The standard keymaps provided with rdesktop follow the RFC1766 +naming scheme: a language code followed by a country code if necessary - e.g. +en-us, en-gb, de, fr, sv, etc. The default is en-us (a US keyboard). .TP .BR "-g " -Desktop geometry (WxH). +Desktop geometry (WxH). If geometry is the special word "workarea", the geometry +will be fetched from the extended window manager hints property _NET_WORKAREA, from +the root window. The geometry can also be specified as a percentage of the whole +screen, e.g. "-g 80%". .TP .BR "-f" -Enable fullscreen mode. The -g option will be ignored when using -f, -rdesktop will get the current height and width from the current -desktop. +Enable fullscreen mode. This overrides the window manager and causes the +rdesktop window to fully cover the current screen. Fullscreen mode can be +toggled at any time using Ctrl-Alt-Enter. .TP .BR "-b" -Force bitmap updates. +Force the server to send screen updates as bitmaps rather than using +higher-level drawing operations. +.TP +.BR "-B" +Use the BackingStore of the Xserver instead of the integrated one in +rdesktop. .TP .BR "-e" -Do not use encryption, this is only for people who are not allowed to -use encryption in Windows products. If you live in France you -probably need this switch. +Disable encryption. This option is only needed (and will only work) if you +have a French version of NT TSE. +.TP +.BR "-E" +Disable encryption from client to server. This sends an encrypted login packet, +but everything after this is unencrypted (including interactive logins). .TP .BR "-m" -Do not send motion events. +Do not send mouse motion events. This saves bandwidth, although some Windows +applications may rely on receiving mouse motion. .TP -.BR "-l" -Do not request licence. +.BR "-C" +Use private colourmap. This will improve colour accuracy on an 8-bit display, +but rdesktop will appear in false colour when not focused. .TP -.BR "-t " -Connect to this TCP port. The default is 3389. +.BR "-D" +Hide window manager decorations, by using MWM hints. .TP .BR "-K" -Keep window manager key bindings. +Do not override window manager key bindings. By default rdesktop attempts +to grab all keyboard input when it is in focus. .TP -.BR "-w " -Set window title to <title>. +.BR "-S <button size>" +Enable single application mode. This option can be used when running a +single, maximized application (via -s). When the minimize button of +the windows application is pressed, the rdesktop window is minimized +instead of the remote application. The maximize/restore button is +disabled. For this to work, you must specify the correct button +size, in pixels. The special word "standard" means 18 pixels. +.TP +.BR "-T <title>" +Sets the window title. +.TP +.BR "-N" +Enable numlock syncronization between the Xserver and the remote RDP +session. This is useful with applications that looks at the numlock +state, but might cause problems with some Xservers like Xvnc. +.TP +.BR "-X <windowid>" +Embed rdesktop-window in another window. The windowid is expected to +be decimal or hexadecimal (prefixed by 0x). +.TP +.BR "-a <bpp>" +Sets the colour depth for the connection (8, 15, 16 or 24). +More than 8 bpp are only supported when connecting to Windows XP +(up to 16 bpp) or newer. Note that the colour depth may also be +limited by the server configuration. +.TP +.BR "-z" +Enable compression of the RDP datastream. +.TP +.BR "-x <experience>" +Changes default bandwidth performance behaviour for RDP5. By default only +theming is enabled, and all other options are disabled (corresponding +to modem (56 Kbps)). Setting experience to b[roadband] enables menu +animations and full window dragging. Setting experience to l[an] will +also enable the desktop wallpaper. Setting experience to m[odem] +disables all (including themes). Experience can also be a hexidecimal +number containing the flags. +.TP +.BR "-P" +Enable caching of bitmaps to disk (persistent bitmap caching). This generally +improves performance (especially on low bandwidth connections) and reduces +network traffic at the cost of slightly longer startup and some disk space. +(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour +sessions) +.TP +.BR "-r <device>" +Enable redirection of the specified device on the client, such +that it appears on the server. Note that the allowed +redirections may be restricted by the server configuration. +Following devices are currently supported: +.TP +.BR "-r comport:<comport>=<device>,..." +Redirects serial devices on your client to the +server. Note that if you need to change any settings on the serial device(s), +do so with an appropriate tool before starting rdesktop. In most +OSes you would use stty. Bidirectional/Read support requires Windows XP or newer. +In Windows 2000 it will create a port, but it's not seamless, most +shell programs will not work with it. +.TP +.BR "-r disk:<sharename>=<path>,..." +Redirects a path to the share \\\\tsclient\\<sharename> on the server +(requires Windows XP or newer). The share name is limited to 8 +characters. +.TP +.BR "-r lptport:<lptport>=<device>,..." +Redirects parallel devices on your client to the server. +Bidirectional/Read support requires Windows XP or newer. In Windows 2000 +it will create a port, but it's not seamless, most shell programs will not work with +it. +.TP +.BR "-r printer:<printername>[=<driver>],..." +Redirects a printer queue on the client to the server. The <printername> +is the name of the queue in your local system. <driver> defaults to a +simple PS-driver unless you specify one. Keep in mind that you need a +100% match in the server environment, or the driver will fail. The first +printer on the command line will be set as your default printer. +.TP +.BR "-r sound:[local|off|remote]" +Redirects sound generated on the server to the client. "remote" only has +any effect when you connect to the console with the -0 option. (Requires +Windows XP or newer). +.TP +.BR "-0" +Attach to the console of the server (requires Windows Server 2003 +or newer). +.TP +.BR "-4" +Use RDP version 4. +.TP +.BR "-5" +Use RDP version 5 (default). .PP -.SH "RETURN VALUES" -None are defined (yet). .SH LINKS Main website of rdesktop .br -\fIhttp://www.rdesktop.org +\fIhttp://www.rdesktop.org/ .LP -.SH BUGS -We suggest you visit the website at http://www.rdesktop.org and follow -the links to the Bug Tracker. -.SH VERSION -This manual page documents version 1.2. -.SH AUTHOR -rdesktop is written by Matt Chapman <matthewc@cse.unsw.edu.au> -.LP -The following persons have contributed to the project: -.LP -Peter Bystrom <peter.bystrom@ub.oru.se> -.br -Hugo Trippaers <spark@ision.nl> -.br -Jay Sorg -.br -Peter Åstrand -.SH THANKS -Thanks to all the mailinglist members for their contributions to rdesktop. .PP