From 6c453ff1be6608380558c2529fd0fef66fc5ba46 Mon Sep 17 00:00:00 2001 From: Pavel Roskin Date: Fri, 23 Dec 2016 12:02:55 -0800 Subject: Substitute variables in manual pages --- docs/man/.gitignore | 1 + docs/man/Makefile.am | 17 ++- docs/man/sesman.ini.5 | 225 ----------------------------- docs/man/sesman.ini.5.in | 225 +++++++++++++++++++++++++++++ docs/man/xrdp-chansrv.8 | 46 ------ docs/man/xrdp-chansrv.8.in | 46 ++++++ docs/man/xrdp-dis.1 | 27 ---- docs/man/xrdp-dis.1.in | 27 ++++ docs/man/xrdp-genkeymap.8 | 67 --------- docs/man/xrdp-genkeymap.8.in | 67 +++++++++ docs/man/xrdp-keygen.8 | 44 ------ docs/man/xrdp-keygen.8.in | 44 ++++++ docs/man/xrdp-sesadmin.8 | 57 -------- docs/man/xrdp-sesadmin.8.in | 57 ++++++++ docs/man/xrdp-sesman.8 | 47 ------ docs/man/xrdp-sesman.8.in | 47 ++++++ docs/man/xrdp-sesrun.8 | 50 ------- docs/man/xrdp-sesrun.8.in | 50 +++++++ docs/man/xrdp-sessvc.8 | 26 ---- docs/man/xrdp-sessvc.8.in | 26 ++++ docs/man/xrdp.8 | 46 ------ docs/man/xrdp.8.in | 46 ++++++ docs/man/xrdp.ini.5 | 331 ------------------------------------------- docs/man/xrdp.ini.5.in | 331 +++++++++++++++++++++++++++++++++++++++++++ 24 files changed, 980 insertions(+), 970 deletions(-) create mode 100644 docs/man/.gitignore delete mode 100644 docs/man/sesman.ini.5 create mode 100644 docs/man/sesman.ini.5.in delete mode 100644 docs/man/xrdp-chansrv.8 create mode 100644 docs/man/xrdp-chansrv.8.in delete mode 100644 docs/man/xrdp-dis.1 create mode 100644 docs/man/xrdp-dis.1.in delete mode 100644 docs/man/xrdp-genkeymap.8 create mode 100644 docs/man/xrdp-genkeymap.8.in delete mode 100644 docs/man/xrdp-keygen.8 create mode 100644 docs/man/xrdp-keygen.8.in delete mode 100644 docs/man/xrdp-sesadmin.8 create mode 100644 docs/man/xrdp-sesadmin.8.in delete mode 100644 docs/man/xrdp-sesman.8 create mode 100644 docs/man/xrdp-sesman.8.in delete mode 100644 docs/man/xrdp-sesrun.8 create mode 100644 docs/man/xrdp-sesrun.8.in delete mode 100644 docs/man/xrdp-sessvc.8 create mode 100644 docs/man/xrdp-sessvc.8.in delete mode 100644 docs/man/xrdp.8 create mode 100644 docs/man/xrdp.8.in delete mode 100644 docs/man/xrdp.ini.5 create mode 100644 docs/man/xrdp.ini.5.in (limited to 'docs/man') diff --git a/docs/man/.gitignore b/docs/man/.gitignore new file mode 100644 index 00000000..28924786 --- /dev/null +++ b/docs/man/.gitignore @@ -0,0 +1 @@ +*.[1-8] diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 48c26559..90863842 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -1,4 +1,4 @@ -dist_man_MANS = \ +man_MANS = \ xrdp-dis.1 \ sesman.ini.5 \ xrdp.ini.5 \ @@ -11,7 +11,16 @@ dist_man_MANS = \ xrdp-sesrun.8 \ xrdp-sessvc.8 -noinst_man_MANS = \ - xrdp-xcon.8 +EXTRA_DIST = $(man_MANS:=.in) -EXTRA_DIST = $(noinst_man_MANS) +SUBST_VARS = sed \ + -e 's|@PACKAGE_VERSION[@]|$(PACKAGE_VERSION)|g' \ + -e 's|@bindir[@]|$(bindir)|g' \ + -e 's|@localstatedir[@]|$(localstatedir)|g' \ + -e 's|@sysconfdir[@]|$(sysconfdir)|g' + +SUFFIXES = .in +.in: + $(SUBST_VARS) $< > $@ + +CLEANFILES = $(man_MANS) diff --git a/docs/man/sesman.ini.5 b/docs/man/sesman.ini.5 deleted file mode 100644 index b8ced28f..00000000 --- a/docs/man/sesman.ini.5 +++ /dev/null @@ -1,225 +0,0 @@ -.\" -.TH "sesman.ini" "5" "0.9.1" "xrdp team" "" -.SH "NAME" -\fBsesman.ini\fR \- Configuration file for \fBxrdp-sesman\fR(8) - -.SH "DESCRIPTION" -\fBsesman.ini\fR consists of several sections. Each section starts with -the section name in square brackets, followed by a list of -\fIparameter\fR=\fIvalue\fR lines. Following sections are recognized: - -.TP -\fB[Globals]\fR -Global configuration - -.TP -\fB[Logging]\fR -Logging subsystem - -.TP -\fB[Sessions]\fR -Session management - -.TP -\fB[Security]\fR -Access control - -.TP -\fB[X11rdp]\fR, \fB[Xvnc]\fR, \fB[Xorg]\fR -X11 server settings for supported servers - -.TP -\fB[Chansrv]\fR -Settings for xrdp-chansrv(8) - -.TP -\fB[SessionVariables]\fR -Environment variables for the session - -.LP -All parameters and values (except for file names and paths) are case -insensitive, and are described in detail below. If any parameter is -specified more than once, the last entry will be used. Options specified -outside their proper section will be \fIignored\fR. - -.SH "GLOBALS" -Following parameters can be used in the \fB[Globals]\fR section. - -.TP -\fBListenAddress\fR=\fIip address\fR -xrdp-sesman listening address. If not specified, defaults to \fI0.0.0.0\fR -(all interfaces). - -.TP -\fBListenPort\fR=\fIport number\fR -xrdp-sesman listening port. If not specified, defaults to \fI3350\fR. - -.TP -\fBEnableUserWindowManager\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR, this option enables user -specific startup script. That is, xrdp-sesman will execute the script -specified by \fBUserWindowManager\fR if it exists. - -.TP -\fBUserWindowManager\fR=\fIfilename\fR -Name of the startup script relative to the user's home directory. If -present and enabled by \fBEnableUserWindowManager\fR, that script is -executed instead of \fBDefaultWindowManager\fR. - -.TP -\fBDefaultWindowManager\fR=\fIfilename\fR -Full path to the default startup script used by xrdp-sesman to start a -session if the user script is disabled or missing. - -.SH "LOGGING" -Following parameters can be used in the \fB[Logging]\fR section. - -.TP -\fBLogFile\fR=\fIfilename\fR -Log file path. It can be either absolute or relative. If not specified, -defaults to \fI./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. Those messages are -logged \fIregardless\fR of the selected logging level. - -\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 \- Log errors, warnings and informational messages. - -\fBDEBUG\fR or \fB4\fR \- Log everything. If xrdp-sesman is compiled in -debug mode, this options will output many more low\-level messages. - -.TP -\fBEnableSyslog\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR, this option enables logging to -syslog. - -.TP -\fBSyslogLevel\fR=\fIlevel\fR -Logging level for syslog. It can have the same values as \fBLogLevel\fR. -If \fBSyslogLevel\fR and \fBLogLevel\fR differ, the least verbose setting -takes effect for syslog. - -.SH "SESSIONS" -Following parameters can be used in the \fB[Sessions]\fR section. - -.TP -\fBX11DisplayOffset\fR=\fInumber\fR -The first X display number available for xrdp-sesman. This prevents -xrdp-sesman from interfering with real X11 servers. If not specified, -defaults to \fI10\fR. - -.TP -\fBMaxSessions\fR=\fInumber\fR -Sets the maximum number of simultaneous sessions. If not set or set to -\fI0\fR, unlimited session are allowed. - -.TP -\fBKillDisconnected\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR, every session will be killed -within 60 seconds after the user disconnects. - -.TP -\fBIdleTimeLimit\fR=\fInumber\fR -\fI\This option is currently ignored!\fR Time limit before an idle -session is disconnected. If set to \fI0\fR, automatic disconnection is -disabled. - -.TP -\fBDisconnectedTimeLimit\fR=\fInumber\fR -Sets the time limit (in seconds) before a disconnected session is killed. -If set to \fI0\fR, automatic killing is disabled. - -.TP -\fBPolicy\fR=\fI[Default|UBD|UBI|UBC|UBDI|UBDC]\fR -Session allocation policy. By default, a new session is created -for the combination when using Xrdp, and -for the combination when using Xvnc. -This behavior can be changed by setting session policy to: -.br - -.br -\fBUBD\fR - session per -.br -\fBUBI\fR - session per -.br -\fBUBC\fR - session per -.br -\fBUBDI\fR - session per -.br -\fBUBDC\fR - session per -.br - -.br -Note that the \fBUser\fR and \fBBitPerPixel\fR criteria cannot be turned -off. For Xvnc connections, \fBDisplaySize\fR is always enabled as well. -.br - -.SH "SECURITY" -Following parameters can be used in the \fB[Security]\fR section. - -.TP -\fBAllowRootLogin\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR, enables root login on the -terminal server. - -.TP -\fBMaxLoginRetry\fR=\fInumber\fR -The number of login attempts that are allowed on terminal server. If set -to \fI0\fR, unlimited attempts are allowed. If not specified, defaults to -\fI3\fR. - -.TP -\fBTerminalServerUsers\fR=\fIgroup\fR -Only the users belonging to the specified group are allowed to login on -terminal server. If unset or set to an invalid or non\-existent group, -login for all users is enabled. - -.TP -\fBTerminalServerAdmins\fR=\fIgroup\fR -\fIThis option is currently ignored!\fR Only members of this group can -have session management rights. - -.TP -\fBAlwaysGroupCheck\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR, require group membership even -if the group specified in \fBTerminalServerUsers\fR doesn't exist. - -.SH "X11 SERVER" -Following parameters can be used in the \fB[X11rdp]\fR, \fB[Xvnc]\fR and -\fB[Xorg]\fR sections. - -.TP -\fBparam\fR=\fIstring\fR -Multiple \fIparam\fR lines are supported. This first line specifies the -path to the X11 server executable. Following lines specify command line -arguments passed to the X11 server. - -.SH "CHANSRV" -Following parameters can be used in the \fB[Chansrv]\fR section. - -.TP -\fBFuseMountName\fR=\fIstring\fR -Directory for drive redirection, relative to the user home directory. -Created if it doesn't exist. If not specified, defaults to \fIxrdp_client\fR. - -.SH "SESSIONS VARIABLES" -All entries in the \fB[SessionVariables]\fR section are set as -environment variables in the user's session. - -.SH "FILES" -/etc/xrdp/sesman.ini - -.SH "SEE ALSO" -.BR xrdp-sesman (8), -.BR xrdp-sesrun (8), -.BR xrdp (8), -.BR xrdp.ini (5) - -For more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/sesman.ini.5.in b/docs/man/sesman.ini.5.in new file mode 100644 index 00000000..747bd15e --- /dev/null +++ b/docs/man/sesman.ini.5.in @@ -0,0 +1,225 @@ +.\" +.TH "sesman.ini" "5" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +\fBsesman.ini\fR \- Configuration file for \fBxrdp-sesman\fR(8) + +.SH "DESCRIPTION" +\fBsesman.ini\fR consists of several sections. Each section starts with +the section name in square brackets, followed by a list of +\fIparameter\fR=\fIvalue\fR lines. Following sections are recognized: + +.TP +\fB[Globals]\fR +Global configuration + +.TP +\fB[Logging]\fR +Logging subsystem + +.TP +\fB[Sessions]\fR +Session management + +.TP +\fB[Security]\fR +Access control + +.TP +\fB[X11rdp]\fR, \fB[Xvnc]\fR, \fB[Xorg]\fR +X11 server settings for supported servers + +.TP +\fB[Chansrv]\fR +Settings for xrdp-chansrv(8) + +.TP +\fB[SessionVariables]\fR +Environment variables for the session + +.LP +All parameters and values (except for file names and paths) are case +insensitive, and are described in detail below. If any parameter is +specified more than once, the last entry will be used. Options specified +outside their proper section will be \fIignored\fR. + +.SH "GLOBALS" +Following parameters can be used in the \fB[Globals]\fR section. + +.TP +\fBListenAddress\fR=\fIip address\fR +xrdp-sesman listening address. If not specified, defaults to \fI0.0.0.0\fR +(all interfaces). + +.TP +\fBListenPort\fR=\fIport number\fR +xrdp-sesman listening port. If not specified, defaults to \fI3350\fR. + +.TP +\fBEnableUserWindowManager\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR, this option enables user +specific startup script. That is, xrdp-sesman will execute the script +specified by \fBUserWindowManager\fR if it exists. + +.TP +\fBUserWindowManager\fR=\fIfilename\fR +Name of the startup script relative to the user's home directory. If +present and enabled by \fBEnableUserWindowManager\fR, that script is +executed instead of \fBDefaultWindowManager\fR. + +.TP +\fBDefaultWindowManager\fR=\fIfilename\fR +Full path to the default startup script used by xrdp-sesman to start a +session if the user script is disabled or missing. + +.SH "LOGGING" +Following parameters can be used in the \fB[Logging]\fR section. + +.TP +\fBLogFile\fR=\fIfilename\fR +Log file path. It can be either absolute or relative. If not specified, +defaults to \fI./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. Those messages are +logged \fIregardless\fR of the selected logging level. + +\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 \- Log errors, warnings and informational messages. + +\fBDEBUG\fR or \fB4\fR \- Log everything. If xrdp-sesman is compiled in +debug mode, this options will output many more low\-level messages. + +.TP +\fBEnableSyslog\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR, this option enables logging to +syslog. + +.TP +\fBSyslogLevel\fR=\fIlevel\fR +Logging level for syslog. It can have the same values as \fBLogLevel\fR. +If \fBSyslogLevel\fR and \fBLogLevel\fR differ, the least verbose setting +takes effect for syslog. + +.SH "SESSIONS" +Following parameters can be used in the \fB[Sessions]\fR section. + +.TP +\fBX11DisplayOffset\fR=\fInumber\fR +The first X display number available for xrdp-sesman. This prevents +xrdp-sesman from interfering with real X11 servers. If not specified, +defaults to \fI10\fR. + +.TP +\fBMaxSessions\fR=\fInumber\fR +Sets the maximum number of simultaneous sessions. If not set or set to +\fI0\fR, unlimited session are allowed. + +.TP +\fBKillDisconnected\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR, every session will be killed +within 60 seconds after the user disconnects. + +.TP +\fBIdleTimeLimit\fR=\fInumber\fR +\fI\This option is currently ignored!\fR Time limit before an idle +session is disconnected. If set to \fI0\fR, automatic disconnection is +disabled. + +.TP +\fBDisconnectedTimeLimit\fR=\fInumber\fR +Sets the time limit (in seconds) before a disconnected session is killed. +If set to \fI0\fR, automatic killing is disabled. + +.TP +\fBPolicy\fR=\fI[Default|UBD|UBI|UBC|UBDI|UBDC]\fR +Session allocation policy. By default, a new session is created +for the combination when using Xrdp, and +for the combination when using Xvnc. +This behavior can be changed by setting session policy to: +.br + +.br +\fBUBD\fR - session per +.br +\fBUBI\fR - session per +.br +\fBUBC\fR - session per +.br +\fBUBDI\fR - session per +.br +\fBUBDC\fR - session per +.br + +.br +Note that the \fBUser\fR and \fBBitPerPixel\fR criteria cannot be turned +off. For Xvnc connections, \fBDisplaySize\fR is always enabled as well. +.br + +.SH "SECURITY" +Following parameters can be used in the \fB[Security]\fR section. + +.TP +\fBAllowRootLogin\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR, enables root login on the +terminal server. + +.TP +\fBMaxLoginRetry\fR=\fInumber\fR +The number of login attempts that are allowed on terminal server. If set +to \fI0\fR, unlimited attempts are allowed. If not specified, defaults to +\fI3\fR. + +.TP +\fBTerminalServerUsers\fR=\fIgroup\fR +Only the users belonging to the specified group are allowed to login on +terminal server. If unset or set to an invalid or non\-existent group, +login for all users is enabled. + +.TP +\fBTerminalServerAdmins\fR=\fIgroup\fR +\fIThis option is currently ignored!\fR Only members of this group can +have session management rights. + +.TP +\fBAlwaysGroupCheck\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR, require group membership even +if the group specified in \fBTerminalServerUsers\fR doesn't exist. + +.SH "X11 SERVER" +Following parameters can be used in the \fB[X11rdp]\fR, \fB[Xvnc]\fR and +\fB[Xorg]\fR sections. + +.TP +\fBparam\fR=\fIstring\fR +Multiple \fIparam\fR lines are supported. This first line specifies the +path to the X11 server executable. Following lines specify command line +arguments passed to the X11 server. + +.SH "CHANSRV" +Following parameters can be used in the \fB[Chansrv]\fR section. + +.TP +\fBFuseMountName\fR=\fIstring\fR +Directory for drive redirection, relative to the user home directory. +Created if it doesn't exist. If not specified, defaults to \fIxrdp_client\fR. + +.SH "SESSIONS VARIABLES" +All entries in the \fB[SessionVariables]\fR section are set as +environment variables in the user's session. + +.SH "FILES" +/etc/xrdp/sesman.ini + +.SH "SEE ALSO" +.BR xrdp-sesman (8), +.BR xrdp-sesrun (8), +.BR xrdp (8), +.BR xrdp.ini (5) + +For more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp-chansrv.8 b/docs/man/xrdp-chansrv.8 deleted file mode 100644 index c1deb085..00000000 --- a/docs/man/xrdp-chansrv.8 +++ /dev/null @@ -1,46 +0,0 @@ -.TH "xrdp\-chansrv" "8" "0.9.1" "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 $XDG_DATA_HOME/xrdp/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://www.xrdp.org/ diff --git a/docs/man/xrdp-chansrv.8.in b/docs/man/xrdp-chansrv.8.in new file mode 100644 index 00000000..332a1907 --- /dev/null +++ b/docs/man/xrdp-chansrv.8.in @@ -0,0 +1,46 @@ +.TH "xrdp\-chansrv" "8" "@PACKAGE_VERSION@" "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 $XDG_DATA_HOME/xrdp/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://www.xrdp.org/ diff --git a/docs/man/xrdp-dis.1 b/docs/man/xrdp-dis.1 deleted file mode 100644 index 09de5f10..00000000 --- a/docs/man/xrdp-dis.1 +++ /dev/null @@ -1,27 +0,0 @@ -.TH "xrdp-dis" "1" "0.9.1" "xrdp team" -.SH NAME -xrdp\-dis \- xrdp disconnect utility - -.SH SYNOPSIS -.B xrdp\-dis - -.SH DESCRIPTION -.PP -\fBxrdp\-dis\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 KNOWN ISSUES -.TP -This utility doesn't support disconnecting xorgxrdp sessions so far. - -.SH SEE ALSO -.BR xrdp (8). diff --git a/docs/man/xrdp-dis.1.in b/docs/man/xrdp-dis.1.in new file mode 100644 index 00000000..54ba5db2 --- /dev/null +++ b/docs/man/xrdp-dis.1.in @@ -0,0 +1,27 @@ +.TH "xrdp-dis" "1" "@PACKAGE_VERSION@" "xrdp team" +.SH NAME +xrdp\-dis \- xrdp disconnect utility + +.SH SYNOPSIS +.B xrdp\-dis + +.SH DESCRIPTION +.PP +\fBxrdp\-dis\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 KNOWN ISSUES +.TP +This utility doesn't support disconnecting xorgxrdp sessions so far. + +.SH SEE ALSO +.BR xrdp (8). diff --git a/docs/man/xrdp-genkeymap.8 b/docs/man/xrdp-genkeymap.8 deleted file mode 100644 index aa9f866c..00000000 --- a/docs/man/xrdp-genkeymap.8 +++ /dev/null @@ -1,67 +0,0 @@ -.TH "xrdp\-genkeymap" "8" "0.9.1" "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-XXXXXXXX.ini -Files containing the keyboard mapping for language \fIXXXXXXXX\fP, which is a 8 digit hexadecimal number identifying the country and language code. -.RS 8 -.TP -.B 00000405 -cs Czech -.TP -.B 00000407 -de German -.TP -.B 00000409 -en-us US English -.TP -.B 0000040c -fr French -.TP -.B 00000410 -it Italian -.TP -.B 00000416 -br Portuguese (Brazil) -.TP -.B 00000419 -ru Russian -.TP -.B 0000041d -se Swedish -.TP -.B 00000809 -en-uk UK English -.RE - -.SH "AUTHORS" -Jay Sorg -.br -Simone Fedele - -.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://www.xrdp.org/ diff --git a/docs/man/xrdp-genkeymap.8.in b/docs/man/xrdp-genkeymap.8.in new file mode 100644 index 00000000..e69d6606 --- /dev/null +++ b/docs/man/xrdp-genkeymap.8.in @@ -0,0 +1,67 @@ +.TH "xrdp\-genkeymap" "8" "@PACKAGE_VERSION@" "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-XXXXXXXX.ini +Files containing the keyboard mapping for language \fIXXXXXXXX\fP, which is a 8 digit hexadecimal number identifying the country and language code. +.RS 8 +.TP +.B 00000405 +cs Czech +.TP +.B 00000407 +de German +.TP +.B 00000409 +en-us US English +.TP +.B 0000040c +fr French +.TP +.B 00000410 +it Italian +.TP +.B 00000416 +br Portuguese (Brazil) +.TP +.B 00000419 +ru Russian +.TP +.B 0000041d +se Swedish +.TP +.B 00000809 +en-uk UK English +.RE + +.SH "AUTHORS" +Jay Sorg +.br +Simone Fedele + +.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://www.xrdp.org/ diff --git a/docs/man/xrdp-keygen.8 b/docs/man/xrdp-keygen.8 deleted file mode 100644 index 84d4eafd..00000000 --- a/docs/man/xrdp-keygen.8 +++ /dev/null @@ -1,44 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\"- -.\" Copyright © 2007, 2008 Vincent Bernat -.\" License: GPL-2+ -.\"- -.TH xrdp\-keygen 8 "0.9.1" "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 . diff --git a/docs/man/xrdp-keygen.8.in b/docs/man/xrdp-keygen.8.in new file mode 100644 index 00000000..ce33063c --- /dev/null +++ b/docs/man/xrdp-keygen.8.in @@ -0,0 +1,44 @@ +.\" Hey, EMACS: -*- nroff -*- +.\"- +.\" Copyright © 2007, 2008 Vincent Bernat +.\" License: GPL-2+ +.\"- +.TH xrdp\-keygen 8 "@PACKAGE_VERSION@" "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 . diff --git a/docs/man/xrdp-sesadmin.8 b/docs/man/xrdp-sesadmin.8 deleted file mode 100644 index 29e14c18..00000000 --- a/docs/man/xrdp-sesadmin.8 +++ /dev/null @@ -1,57 +0,0 @@ -.TH "xrdp-sesadmin" "8" "0.9.1" "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-sesadmin.8.in b/docs/man/xrdp-sesadmin.8.in new file mode 100644 index 00000000..81ac4ab9 --- /dev/null +++ b/docs/man/xrdp-sesadmin.8.in @@ -0,0 +1,57 @@ +.TH "xrdp-sesadmin" "8" "@PACKAGE_VERSION@" "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 deleted file mode 100644 index cca68e3e..00000000 --- a/docs/man/xrdp-sesman.8 +++ /dev/null @@ -1,47 +0,0 @@ -.TH "xrdp\-sesman" "8" "0.9.1" "xrdp team" "" -.SH "NAME" -xrdp\-sesman \- \fBxrdp\fR(8) session manager - -.SH "SYNTAX" -.B xrdp\-sesman -.RB [ \-\-nodaemon | \-\-kill | \-\-help ] - -.SH "DESCRIPTION" -\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" -.TP -\fB\-n\fR, \fB\-\-nodaemon\fR -Starts \fBxrdp\-sesman\fR in foreground instead of starting it as a daemon. -.TP -\fB\-k\fR, \fB\-\-kill\fR -Kills running \fBxrdp\-sesman\fR daemon. -.TP -\fB\-h\fR, \fB\-\-help\fR -Output help information and exit. - -.SH "FILES" -${SESMAN_BIN_DIR}/sesman -.br -${SESMAN_BIN_DIR}/sesrun -.br -${SESMAN_CFG_DIR}/sesman.ini -.br -${SESMAN_LOG_DIR}/sesman.log -.br -${SESMAN_PID_DIR}/sesman.pid - -.SH "AUTHORS" -Jay Sorg -.br -Simone Fedele - -.SH "SEE ALSO" -.BR sesman.ini (5), -.BR xrdp\-sesrun (8), -.BR xrdp (8), -.BR xrdp.ini (5) - -for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp-sesman.8.in b/docs/man/xrdp-sesman.8.in new file mode 100644 index 00000000..3b98cf0e --- /dev/null +++ b/docs/man/xrdp-sesman.8.in @@ -0,0 +1,47 @@ +.TH "xrdp\-sesman" "8" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +xrdp\-sesman \- \fBxrdp\fR(8) session manager + +.SH "SYNTAX" +.B xrdp\-sesman +.RB [ \-\-nodaemon | \-\-kill | \-\-help ] + +.SH "DESCRIPTION" +\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" +.TP +\fB\-n\fR, \fB\-\-nodaemon\fR +Starts \fBxrdp\-sesman\fR in foreground instead of starting it as a daemon. +.TP +\fB\-k\fR, \fB\-\-kill\fR +Kills running \fBxrdp\-sesman\fR daemon. +.TP +\fB\-h\fR, \fB\-\-help\fR +Output help information and exit. + +.SH "FILES" +${SESMAN_BIN_DIR}/sesman +.br +${SESMAN_BIN_DIR}/sesrun +.br +${SESMAN_CFG_DIR}/sesman.ini +.br +${SESMAN_LOG_DIR}/sesman.log +.br +${SESMAN_PID_DIR}/sesman.pid + +.SH "AUTHORS" +Jay Sorg +.br +Simone Fedele + +.SH "SEE ALSO" +.BR sesman.ini (5), +.BR xrdp\-sesrun (8), +.BR xrdp (8), +.BR xrdp.ini (5) + +for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp-sesrun.8 b/docs/man/xrdp-sesrun.8 deleted file mode 100644 index c66d773c..00000000 --- a/docs/man/xrdp-sesrun.8 +++ /dev/null @@ -1,50 +0,0 @@ -.TH "xrdp\-sesrun" "8" "0.9.1" "xrdp team" "" -.SH "NAME" -xrdp\-sesrun \- \fBsesman\fR(8) session launcher - -.SH "SYNTAX" -.B xrdp\-sesrun -.I server username password width height bpp - -.SH "DESCRIPTION" -\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" -.TP -.I server -Server on which sesman is running -.TP -.I username -user name of the session being started -.TP -.I password -user password -.TP -.I width -Screen width -.TP -.I height -Screen height -.TP -.I bpp -Session color depth - -.SH "FILES" -${SESMAN_BIN_DIR}/sesman -.br -${SESMAN_BIN_DIR}/sesrun - -.SH "AUTHORS" -Jay Sorg -.br -Simone Fedele - -.SH "SEE ALSO" -.BR xrdp\-sesman (8), -.BR sesman.ini (5), -.BR xrdp (8), -.BR xrdp.ini (5) - -for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp-sesrun.8.in b/docs/man/xrdp-sesrun.8.in new file mode 100644 index 00000000..1102bdda --- /dev/null +++ b/docs/man/xrdp-sesrun.8.in @@ -0,0 +1,50 @@ +.TH "xrdp\-sesrun" "8" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +xrdp\-sesrun \- \fBsesman\fR(8) session launcher + +.SH "SYNTAX" +.B xrdp\-sesrun +.I server username password width height bpp + +.SH "DESCRIPTION" +\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" +.TP +.I server +Server on which sesman is running +.TP +.I username +user name of the session being started +.TP +.I password +user password +.TP +.I width +Screen width +.TP +.I height +Screen height +.TP +.I bpp +Session color depth + +.SH "FILES" +${SESMAN_BIN_DIR}/sesman +.br +${SESMAN_BIN_DIR}/sesrun + +.SH "AUTHORS" +Jay Sorg +.br +Simone Fedele + +.SH "SEE ALSO" +.BR xrdp\-sesman (8), +.BR sesman.ini (5), +.BR xrdp (8), +.BR xrdp.ini (5) + +for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp-sessvc.8 b/docs/man/xrdp-sessvc.8 deleted file mode 100644 index 9a4e8189..00000000 --- a/docs/man/xrdp-sessvc.8 +++ /dev/null @@ -1,26 +0,0 @@ -.TH "xrdp\-sessvc" "8" "0.9.1" "xrdp team" "" -.SH "NAME" -xrdp\-sessvc \- \fBxrdp\fR session supervisor - -.SH "SYNTAX" -.B xrdp\-sessvc -.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://www.xrdp.org/ diff --git a/docs/man/xrdp-sessvc.8.in b/docs/man/xrdp-sessvc.8.in new file mode 100644 index 00000000..92ca7c29 --- /dev/null +++ b/docs/man/xrdp-sessvc.8.in @@ -0,0 +1,26 @@ +.TH "xrdp\-sessvc" "8" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +xrdp\-sessvc \- \fBxrdp\fR session supervisor + +.SH "SYNTAX" +.B xrdp\-sessvc +.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://www.xrdp.org/ diff --git a/docs/man/xrdp.8 b/docs/man/xrdp.8 deleted file mode 100644 index f838c203..00000000 --- a/docs/man/xrdp.8 +++ /dev/null @@ -1,46 +0,0 @@ -.TH "xrdp" "8" "0.9.1" "xrdp team" "" -.SH "NAME" -\fBxrdp\fR \- a Remote Desktop Protocol (RDP) server - -.SH "SYNTAX" -xrdp [ \-\-nodaemon | \-\-kill | \-\-help ] - -.SH "DESCRIPTION" -\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" -.TP -\fB\-n\fR, \fB\-\-nodaemon\fR -Starts \fBxrdp\fR in foreground instead of starting it as a daemon. -.TP -\fB\-k\fR, \fB\-\-kill\fR -Kills running \fBxrdp\fR daemon. -.TP -\fB\-h\fR, \fB\-\-help\fR -Output help information and exit. - -.SH "FILES" -${XRDP_BIN_DIR}/xrdp -.br -${XRDP_CFG_DIR}/xrdp.ini -.br -${XRDP_LOG_DIR}/xrdp.log -.br -${XRDP_PID_DIR}/xrdp.pid - -.SH "AUTHORS" -Jay Sorg -.br -Simone Fedele - -.SH "SEE ALSO" -.BR xrdp.ini (5), -.BR sesman (8), -.BR sesman.ini (5), -.BR sesrun (8) - -for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp.8.in b/docs/man/xrdp.8.in new file mode 100644 index 00000000..4ab795fa --- /dev/null +++ b/docs/man/xrdp.8.in @@ -0,0 +1,46 @@ +.TH "xrdp" "8" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +\fBxrdp\fR \- a Remote Desktop Protocol (RDP) server + +.SH "SYNTAX" +xrdp [ \-\-nodaemon | \-\-kill | \-\-help ] + +.SH "DESCRIPTION" +\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" +.TP +\fB\-n\fR, \fB\-\-nodaemon\fR +Starts \fBxrdp\fR in foreground instead of starting it as a daemon. +.TP +\fB\-k\fR, \fB\-\-kill\fR +Kills running \fBxrdp\fR daemon. +.TP +\fB\-h\fR, \fB\-\-help\fR +Output help information and exit. + +.SH "FILES" +${XRDP_BIN_DIR}/xrdp +.br +${XRDP_CFG_DIR}/xrdp.ini +.br +${XRDP_LOG_DIR}/xrdp.log +.br +${XRDP_PID_DIR}/xrdp.pid + +.SH "AUTHORS" +Jay Sorg +.br +Simone Fedele + +.SH "SEE ALSO" +.BR xrdp.ini (5), +.BR sesman (8), +.BR sesman.ini (5), +.BR sesrun (8) + +for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp.ini.5 b/docs/man/xrdp.ini.5 deleted file mode 100644 index c202b01a..00000000 --- a/docs/man/xrdp.ini.5 +++ /dev/null @@ -1,331 +0,0 @@ -.TH "xrdp.ini" "5" "0.9.1" "xrdp team" "" -.SH "NAME" -\fBxrdp.ini\fR \- Configuration file for \fBxrdp\fR(8) - -.SH "DESCRIPTION" -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, followed by a list of \fI\fR=\fI\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 - -.LP -All options and values (except for file names and paths) are case insensitive, and are described in detail below. - -.SH "GLOBALS" -The options to be specified in the \fB[Globals]\fR section are the following: - -.TP -\fBaddress\fP=\fIip address\fP -Specify xrdp listening address. If not specified, defaults to 0.0.0.0 (all interfaces). - -.TP -\fBautorun\fP=\fIsession_name\fP -Section name for automatic login. If set and the client supplies valid -username and password, the user will be logged in automatically using the -connection specified by \fIsession_name\fP. - -If \fIsession_name\fP is empty, the \fBLOGIN DOMAIN\fR from the client -with be used to select the section. If no domain name is supplied, the -first suitable section will be used for automatic login. - -.TP -\fBbitmap_cache\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap caching in \fBxrdp\fR(8). - -.TP -\fBbitmap_compression\fR=\fI[true|false]\fR -If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap compression in \fBxrdp\fR(8). - -.TP -\fBbulk_compression\fP=\fI[true|false]\fP -If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables compression of bulk data in \fBxrdp\fR(8). - -.TP -\fBcertificate\fP=\fI/path/to/certificate\fP -.TP -\fBkey_file\fP=\fI/path/to/private_key\fP -Set location of TLS certificate and private key. They must be written in PEM format. -If not specified, defaults to \fB${XRDP_CFG_DIR}/cert.pem\fP, \fB${XRDP_CFG_DIR}/key.pem\fP. - -This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. - -.TP -\fBchannel_code\fP=\fI[true|false]\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=\fI[low|medium|high|fips]\fP -.\" -Regulate encryption level of Standard RDP Security. -This parameter is effective only if \fBsecurity_layer\fP is set to \fBrdp\fP or \fBnegotiate\fP. - -Encryption in Standard RDP Security is controlled by two settings: \fIEncryption Level\fP -and \fIEncryption Method\fP. The only supported \fIEncryption Method\fP are \fB40BIT_ENCRYPTION\fP -and \fB128BIT_ENCRYPTION\fP. \fB56BIT_ENCRYPTION\fP is 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 (client compatible). -.TP -.B high -All data sent between the client and the server is protected by encryption based on -the server's maximum key strength (sever compatible). -.TP -.B fips -All data sent between the client and server is protected using Federal Information -Processing Standard 140-1 validated encryption methods. -.I This level is required for Windows clients (mstsc.exe) if the client's group policy -.I enforces FIPS-compliance mode. -.RE - -.TP -\fBdisableSSLv3\fP=\fI[true|false]\fP -If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP will not accept SSLv3 connections. -If not specified, defaults to \fBfalse\fP. -This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. - -.TP -\fBfork\fP=\fI[true|false]\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[true|false]\fP -If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP will not show a window for log messages. -If not specified, defaults to \fBfalse\fP. - -.TP -\fBmax_bpp\fP=\fI[8|15|16|24|32]\fP -Limit the color depth by specifying the maximum number of bits per pixel. -If not specified or set to \fB0\fP, unlimited. - -.TP -\fBpamerrortxt\fP=\fIerror_text\fP -Specify text passed to PAM when authentication failed. The maximum length is \fB256\fP. - -.TP -\fBport\fP=\fIport\fP -Specify TCP port to listen on for incoming connections. -The default for RDP is \fB3389\fP. - -.TP -\fBrequire_credentials\fP=\fI[true|false]\fP -If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP requires clients to include username and -password initial connection phase. In other words, xrdp doesn't allow clients to show login -screen if set to true. If not specified, defaults to \fBfalse\fP. - -.TP -\fBsecurity_layer\fP=\fI[tls|rdp|negotiate]\fP -Regulate security methods. If not specified, defaults to \fBnegotiate\fP. -.RS 8 -.TP -.B tls -Enhanced RDP Security is used. All security operations (encryption, decryption, data integrity -verification, and server authentication) are implemented by TLS. - -.TP -.B rdp -Standard RDP Security, which is not safe from man-in-the-middle attack, is used. The encryption level -of Standard RDP Security is controlled by \fBcrypt_level\fP. - -.TP -.B negotiate -Negotiate these security methods with clients. -.RE - -.TP -\fBtcp_keepalive\fP=\fI[true|false]\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[true|false]\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 -\fBtcp_send_buffer_bytes\fP=\fIbuffer_size\fP -.TP -\fBtcp_recv_buffer_bytes\fP=\fIbuffer_size\fP -Specify send/recv buffer sizes in bytes. The default value depends on operating system. - -.TP -\fBtls_ciphers\fP=\fIcipher_suite\fP -Specifies TLS cipher suite. The format of this parameter is equivalent to which -\fBopenssl\fP(1) ciphers subcommand accepts. - -(ex. $ openssl ciphers 'HIGH:!ADH:!SHA1') - -This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. - -.TP -\fBuse_fastpath\fP=\fI[input|output|both|none]\fP -If not specified, defaults to \fBnone\fP. - -.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[true|false]\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 prerequisite, but does not force its 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[true|false]\fP -If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for device redirection is allowed. - -.TP -\fBrdpsnd\fP=\fI[true|false]\fP -If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for sound is allowed. - -.TP -\fBdrdynvc\fP=\fI[true|false]\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[true|false]\fP -If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for clipboard redirection is allowed. - -.TP -\fBrail\fP=\fI[true|false]\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[true|false]\fP -If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for XRDP Video streaming is allowed. - -.SH "CONNECTIONS" -A connection section is made of a section name, enclosed in square brackets, and the following entries: - -.TP -\fBname\fR=\fI\fR -The name displayed in \fBxrdp\fR(8) login window's combo box. - -.TP -\fBlib\fR=\fI../vnc/libvnc.so\fR -Sets the library to be used with this connection. - -.TP -\fBusername\fR=\fI\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. - -.TP -\fBpassword\fR=\fI\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. - -.TP -\fBip\fR=\fI127.0.0.1\fR -Specifies the ip address of the host to connect to. - -.TP -\fBport\fR=\fI\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. - -.TP -\fBxserverbpp\fR=\fI\fR -Specifies color depth of the backend X server. The default is the color -depth of the client. Only Xvnc and X11rdp use that setting. Xorg runs at -\fI24\fR bpp. - -.TP -\fBcode\fR=\fI\fR|\fI0\fR -Specifies the session type. The default, \fI0\fR, is Xvnc, \fI10\fR is -X11rdp, and \fI20\fR is Xorg with xorgxrdp modules. - -.SH "EXAMPLES" -This is an example \fBxrdp.ini\fR: - -.nf -[Globals] -bitmap_cache=true -bitmap_compression=true - -[vnc1] -name=sesman -lib=../vnc/libvnc.so -username=ask -password=ask -ip=127.0.0.1 -port=\-1 -.fi - -.SH "FILES" -${XRDP_CFG_DIR}/xrdp.ini - -.SH "SEE ALSO" -.BR xrdp (8), -.BR sesman (8), -.BR sesrun (8), -.BR sesman.ini (5) - -for more info on \fBxrdp\fR see http://www.xrdp.org/ diff --git a/docs/man/xrdp.ini.5.in b/docs/man/xrdp.ini.5.in new file mode 100644 index 00000000..779633ca --- /dev/null +++ b/docs/man/xrdp.ini.5.in @@ -0,0 +1,331 @@ +.TH "xrdp.ini" "5" "@PACKAGE_VERSION@" "xrdp team" "" +.SH "NAME" +\fBxrdp.ini\fR \- Configuration file for \fBxrdp\fR(8) + +.SH "DESCRIPTION" +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, followed by a list of \fI\fR=\fI\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 + +.LP +All options and values (except for file names and paths) are case insensitive, and are described in detail below. + +.SH "GLOBALS" +The options to be specified in the \fB[Globals]\fR section are the following: + +.TP +\fBaddress\fP=\fIip address\fP +Specify xrdp listening address. If not specified, defaults to 0.0.0.0 (all interfaces). + +.TP +\fBautorun\fP=\fIsession_name\fP +Section name for automatic login. If set and the client supplies valid +username and password, the user will be logged in automatically using the +connection specified by \fIsession_name\fP. + +If \fIsession_name\fP is empty, the \fBLOGIN DOMAIN\fR from the client +with be used to select the section. If no domain name is supplied, the +first suitable section will be used for automatic login. + +.TP +\fBbitmap_cache\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap caching in \fBxrdp\fR(8). + +.TP +\fBbitmap_compression\fR=\fI[true|false]\fR +If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables bitmap compression in \fBxrdp\fR(8). + +.TP +\fBbulk_compression\fP=\fI[true|false]\fP +If set to \fB1\fR, \fBtrue\fR or \fByes\fR this option enables compression of bulk data in \fBxrdp\fR(8). + +.TP +\fBcertificate\fP=\fI/path/to/certificate\fP +.TP +\fBkey_file\fP=\fI/path/to/private_key\fP +Set location of TLS certificate and private key. They must be written in PEM format. +If not specified, defaults to \fB${XRDP_CFG_DIR}/cert.pem\fP, \fB${XRDP_CFG_DIR}/key.pem\fP. + +This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. + +.TP +\fBchannel_code\fP=\fI[true|false]\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=\fI[low|medium|high|fips]\fP +.\" +Regulate encryption level of Standard RDP Security. +This parameter is effective only if \fBsecurity_layer\fP is set to \fBrdp\fP or \fBnegotiate\fP. + +Encryption in Standard RDP Security is controlled by two settings: \fIEncryption Level\fP +and \fIEncryption Method\fP. The only supported \fIEncryption Method\fP are \fB40BIT_ENCRYPTION\fP +and \fB128BIT_ENCRYPTION\fP. \fB56BIT_ENCRYPTION\fP is 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 (client compatible). +.TP +.B high +All data sent between the client and the server is protected by encryption based on +the server's maximum key strength (sever compatible). +.TP +.B fips +All data sent between the client and server is protected using Federal Information +Processing Standard 140-1 validated encryption methods. +.I This level is required for Windows clients (mstsc.exe) if the client's group policy +.I enforces FIPS-compliance mode. +.RE + +.TP +\fBdisableSSLv3\fP=\fI[true|false]\fP +If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP will not accept SSLv3 connections. +If not specified, defaults to \fBfalse\fP. +This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. + +.TP +\fBfork\fP=\fI[true|false]\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[true|false]\fP +If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP will not show a window for log messages. +If not specified, defaults to \fBfalse\fP. + +.TP +\fBmax_bpp\fP=\fI[8|15|16|24|32]\fP +Limit the color depth by specifying the maximum number of bits per pixel. +If not specified or set to \fB0\fP, unlimited. + +.TP +\fBpamerrortxt\fP=\fIerror_text\fP +Specify text passed to PAM when authentication failed. The maximum length is \fB256\fP. + +.TP +\fBport\fP=\fIport\fP +Specify TCP port to listen on for incoming connections. +The default for RDP is \fB3389\fP. + +.TP +\fBrequire_credentials\fP=\fI[true|false]\fP +If set to \fB1\fP, \fBtrue\fP or \fByes\fP, \fBxrdp\fP requires clients to include username and +password initial connection phase. In other words, xrdp doesn't allow clients to show login +screen if set to true. If not specified, defaults to \fBfalse\fP. + +.TP +\fBsecurity_layer\fP=\fI[tls|rdp|negotiate]\fP +Regulate security methods. If not specified, defaults to \fBnegotiate\fP. +.RS 8 +.TP +.B tls +Enhanced RDP Security is used. All security operations (encryption, decryption, data integrity +verification, and server authentication) are implemented by TLS. + +.TP +.B rdp +Standard RDP Security, which is not safe from man-in-the-middle attack, is used. The encryption level +of Standard RDP Security is controlled by \fBcrypt_level\fP. + +.TP +.B negotiate +Negotiate these security methods with clients. +.RE + +.TP +\fBtcp_keepalive\fP=\fI[true|false]\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[true|false]\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 +\fBtcp_send_buffer_bytes\fP=\fIbuffer_size\fP +.TP +\fBtcp_recv_buffer_bytes\fP=\fIbuffer_size\fP +Specify send/recv buffer sizes in bytes. The default value depends on operating system. + +.TP +\fBtls_ciphers\fP=\fIcipher_suite\fP +Specifies TLS cipher suite. The format of this parameter is equivalent to which +\fBopenssl\fP(1) ciphers subcommand accepts. + +(ex. $ openssl ciphers 'HIGH:!ADH:!SHA1') + +This parameter is effective only if \fBsecurity_layer\fP is set to \fBtls\fP or \fBnegotiate\fP. + +.TP +\fBuse_fastpath\fP=\fI[input|output|both|none]\fP +If not specified, defaults to \fBnone\fP. + +.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[true|false]\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 prerequisite, but does not force its 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[true|false]\fP +If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for device redirection is allowed. + +.TP +\fBrdpsnd\fP=\fI[true|false]\fP +If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for sound is allowed. + +.TP +\fBdrdynvc\fP=\fI[true|false]\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[true|false]\fP +If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for clipboard redirection is allowed. + +.TP +\fBrail\fP=\fI[true|false]\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[true|false]\fP +If set to \fB1\fR, \fBtrue\fR or \fByes\fR using the RDP channel for XRDP Video streaming is allowed. + +.SH "CONNECTIONS" +A connection section is made of a section name, enclosed in square brackets, and the following entries: + +.TP +\fBname\fR=\fI\fR +The name displayed in \fBxrdp\fR(8) login window's combo box. + +.TP +\fBlib\fR=\fI../vnc/libvnc.so\fR +Sets the library to be used with this connection. + +.TP +\fBusername\fR=\fI\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. + +.TP +\fBpassword\fR=\fI\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. + +.TP +\fBip\fR=\fI127.0.0.1\fR +Specifies the ip address of the host to connect to. + +.TP +\fBport\fR=\fI\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. + +.TP +\fBxserverbpp\fR=\fI\fR +Specifies color depth of the backend X server. The default is the color +depth of the client. Only Xvnc and X11rdp use that setting. Xorg runs at +\fI24\fR bpp. + +.TP +\fBcode\fR=\fI\fR|\fI0\fR +Specifies the session type. The default, \fI0\fR, is Xvnc, \fI10\fR is +X11rdp, and \fI20\fR is Xorg with xorgxrdp modules. + +.SH "EXAMPLES" +This is an example \fBxrdp.ini\fR: + +.nf +[Globals] +bitmap_cache=true +bitmap_compression=true + +[vnc1] +name=sesman +lib=../vnc/libvnc.so +username=ask +password=ask +ip=127.0.0.1 +port=\-1 +.fi + +.SH "FILES" +${XRDP_CFG_DIR}/xrdp.ini + +.SH "SEE ALSO" +.BR xrdp (8), +.BR sesman (8), +.BR sesrun (8), +.BR sesman.ini (5) + +for more info on \fBxrdp\fR see http://www.xrdp.org/ -- cgit v1.2.1