summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLaxmikant Rashinkar <LK.Rashinkar@gmail.com>2013-06-08 18:44:34 -0700
committerLaxmikant Rashinkar <LK.Rashinkar@gmail.com>2013-06-08 18:44:34 -0700
commit78498f66821fe68e4303836a09d42f7f11daaa21 (patch)
tree64692fe41a7407b98c104c5bb70ebcb91ef7351d /docs
parent6ad1d7f78d535d5095d639ae289b5f8d1084a399 (diff)
parentc6fa03102f40e655ba54d5910ad559a8799c15e7 (diff)
downloadxrdp-proprietary-78498f66821fe68e4303836a09d42f7f11daaa21.tar.gz
xrdp-proprietary-78498f66821fe68e4303836a09d42f7f11daaa21.zip
Merge branch 'master' of github.com:neutrinolabs/xrdp
Diffstat (limited to 'docs')
-rw-r--r--docs/man/Makefile.am25
-rw-r--r--docs/man/sesman.ini.571
-rw-r--r--docs/man/xrdp-chansrv.846
-rw-r--r--docs/man/xrdp-dis.123
-rw-r--r--docs/man/xrdp-genkeymap.867
-rw-r--r--docs/man/xrdp-keygen.840
-rw-r--r--docs/man/xrdp-sesadmin.857
-rw-r--r--docs/man/xrdp-sesman.831
-rw-r--r--docs/man/xrdp-sesrun.839
-rw-r--r--docs/man/xrdp-sessvc.826
-rw-r--r--docs/man/xrdp-xcon.814
-rw-r--r--docs/man/xrdp.818
-rw-r--r--docs/man/xrdp.ini.5217
13 files changed, 529 insertions, 145 deletions
diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am
index 2689407b..507809bd 100644
--- a/docs/man/Makefile.am
+++ b/docs/man/Makefile.am
@@ -1,14 +1,17 @@
-EXTRA_DIST = sesman.ini.5 xrdp.ini.5 xrdp.8 xrdp-sesman.8 xrdp-sesrun.8
-
-xrdpman5dir=$(mandir)/man5
-
-xrdpman5_DATA = \
+man_MANS = \
+ xrdp-dis.1 \
sesman.ini.5 \
- xrdp.ini.5
-
-xrdpman8dir=$(mandir)/man8
-
-xrdpman8_DATA = \
+ xrdp.ini.5 \
xrdp.8 \
+ xrdp-chansrv.8 \
+ xrdp-genkeymap.8 \
+ xrdp-keygen.8 \
+ xrdp-sesadmin.8 \
xrdp-sesman.8 \
- xrdp-sesrun.8
+ xrdp-sesrun.8 \
+ xrdp-sessvc.8
+
+noinst_man_MANS = \
+ xrdp-xcon.8
+
+EXTRA_DIST = $(man_MANS) $(noinst_man_MANS)
diff --git a/docs/man/sesman.ini.5 b/docs/man/sesman.ini.5
index ebefd120..2bf69297 100644
--- a/docs/man/sesman.ini.5
+++ b/docs/man/sesman.ini.5
@@ -1,10 +1,9 @@
.\"
.TH "sesman.ini" "5" "0.1.0" "xrdp team" ""
.SH "NAME"
-.LP
\fBsesman.ini\fR \- Configuration file for \fBsesman\fR(8)
+
.SH "DESCRIPTION"
-.LP
This is the man page for \fBsesman.ini\fR, \fBsesman\fR(8) configuration file.
It is composed by a number of sections, each one composed by a section name, enclosed by square brackets, folowed by a list of \fI<parameter>\fR=\fI<value>\fR lines.
@@ -29,49 +28,38 @@ All options and values (except for file names and paths) are case insensitive, a
For any of the following parameter, if it's specified more than one time the last entry encountered will be used.
\fBNOTE\fR: if any of these options is specified outside its section, it will be \fIignored\fR.
-.SH "GLOBALS"
-.LP
-.TP
+.SH "GLOBALS"
The options to be specified in the \fB[globals]\fR section are the following:
-.br
.TP
\fBListenAddress\fR=\fIip address\fR
Specifies sesman listening address. Default is 0.0.0.0 (all interfaces)
-.br
.TP
\fBListenPort\fR=\fIport number\fR
Specifies sesman listening port. Default is 3350
-.br
.TP
\fBEnableUserWindowManager\fR=\fI[0|1]\fR
If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables user specific window manager, that is, anyone can define it's own script executed by sesman when starting a new session, specified by \fBUserWindowManager\fR
-.br
.TP
\fBUserWindowManager\fR=\fIstartwm.sh\fR
This option specifies the script run by sesman when starting a session and per\-user window manager is enabled.
.br
The path is relative to user's HOME directory
-.br
.TP
\fBDefaultWindowManager\fR=\fI${SESMAN_BIN_DIR}/startwm.sh\fR
This contains full path to the default window manager startup script used by sesman to start a session
-.SH "LOGGING"
-.LP
-.TP
+.SH "LOGGING"
The following parameters can be used in the \fB[logging]\fR section:
-.br
.TP
\fBLogFile\fR=\fI${SESMAN_LOG_DIR}/sesman.log\fR
This options contains the path to logfile. It can be either absolute or relative, and the default is \fI${SESMAN_LOG_DIR}/sesman.log\fR
-.br
.TP
\fBLogLevel\fR=\fIlevel\fR
@@ -86,41 +74,33 @@ This option can have one of the following values:
\fBINFO\fR or \fB3\fR \- Logs errors, warnings and informational messages
\fBDEBUG\fR or \fB4\fR \- Log everything. If \fBsesman\fR is compiled in debug mode, this options will output many more low\-level message, useful for developers
-.br
.TP
\fBEnableSyslog\fR=\fI[0|1]\fR
If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables logging to syslog. Otherwise syslog is disabled.
-.br
.TP
\fBSyslogLevel\fR=\fIlevel\fR
This option sets the logging level for syslog. It can have the same values of \fBLogLevel\fR. If \fBSyslogLevel\fR is greater than \fBLogLevel\fR, its value is lowered to that of \fBLogLevel\fR.
-.SH "SESSIONS"
-.LP
-.TP
+.SH "SESSIONS"
The following parameters can be used in the \fB[Sessions]\fR section:
-.br
.TP
\fBX11DisplayOffset\fR=\fI<number>\fR
-Specifies the first X display number available for sesman(8). This prevents sesman from interfering with real X11 servers. The default is 10.
-.br
+Specifies the first X display number available for \fBsesman\fP(8). This prevents sesman from interfering with real X11 servers. The default is 10.
.TP
\fBMaxSessions\fR=\fI<number>\fR
Sets the maximum number of simultaneous session on terminal server.
.br
If unset or set to \fI0\fR, unlimited session are allowed.
-.br
.TP
\fBKillDisconnected\fR=\fI[0|1]\fR
If set to \fB1\fR, \fBtrue\fR or \fByes\fR, every session will be killed when the user disconnects.
.br
\fI\-this option is currently ignored!\-\fR
-.br
.TP
\fBIdleTimeLimit\fR=\fI<number>\fR
@@ -129,7 +109,6 @@ Sets the the time limit before an idle session is disconnected.
If set to \fI0\fR, automatic disconnection is disabled.
.br
\fI\-this option is currently ignored!\-\fR
-.br
.TP
\fBDisconnectedTimeLimit\fR=\fI<number>\fR
@@ -138,87 +117,67 @@ Sets the the time limit before a disconnected session is killed.
If set to \fI0\fR, automatic killing is disabled.
.br
\fI\-this option is currently ignored!\-\fR
-.br
-.SH "SECURITY"
-.LP
-.TP
+.SH "SECURITY"
The following parameters can be used in the \fB[Sessions]\fR section:
-.br
.TP
\fBAllowRootLogin\fR=\fI[0|1]\fR
If set to \fB1\fR, \fBtrue\fR or \fByes\fR enables root login on the terminal server
-.br
.TP
\fBMaxLoginRetry\fR=\fI[0|1]\fR
The number of login attempts that are allowed on terminal server. If set to \fI0\fR, unlimited attempts are allowed. The default value for this field is \fI3\fR.
-.br
.TP
\fBTerminalServerUsers\fR=\fItsusers\fR
Only the users belonging to the group \fItsusers\fR are allowed to login on terminal server.
.br
If unset or set to an invalid or non\-existent group, login for all users is enabled.
-.br
.TP
\fBTerminalServerAdmins\fR=\fItsadmins\fR
Sets the group which a user shall belong to have session management rights.
.br
\fI\-this option is currently ignored!\-\fR
-.br
+
.SH "EXAMPLES"
-.LP
This is an example \fBsesman.ini\fR:
+.nf
[Globals]
-.br
ListenAddress=127.0.0.1
-.br
ListenPort=3350
-.br
EnableUserWindowManager=1
-.br
UserWindowManager=startwm.sh
-.br
DefaultWindowManager=startwm.sh
[Logging]
-.br
LogFile=/usr/local/xrdp/sesman.log
-.br
LogLevel=DEBUG
-.br
EnableSyslog=0
-.br
SyslogLevel=DEBUG
[Sessions]
-.br
MaxSessions=10
-.br
KillDisconnected=0
-.br
IdleTimeLimit=0
-.br
DisconnectedTimeLimit=0
[Security]
-.br
AllowRootLogin=1
-.br
MaxLoginRetry=3
-.br
TerminalServerUsers=tsusers
-.br
TerminalServerAdmins=tsadmins
+.fi
+
.SH "FILES"
-.LP
${SESMAN_CFG_DIR}/sesman.ini
+
.SH "SEE ALSO"
-.LP
-sesman(8) sesrun(8) xrdp(8) xrdp.ini(5)
+.BR sesman (8),
+.BR sesrun (8),
+.BR xrdp (8),
+.BR xrdp.ini (5)
for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-chansrv.8 b/docs/man/xrdp-chansrv.8
new file mode 100644
index 00000000..aa4747d8
--- /dev/null
+++ b/docs/man/xrdp-chansrv.8
@@ -0,0 +1,46 @@
+.TH "xrdp\-chansrv" "8" "0.7.0" "xrdp team" ""
+.SH "NAME"
+\fBxrdp\-chansrv\fR \- \fBxrdp\fR channel server
+
+.SH "SYNTAX"
+.B xrdp\-chansrv
+
+.SH "DESCRIPTION"
+\fBxrdp\-chansrv\fR is the \fBxrdp\fR(8) channel server, which manages the Remote Desktop Protocol (RDP) sub-channels.
+This program is only forked internally by \fBxrdp\-sesman\fP(8).
+.br
+Currently \fBxrdp\-chansrv\fP knows about the following channels:
+.RE 8
+.TP
+.B cliprdr
+Clipboard Redirection
+.TP
+.B rdpsnd
+Remote Desktop Protocol Sound
+.TP
+.B rdpdr
+Remote Desktop Protocol Device Redirection
+.TP
+.B rail
+Remote Applications Integrated Locally
+.TP
+.B drdynvc
+Dynamic Virtual Channel
+.RS
+
+.SH FILES
+.TP
+.I /tmp/.xrdp/xrdp_chansrv_socket_*
+UNIX socket used by external programs to implement channels.
+.TP
+.I /tmp/.xrdp/xrdp_api_*
+UNIX socket used by \fBxrdp\-chansrv\fP to communicate with \fBxrdp\-sesman\fP.
+.TP
+.I $HOME/xrdp-chansrv.log
+Log file used by \fBxrdp\-chansrv\fP(8).
+
+.SH "SEE ALSO"
+.BR xrdp\-sesman (8),
+.BR sesman.ini (5).
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-dis.1 b/docs/man/xrdp-dis.1
new file mode 100644
index 00000000..089621ae
--- /dev/null
+++ b/docs/man/xrdp-dis.1
@@ -0,0 +1,23 @@
+.TH "xrdp-dis" "8" "0.7.0" "xrdp team"
+.SH NAME
+xrdp\-dis \- xrdp disconnect utility
+
+.SH SYNOPSIS
+.B xrdp\-dis
+
+.SH DESCRIPTION
+.PP
+\fBxrdp\-dix\fP is run with no parameters to disconnect your xrdp session.
+
+.SH ENVIRONMENT
+.TP
+.B DISPLAY
+to get the default host and display number.
+
+.SH FILES
+.TP
+.I /tmp/.xrdp/xrdp_disconnect_display_*
+UNIX socket used to communicate with the \fBxrdp\fP(8) session manager.
+
+.SH SEE ALSO
+.BR xrdp (1).
diff --git a/docs/man/xrdp-genkeymap.8 b/docs/man/xrdp-genkeymap.8
new file mode 100644
index 00000000..068f04dd
--- /dev/null
+++ b/docs/man/xrdp-genkeymap.8
@@ -0,0 +1,67 @@
+.TH "xrdp\-genkeymap" "8" "0.1.0" "xrdp team" ""
+.de URL
+. \\$2 \(laURL: \\$1 \(ra\\$3
+..
+.if \n[.g] .mso www.tmac
+
+.SH "NAME"
+\fBxrdp\-genkeymap\fR \- key map generator for XRDP
+
+.SH "SYNTAX"
+.B xrdp\-genkeymap
+.I file
+
+.SH "DESCRIPTION"
+\fBxrdp\-genkeymap\fR extracts the key map used by the currently running X session to generated a mapping from Remote Desktop Protocol (RDP) key codes to X keysyms and Unicode code points.
+
+.SH OPTIONS
+.TP
+.I outfile
+The key map information is stored in the file named \fIoutfile\fP.
+
+.SH "FILES"
+.TP
+.I /etc/xrdp/km-XXXX.ini
+Files containing the keyboard mapping for language \fIXXXX\fP, which is a 4 digit hexadecimal number identifying the country and language code.
+.RS 8
+.TP
+.B 0405
+cs czech
+.TP
+.B 0407
+de german
+.TP
+.B 0409
+en-us us english
+.TP
+.B 040c
+fr french
+.TP
+.B 0410
+it italy
+.TP
+.B 0416
+br Portuguese (Brazil)
+.TP
+.B 0419
+ru russian
+.TP
+.B 041d
+se swedish
+.TP
+.B 0809
+en-uk uk english
+.RE
+
+.SH "AUTHORS"
+Jay Sorg <jsorg71@users.sourceforge.net>
+.br
+Simone Fedele <ilsimo@users.sourceforge.net>
+
+.SH "SEE ALSO"
+.BR xrdp (8),
+.BR setxkbmap (1),
+.BR unicode (7),
+.URL "https://github.com/FreeRDP/FreeRDP/wiki/Keyboard" "Description of Keyboard Input mapping" .
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-keygen.8 b/docs/man/xrdp-keygen.8
new file mode 100644
index 00000000..71269f5c
--- /dev/null
+++ b/docs/man/xrdp-keygen.8
@@ -0,0 +1,40 @@
+.\" Hey, EMACS: -*- nroff -*-
+.TH xrdp\-keygen 8 "0.7.0" "xrdp team"
+.SH NAME
+xrdp\-keygen \- xrdp RSA key generation utility
+
+.SH SYNOPSIS
+.B xrdp\-keygen xrdp
+< \fIoutfile\fP | \fBauto\fP >
+.br
+.B xrdp\-keygen test
+
+.SH DESCRIPTION
+\fBxrdp\-keygen\fP generates the file
+.I /etc/xrdp/rsakeys.ini
+which contains the RSA key pair used to perform authentication to
+remote clients. The public key is self-signed.
+
+.SH OPTIONS
+This program takes one of the following options:
+.TP
+\fBxrdp\fP \fIoutfile\fP
+Generate a new key pair.
+The key data is stored in the file named \fIoutfile\fP.
+.br
+If \fBauto\fP is used as \fIoutfile\fP, the default file \fI/etc/xrdp/rsakeys.ini\fP gets created if it does not yet exists.
+.TP
+.B test
+Generate a test key pair and print information to standard output.
+
+.SH FILES
+.TP
+.I /etc/xrdp/rsakeys.ini
+RSA public and private key pair used to identify this XRDP server.
+
+.SH SEE ALSO
+.BR xrdp (8),
+.BR xrdp\-sesman (8).
+
+.SH AUTHOR
+This manual page was originally written by Vincent Bernat <bernat@luffy.cx>.
diff --git a/docs/man/xrdp-sesadmin.8 b/docs/man/xrdp-sesadmin.8
new file mode 100644
index 00000000..ade1dd58
--- /dev/null
+++ b/docs/man/xrdp-sesadmin.8
@@ -0,0 +1,57 @@
+.TH "xrdp-sesadmin" "8" "0.7.0" "xrdp team"
+.SH NAME
+xrdp\-sesadmin \- console XRDP sessions administration tool
+
+.SH SYNOPSIS
+.B xrdp\-sesadmin
+.RI [ options ]
+.BI -c= command
+
+.SH DESCRIPTION
+This manual page documents briefly the
+.B xrdp\-sesadmin
+command.
+.PP
+\fBxrdp\-sesadmin\fP is a console program to administer running XRDP sessions.
+
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.BI \-u= username
+\fIUsername\fP for authentication on the server.
+Defaults to \fBroot\fP.
+
+.TP
+.BI \-p= password
+The \fIpassword\fP to authenticate with.
+The default is to ask for the password interactively.
+
+.TP
+.BI \-s= server
+The host address of the \fIserver\fP to connect to.
+Defaults to \fBlocalhost\fP.
+
+.TP
+.BI \-i= port
+The TCP \fIport\fP number to connect to.
+Defaults to \fB3350\fP.
+
+.TP
+.BI \-c= command
+Specifies the \fIcommand\fP to execute on the server.
+Valid commands are:
+.RS 4
+.TP
+.B list
+List currently active sessions.
+.TP
+.BI kill: sid
+Kills the session specified the given \fIsession id\fP.
+(not yet implemented).
+.RE
+
+.SH FILES
+xrdp\-sesadmin.log
+
+.SH SEE ALSO
+.BR xrdp (8).
diff --git a/docs/man/xrdp-sesman.8 b/docs/man/xrdp-sesman.8
index a224c639..9316e926 100644
--- a/docs/man/xrdp-sesman.8
+++ b/docs/man/xrdp-sesman.8
@@ -1,28 +1,28 @@
-.TH "sesman" "8" "0.1.0" "xrdp team" ""
+.TH "xrdp\-sesman" "8" "0.1.0" "xrdp team" ""
.SH "NAME"
-.LP
-\fBsesman\fR \- \fBxrdp\fR(8) session manager
+xrdp\-sesman \- \fBxrdp\fR(8) session manager
+
.SH "SYNTAX"
-.LP
-sesman [ \-\-nodaemon | \-\-kill | \-\-help ]
+.B xrdp\-sesman
+.RB [ \-\-nodaemon | \-\-kill | \-\-help ]
+
.SH "DESCRIPTION"
-.LP
-\fBsesman\fR is \fBxrdp\fR(8) session manager.
+\fBxrdp\-sesman\fR is \fBxrdp\fR(8) session manager.
.br
It manages user sessions by authenticating the user and starting the appropriate Xserver
+
.SH "OPTIONS"
-.LP
.TP
\fB\-n\fR, \fB\-\-nodaemon\fR
-Starts \fBsesman\fR in foreground instead of starting it as a daemon.
+Starts \fBxrdp\-sesman\fR in foreground instead of starting it as a daemon.
.TP
\fB\-k\fR, \fB\-\-kill\fR
-Kills running \fBsesman\fR daemon.
+Kills running \fBxrdp\-sesman\fR daemon.
.TP
\fB\-h\fR, \fB\-\-help\fR
Output help information and exit.
+
.SH "FILES"
-.LP
${SESMAN_BIN_DIR}/sesman
.br
${SESMAN_BIN_DIR}/sesrun
@@ -32,13 +32,16 @@ ${SESMAN_CFG_DIR}/sesman.ini
${SESMAN_LOG_DIR}/sesman.log
.br
${SESMAN_PID_DIR}/sesman.pid
+
.SH "AUTHORS"
-.LP
Jay Sorg <jsorg71@users.sourceforge.net>
.br
Simone Fedele <ilsimo@users.sourceforge.net>
+
.SH "SEE ALSO"
-.LP
-sesman.ini(5) sesrun(8) xrdp(8) xrdp.ini(5)
+.BR sesman.ini (5),
+.BR xrdp\-sesrun (8),
+.BR xrdp (8),
+.BR xrdp.ini (5)
for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-sesrun.8 b/docs/man/xrdp-sesrun.8
index 5a1b2bdf..c48c7eb5 100644
--- a/docs/man/xrdp-sesrun.8
+++ b/docs/man/xrdp-sesrun.8
@@ -1,47 +1,50 @@
-.TH "sesrun" "8" "0.1.0" "xrdp team" ""
+.TH "xrdp\-sesrun" "8" "0.7.0" "xrdp team" ""
.SH "NAME"
-.LP
-\fBsesrun\fR \- \fBsesman\fR(8) session launcher
+xrdp\-sesrun \- \fBsesman\fR(8) session launcher
+
.SH "SYNTAX"
-.LP
-sesrun <server> <username> <password> <width> <height> <bpp>
+.B xrdp\-sesrun
+.I server username password width height bpp
+
.SH "DESCRIPTION"
-.LP
-\fBsesrun\fR starts a session using \fBsesman\fR(8).
+\fBxrdp\-sesrun\fR starts a session using \fBxrdp\-sesman\fR(8).
.br
This is a tool useful for testing, it simply behaves like xrdp when some user logs in a new session and authenticates, thus starting a new session.
+
.SH "OPTIONS"
-.LP
.TP
-<server>
+.I server
Server on which sesman is running
.TP
-<username>
+.I username
user name of the session being started
.TP
-<password>
+.I password
user password
.TP
-<width>
+.I width
Screen width
.TP
-<height>
+.I height
Screen height
.TP
-<bpp>
+.I bpp
Session color depth
+
.SH "FILES"
-.LP
${SESMAN_BIN_DIR}/sesman
.br
${SESMAN_BIN_DIR}/sesrun
+
.SH "AUTHORS"
-.LP
Jay Sorg <jsorg71@users.sourceforge.net>
.br
Simone Fedele <ilsimo@users.sourceforge.net>
+
.SH "SEE ALSO"
-.LP
-sesman(8) sesman.ini(5) xrdp(8) xrdp.ini(5)
+.BR xrdp\-sesman (8),
+.BR sesman.ini (5),
+.BR xrdp (8),
+.BR xrdp.ini (5)
for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-sessvc.8 b/docs/man/xrdp-sessvc.8
new file mode 100644
index 00000000..322c968a
--- /dev/null
+++ b/docs/man/xrdp-sessvc.8
@@ -0,0 +1,26 @@
+.TH "xrdp\-sessvc" "8" "0.7.0" "xrdp team" ""
+.SH "NAME"
+xrdp\-sessvc \- \fBxrdp\fR session supervisor
+
+.SH "SYNTAX"
+.B xrdp\-sessman
+.I x_pid wm_pid
+
+.SH "DESCRIPTION"
+\fBxrdp\-sessvc\fR is the \fBxrdp\fR(8) session supervisor, which monitors the running X server and Windows Manager.
+As soon as one of them quits, the other process is terminated as well.
+.br
+This program is only executed internally by \fBxrdp\-sesman\fP(8).
+
+.SH "OPTIONS"
+.TP
+.I x_pid
+The process ID of the forked X server to monitor.
+.TP
+.I wm_pid
+The process ID of the forked Window Manager to monitor.
+
+.SH "SEE ALSO"
+.BR xrdp\-sesrun (8).
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp-xcon.8 b/docs/man/xrdp-xcon.8
new file mode 100644
index 00000000..9d83b646
--- /dev/null
+++ b/docs/man/xrdp-xcon.8
@@ -0,0 +1,14 @@
+.TH "xrdp-xcon" "8" "0.7.0" "xrdp team"
+.SH NAME
+xrdp\-xcon \- X11 event loop debugging helper for XRDP
+
+.SH SYNOPSIS
+.B xrdp\-xcon
+
+.SH DESCRIPTION
+.PP
+\fBxrdp\-xcon\fP is a X application, which just opens a connection to the X server and polls for events.
+It's pretty useless.
+
+.SH SEE ALSO
+.BR xev (1).
diff --git a/docs/man/xrdp.8 b/docs/man/xrdp.8
index b8e0d7fd..6db90076 100644
--- a/docs/man/xrdp.8
+++ b/docs/man/xrdp.8
@@ -1,19 +1,18 @@
.TH "xrdp" "8" "0.1.0" "xrdp team" ""
.SH "NAME"
-.LP
\fBxrdp\fR \- a Remote Desktop Protocol (RDP) server
+
.SH "SYNTAX"
-.LP
xrdp [ \-\-nodaemon | \-\-kill | \-\-help ]
+
.SH "DESCRIPTION"
-.LP
\fBxrdp\fR is a Remote Desktop Protocol (RDP) Server.
.br
Unlike Windows NT/2000/2003 server, \fBxrdp\fR will not display a Windows desktop but an X window desktop to the user.
It can also be used as a VNC\->RDP bridge.
+
.SH "OPTIONS"
-.LP
.TP
\fB\-n\fR, \fB\-\-nodaemon\fR
Starts \fBxrdp\fR in foreground instead of starting it as a daemon.
@@ -23,8 +22,8 @@ Kills running \fBxrdp\fR daemon.
.TP
\fB\-h\fR, \fB\-\-help\fR
Output help information and exit.
+
.SH "FILES"
-.LP
${XRDP_BIN_DIR}/xrdp
.br
${XRDP_CFG_DIR}/xrdp.ini
@@ -32,13 +31,16 @@ ${XRDP_CFG_DIR}/xrdp.ini
${XRDP_LOG_DIR}/xrdp.log
.br
${XRDP_PID_DIR}/xrdp.pid
+
.SH "AUTHORS"
-.LP
Jay Sorg <jsorg71@users.sourceforge.net>
.br
Simone Fedele <ilsimo@users.sourceforge.net>
+
.SH "SEE ALSO"
-.LP
-xrdp.ini(5) sesman(8) sesman.ini(5) sesrun(8)
+.BR xrdp.ini (5),
+.BR sesman (8),
+.BR sesman.ini (5),
+.BR sesrun (8)
for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp.ini.5 b/docs/man/xrdp.ini.5
index f46b5609..7b32a9f0 100644
--- a/docs/man/xrdp.ini.5
+++ b/docs/man/xrdp.ini.5
@@ -1,99 +1,240 @@
-.\"
-.TH "xrdp.ini" "5" "0.1.0" "xrdp team" ""
+.TH "xrdp.ini" "5" "0.7.0" "xrdp team" ""
.SH "NAME"
-.LP
\fBxrdp.ini\fR \- Configuration file for \fBxrdp\fR(8)
+
.SH "DESCRIPTION"
-.LP
This is the man page for \fBxrdp.ini\fR, \fBxrdp\fR(8) configuration file.
-It is composed by a number of sections, each one composed by a section name, enclosed by square brackets, folowed by a list of \fI<parameter>\fR=\fI<value>\fR lines.
+It is composed by a number of sections, each one composed by a section name, enclosed by square brackets, followed by a list of \fI<parameter>\fR=\fI<value>\fR lines.
+
+\fBxrdp.ini\fR supports the following sections:
+
+.TP
+\fB[Globals]\fP \- sets some global configuration settings for \fBxrdp\fR(8).
+
+.TP
+\fB[Logging]\fP \- logging subsystem parameters
+
+.TP
+\fB[Channels]\fP \- channel subsystem parameters
-\fBxrdp.ini\fR is contains a \fB[Globals]\fR section, which sets some global configuration settings for \fBxrdp\fR(8), and one or more "connection" sections which contain the info on which services \fBxrdp\fR(8) can connect to.
+.TP
+\fI[Connection]\fP \- contain the info on which services \fBxrdp\fR(8) can connect to.
.LP
All options and values (except for file names and paths) are case insensitive, and are described in detail below.
-.SH "GLOBALS"
-.LP
-.TP
+.SH "GLOBALS"
The options to be specified in the \fB[Globals]\fR section are the following:
-.br
-.TP
+.TP
+\fBaddress\fP=\fIip address\fP
+Specifies xrdp listening address. Default is 0.0.0.0 (all interfaces)
+
+.TP
+\fBautorun\fP=\fIsession_name\fP
+Automatically run the connection specified by \fIsession_name\fP, which must match a section as described below.
+By default a drop-down list with all available connections is shown.
+A connection can also be chosen by the connecting client by setting the \fBLOGIN DOMAIN\fP to a valid \fIsession name\fP.
+
+.TP
\fBbitmap_cache\fR=\fI[0|1]\fR
-If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap caching in \fBxrdp\fR(8)
-.br
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap caching in \fBxrdp\fR(8).
-.TP
+.TP
\fBbitmap_compression\fR=\fI[0|1]\fR
-If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap compression in \fBxrdp\fR(8)
-.SH "CONNECTIONS"
-.LP
-
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap compression in \fBxrdp\fR(8).
+
+.TP
+\fBbulk_compression\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables compression of bulk data in \fBxrdp\fR(8).
+
+.TP
+\fBchannel_code\fP=\fI[0|1]\fP
+If set to \fB0\fR, \fBfalse\fR or \fBno\fR this option disables all channels \fBxrdp\fR(8).
+See section \fBCHANNELS\fP below for more fine grained options.
+
+.TP
+\fBcrypt_level\fP=\fIlow|medium|high\fP
+.\" <http://blogs.msdn.com/b/openspecification/archive/2011/12/08/encryption-negotiation-in-rdp-connection.aspx>
+RDP connection are controlled by two encryption settings: \fIEncryption Level\fP and \fIEncryption Method\fP.
+The only supported \fIEncryption Method\fP is \fB40BIT_ENCRYPTION\fP, \fB128BIT_ENCRYPTION\fP and \fB56BIT_ENCRYPTION\fP are currently not supported.
+This option controls the \fIEncryption Level\fP:
+.RS 8
+.TP
+.B low
+All data sent from the client to the server is protected by encryption based on the maximum key strength supported by the client.
+.I This is the only level that the traffic sent by the server to client is not encrypted.
+.TP
+.B medium
+All data sent between the client and the server is protected by encryption based on the maximum key strength supported by the client.
+.TP
+.B high
+All data sent between the client and server is protected by encryption based on the server's maximum key strength.
+.RE
+
+.TP
+\fBfork\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR for each incoming connection \fBxrdp\fR(8) forks a sub-process instead of using threads.
+
+.TP
+\fBhidelogwindow\fP=\fI[0|1]\fP
+If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP will not show a window for log messages.
+
+.TP
+\fBmax_bpp\fP=\fI[8|15|16|24]\fP
+Limit the color depth by specifying the maximum number of bits per pixel.
+
+.TP
+\fBport\fP=\fIport\fP
+Specify TCP port to listen on for incoming connections.
+The default for RDP is \fB3389\fP.
+
+.TP
+\fBtcp_keepalive\fP=\fI[yes|no]\fP
+Regulate if the listening socket uses socket option \fBSO_KEEPALIVE\fP.
+If set to \fB1\fP, \fBtrue\fP or \fByes\fP and the network connection disappears without closing messages, the connection will be closed.
+
+.TP
+\fBtcp_nodelay\fP=\fI[yes|no]\fP
+Regulate if the listening socket uses socket option \fBTCP_NODELAY\fP.
+If set to \fB1\fP, \fBtrue\fP or \fByes\fP, no buffering will be performed in the TCP stack.
+
+.TP
+\fBblack\fP=\fI000000\fP
+.TP
+\fBgrey\fP=\fIc0c0c0\fP
+.TP
+\fBdark_grey\fP=\fI808080\fP
+.TP
+\fBblue\fP=\fI0000ff\fP
+.TP
+\fBdark_blue\fP=\fI00007f\fP
+.TP
+\fBwhite\fP=\fIffffff\fP
+.TP
+\fBred\fP=\fIff0000\fP
+.TP
+\fBgreen\fP=\fI00ff00\fP
+.TP
+\fBbackground\fP=\fI000000\fP
+These options override the colors used internally by \fBxrdp\fP(8) to draw the login and log windows.
+Colors are defined using a hexadecimal (hex) notation for the combination of Red, Green, and Blue color values (RGB).
+The lowest value that can be given to one of the light sources is 0 (hex 00).
+The highest value is 255 (hex FF).
+
+.SH "LOGGING"
+The following parameters can be used in the \fB[logging]\fR section:
+
+.TP
+\fBLogFile\fR=\fI${SESMAN_LOG_DIR}/sesman.log\fR
+This options contains the path to logfile. It can be either absolute or relative, and the default is \fI${SESMAN_LOG_DIR}/sesman.log\fR
+
+.TP
+\fBLogLevel\fR=\fIlevel\fR
+This option can have one of the following values:
+
+\fBCORE\fR or \fB0\fR \- Log only core messages. these messages are _always_ logged, regardless the logging level selected.
+
+\fBERROR\fR or \fB1\fR \- Log only error messages
+
+\fBWARNING\fR, \fBWARN\fR or \fB2\fR \- Logs warnings and error messages
+
+\fBINFO\fR or \fB3\fR \- Logs errors, warnings and informational messages
+
+\fBDEBUG\fR or \fB4\fR \- Log everything. If \fBsesman\fR is compiled in debug mode, this options will output many more low\-level message, useful for developers
+
+.TP
+\fBEnableSyslog\fR=\fI[0|1]\fR
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables logging to syslog. Otherwise syslog is disabled.
+
+.TP
+\fBSyslogLevel\fR=\fIlevel\fR
+This option sets the logging level for syslog. It can have the same values of \fBLogLevel\fR. If \fBSyslogLevel\fR is greater than \fBLogLevel\fR, its value is lowered to that of \fBLogLevel\fR.
+
+.SH "CHANNELS"
+The Remote Desktop Protocol supports several channels, which are used to transfer additional data like sound, clipboard data and others.
+Channel names not listed here will be blocked by \fBxrdp\fP.
+Not all channels are supported in all cases, so setting a value to \fItrue\fP is a pre-requisite, but does not force it's use.
+.br
+Channels can also be enabled or disabled on a per connection basis by prefixing each setting with \fBchannel.\fP in the channel section.
+
+.TP
+\fBrdpdr\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for device re-direction is allowed.
+
+.TP
+\fBrdpsnd\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for sound is allowed.
+
+.TP
+\fBdrdynvc\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel to initiate additional dynamic virtual channels is allowed.
+
+.TP
+\fBcliprdr\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for clipboard re-direction is allowed.
+
+.TP
+\fBrail\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for remote applications integrated locally (RAIL) is allowed.
+
+.TP
+\fBxrdpvr\fP=\fI[0|1]\fP
+If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for XRDP Video streaming is allowed.
-.TP
+.SH "CONNECTIONS"
A connection section is made of a section name, enclosed in square brackets, and the following entries:
-.br
.TP
\fBname\fR=\fI<session name>\fR
The name displayed in \fBxrdp\fR(8) login window's combo box.
-.br
.TP
\fBlib\fR=\fI../vnc/libvnc.so\fR
Sets the library to be used with this connection.
-.br
.TP
\fBusername\fR=\fI<username>\fR|\fIask\fR
Specifies the username used for authenticating in the connection.
If set to \fIask\fR, user name should be provided in the login window.
-.br
.TP
\fBpassword\fR=\fI<password>\fR|\fIask\fR
Specifies the password used for authenticating in the connection.
If set to \fIask\fR, password should be provided in the login window.
-.br
.TP
\fBip\fR=\fI127.0.0.1\fR
Specifies the ip address of the host to connect to.
-.br
.TP
\fBport\fR=\fI<number>\fR|\fI\-1\fR
Specifies the port number to connect to. If set to \fI\-1\fR, the default port for the specified library is used.
+
.SH "EXAMPLES"
-.LP
This is an example \fBxrdp.ini\fR:
+.nf
[Globals]
-.br
bitmap_cache=yes
-.br
bitmap_compression=yes
-
[vnc1]
-.br
name=sesman
-.br
lib=../vnc/libvnc.so
-.br
username=ask
-.br
password=ask
-.br
ip=127.0.0.1
-.br
port=\-1
+.fi
+
.SH "FILES"
-.LP
${XRDP_CFG_DIR}/xrdp.ini
+
.SH "SEE ALSO"
-.LP
-xrdp(8) sesman(8) sesrun(8) sesman.ini(5)
+.BR xrdp (8),
+.BR sesman (8),
+.BR sesrun (8),
+.BR sesman.ini (5)
for more info on \fBxrdp\fR see http://xrdp.sf.net