Manpage

[Spark <spark@xxxxxxxx>]

Hey guys,

i noticed there wasn't a manpage yet. Since rdesktop is stable i think it
needs one. Here is my attempt at writing a manpage.

Matt, if you want to include this in the distro, but want things changed
contact me. I'll be happy to make the changes.

Greetings,

Hugo



--------------------------------------------------------------
"That i'm paranoid doesn't mean they aren't out to get me!"
--------------------------------------------------------------
Hugo Trippaers (HT2-6BONE)      ISION Internet BV
System Engineer (RHCE)          http://www.ision.nl
spark@ision.nl
.TH RDESKTOP 1 "Januari 2001" "Manual page for rdesktop"
.\"
.\" 5th Januari 2001
.\" Man page author:
.\"    Hugo Trippaers <spark@ision.nl>
.\"
.SH NAME
.I rdesktop
\- terminal server client for Windows NT4 and Windows 2000
.SH SYNOPSIS
.B rdesktop
\-n <hostname> [options] server
.br
.SH DESCRIPTION
.I rdesktop
acts as a window terminal services client for Windows NT terminal servers and Windows 2000 terminal services either in administration or licenced mode. rdesktop implements the RDP version 4 protcol as used by Windows NT4 Terminalserver. Various mailinglistmembers wrote patches for rdesktop which implement RDP version 5. RDP 5 is used by Windows 2000 Terminal Services. At this time the patches are not merged in the main codebase but distributed seperately. See the links section for URLS.
.SH OPTIONS
.TP
.BR "-u"
The username for authentication on the terminal server, together with -p this can be used for autologon. On win2k the username is prefilled on the username box.
.TP
.BR "-d"
The domain to to which the user belongs. Use -u user@domain for win2k servers.
.TP
.BR "-s"
The startup shell for the user. Use this to force the user to start a specific shell of program after startup.
.TP
.BR "-c"
The current working directory for the user. Often used in combination with -s to setup a fixed enviroment for the user after logon.
.TP
.BR "-p"
The passwork to authenticate with, used in combination with -u for autologon.
.TP
.BR "-n"
The name of the current machine rdesktop is running on. Ussualy the hostname (without the domain).
.TP
.BR "-w"
Width of the remote desktop.
.TP
.BR "-h"
Height of the remote desktop.
.TP
.BR "-k"
The keyboard layout for the rdesktop session. i.e. us, is or nl
.TP
.BR "-b"
Use this switch to force bitmap updates.
.TP
.BR "-m"
Disable the sending of motion events.
.TP
.BR "-l"
Do not request licence
.TP
.BR "-e"
Do not use encryption
.TP
.BR "-4"
Specify -4 make rdesktop try the connection with RDP4 for Windows NT4 Terminal Servers. The default is RDP5 used by Windows 2000 Terminal Services.
.TP
.BR "-D"
The bits per pixel. This is not yet detected by the client, make this the same as the BPP of the Xserver.
.TP
.BR "-B"
Disable bitmap compression.
.SH EXAMPLES
.PP
.br
Connect to a Windows 2000 Server called asp from a box called tux.
.br
\fI% rdesktop \-n tux asp.mydomain.com
.PP
.br
Connect to a Windows 2000 Server called asp and automagically start Word.
.br
\fI% rdesktop -n tux -u worduser -p secret -s winword.exe asp.mydomain.com
.br
.PP
.br
Connect to a Windows NT4 Terminal server
.br
\fI% rdesktop -n tux -4 terminal.mydomain.com
.br
.PP
.SH "RETURN VALUES"
None are defined (yet)
.SH LINKS
Main website of rdesktop
.br
\fIhttp://www.rdesktop.org
.LP
The unified patch can be found here
.br
\fIhttp://bibl4.oru.se/projects/rdesktop
.LP
The mailinglist
.br
rdesktop@cifs.org
.LP
.SH BUGS
Probably too many to list here. We suggest you visit the website at http://www.rdesktop.org and take a look at the mailinglist archives to find out about the latest news, bugs and fixes.
.SH VERSION
This manual page documents version 1.0.0/patch 18-3 
.SH AUTHOR
rdesktop is written by Matt Chapman 
.br
<matthewc@cse.unsw.edu.au>
.LP
unified patch by Peter Bystrom 
.br
<peter.bystrom@ub.oru.se>
.LP
manual page by Hugo Trippaers 
.br
<spark@ision.nl>
.br
.SH THANKS
Thanks to all the mailinglist members for their contributions to rdesktop.
.PP