summaryrefslogtreecommitdiffstats
path: root/docs/man
diff options
context:
space:
mode:
authorilsimo <ilsimo>2006-01-10 20:59:18 +0000
committerilsimo <ilsimo>2006-01-10 20:59:18 +0000
commit85835218dc44103ab0388358fa7b824eea57d95f (patch)
tree83f0fdbd54c6b80df356c19d57fc11e289a8dd9f /docs/man
parent377181c9435bf53370084ba3a9c845b35cf3a16d (diff)
downloadxrdp-proprietary-85835218dc44103ab0388358fa7b824eea57d95f.tar.gz
xrdp-proprietary-85835218dc44103ab0388358fa7b824eea57d95f.zip
added new options in sesman.ini
old gzipped manpages replaced with unzipped ones to show changes
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/sesman.844
-rw-r--r--docs/man/sesman.8.gzbin500 -> 0 bytes
-rw-r--r--docs/man/sesman.ini.5199
-rw-r--r--docs/man/sesman.ini.5.gzbin1414 -> 0 bytes
-rw-r--r--docs/man/sesrun.847
-rw-r--r--docs/man/sesrun.8.gzbin526 -> 0 bytes
-rw-r--r--docs/man/xrdp.844
-rw-r--r--docs/man/xrdp.8.gzbin543 -> 0 bytes
-rw-r--r--docs/man/xrdp.ini.599
-rw-r--r--docs/man/xrdp.ini.5.gzbin987 -> 0 bytes
10 files changed, 433 insertions, 0 deletions
diff --git a/docs/man/sesman.8 b/docs/man/sesman.8
new file mode 100644
index 00000000..a224c639
--- /dev/null
+++ b/docs/man/sesman.8
@@ -0,0 +1,44 @@
+.TH "sesman" "8" "0.1.0" "xrdp team" ""
+.SH "NAME"
+.LP
+\fBsesman\fR \- \fBxrdp\fR(8) session manager
+.SH "SYNTAX"
+.LP
+sesman [ \-\-nodaemon | \-\-kill | \-\-help ]
+.SH "DESCRIPTION"
+.LP
+\fBsesman\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.
+.TP
+\fB\-k\fR, \fB\-\-kill\fR
+Kills running \fBsesman\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
+.br
+${SESMAN_CFG_DIR}/sesman.ini
+.br
+${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)
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/sesman.8.gz b/docs/man/sesman.8.gz
deleted file mode 100644
index 217909e2..00000000
--- a/docs/man/sesman.8.gz
+++ /dev/null
Binary files differ
diff --git a/docs/man/sesman.ini.5 b/docs/man/sesman.ini.5
new file mode 100644
index 00000000..0ff1f2b6
--- /dev/null
+++ b/docs/man/sesman.ini.5
@@ -0,0 +1,199 @@
+.\"
+.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.
+
+\fBsesman.ini\fR supports the following sections:
+
+.TP
+\fB[Globals]\fR \- sesman global configuration section,
+
+.TP
+\fB[Logging]\fR \- logging subsystem parameters
+
+.TP
+\fB[Security]\fR \- Access control parameters
+
+.TP
+\fB[Sessions]\fR \- Session management parameters
+
+.LP
+All options and values (except for file names and paths) are case insensitive, and are described in detail below.
+
+.LP
+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
+The options to be specified in the \fB[globals]\fR section are the following:
+.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
+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
+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
+.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
+The following parameters can be used in the \fB[Sessions]\fR section:
+.br
+
+.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
+
+.TP
+\fBIdleTimeLimit\fR=\fI<number>\fR
+Sets the the time limit before an idle session is disconnected.
+.br
+If set to \fI0\fR, automatic disconnection is disabled.
+.br
+
+.TP
+\fBDisconnectedTimeLimit\fR=\fI<number>\fR
+Sets the the time limit before a disconnected session is killed.
+.br
+If set to \fI0\fR, automatic killing is disabled.
+.br
+.SH "SECURITY"
+.LP
+
+.TP
+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
+\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
+\fIThis option is currently ignored.\fR
+.br
+.SH "EXAMPLES"
+.LP
+This is an example \fBsesman.ini\fR:
+
+[Globals]
+.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
+TerminalServerUsers=tsusers
+.br
+TerminalServerAdmins=tsadmins
+.SH "FILES"
+.LP
+${SESMAN_CFG_DIR}/sesman.ini
+.SH "SEE ALSO"
+.LP
+sesman(8) sesrun(8) xrdp(8) xrdp.ini(5)
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/sesman.ini.5.gz b/docs/man/sesman.ini.5.gz
deleted file mode 100644
index 88aa2d54..00000000
--- a/docs/man/sesman.ini.5.gz
+++ /dev/null
Binary files differ
diff --git a/docs/man/sesrun.8 b/docs/man/sesrun.8
new file mode 100644
index 00000000..5a1b2bdf
--- /dev/null
+++ b/docs/man/sesrun.8
@@ -0,0 +1,47 @@
+.TH "sesrun" "8" "0.1.0" "xrdp team" ""
+.SH "NAME"
+.LP
+\fBsesrun\fR \- \fBsesman\fR(8) session launcher
+.SH "SYNTAX"
+.LP
+sesrun <server> <username> <password> <width> <height> <bpp>
+.SH "DESCRIPTION"
+.LP
+\fBsesrun\fR starts a session using \fBsesman\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>
+Server on which sesman is running
+.TP
+<username>
+user name of the session being started
+.TP
+<password>
+user password
+.TP
+<width>
+Screen width
+.TP
+<height>
+Screen height
+.TP
+<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)
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/sesrun.8.gz b/docs/man/sesrun.8.gz
deleted file mode 100644
index 1e4c5540..00000000
--- a/docs/man/sesrun.8.gz
+++ /dev/null
Binary files differ
diff --git a/docs/man/xrdp.8 b/docs/man/xrdp.8
new file mode 100644
index 00000000..b8e0d7fd
--- /dev/null
+++ b/docs/man/xrdp.8
@@ -0,0 +1,44 @@
+.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.
+.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"
+.LP
+${XRDP_BIN_DIR}/xrdp
+.br
+${XRDP_CFG_DIR}/xrdp.ini
+.br
+${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)
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp.8.gz b/docs/man/xrdp.8.gz
deleted file mode 100644
index 2eef6d03..00000000
--- a/docs/man/xrdp.8.gz
+++ /dev/null
Binary files differ
diff --git a/docs/man/xrdp.ini.5 b/docs/man/xrdp.ini.5
new file mode 100644
index 00000000..f46b5609
--- /dev/null
+++ b/docs/man/xrdp.ini.5
@@ -0,0 +1,99 @@
+.\"
+.TH "xrdp.ini" "5" "0.1.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.
+
+\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.
+
+.LP
+All options and values (except for file names and paths) are case insensitive, and are described in detail below.
+.SH "GLOBALS"
+.LP
+
+.TP
+The options to be specified in the \fB[Globals]\fR section are the following:
+.br
+
+.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
+
+.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
+
+
+.TP
+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:
+
+[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
+.SH "FILES"
+.LP
+${XRDP_CFG_DIR}/xrdp.ini
+.SH "SEE ALSO"
+.LP
+xrdp(8) sesman(8) sesrun(8) sesman.ini(5)
+
+for more info on \fBxrdp\fR see http://xrdp.sf.net
diff --git a/docs/man/xrdp.ini.5.gz b/docs/man/xrdp.ini.5.gz
deleted file mode 100644
index 3368af6b..00000000
--- a/docs/man/xrdp.ini.5.gz
+++ /dev/null
Binary files differ