doc: Man page cleanup
Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start.
This commit is contained in:
Philipp Hahn
parent
3b1897470c
commit
e67878cedd
@ -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 \fBsesman\fP(8). This prevents sesman from interfering with real X11 servers. The default is 10.
|
||||
.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
|
||||
\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,64 @@ 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
|
||||
.BR sesman (8),
|
||||
.BR sesrun (8),
|
||||
.BR xrdp (8),
|
||||
|
||||
@ -1,19 +1,17 @@
|
||||
.TH "sesman" "8" "0.1.0" "xrdp team" ""
|
||||
.SH "NAME"
|
||||
.LP
|
||||
\fBsesman\fR \- \fBxrdp\fR(8) session manager
|
||||
|
||||
.SH "SYNTAX"
|
||||
.LP
|
||||
.B sesman
|
||||
.RB [ \-\-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.
|
||||
@ -23,8 +21,8 @@ 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
|
||||
@ -34,13 +32,13 @@ ${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
|
||||
.BR sesman.ini (5),
|
||||
.BR sesrun (8),
|
||||
.BR xrdp (8),
|
||||
|
||||
@ -1,19 +1,17 @@
|
||||
.TH "sesrun" "8" "0.1.0" "xrdp team" ""
|
||||
.SH "NAME"
|
||||
.LP
|
||||
\fBsesrun\fR \- \fBsesman\fR(8) session launcher
|
||||
|
||||
.SH "SYNTAX"
|
||||
.LP
|
||||
.B sesrun
|
||||
.I 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
|
||||
.I server
|
||||
Server on which sesman is running
|
||||
@ -32,18 +30,18 @@ Screen height
|
||||
.TP
|
||||
.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
|
||||
.BR sesman (8),
|
||||
.BR sesman.ini (5),
|
||||
.BR 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,13 @@ ${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
|
||||
.BR xrdp.ini (5),
|
||||
.BR sesman (8),
|
||||
.BR sesman.ini (5),
|
||||
|
||||
@ -1,10 +1,8 @@
|
||||
.\"
|
||||
.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, followed by a list of \fI<parameter>\fR=\fI<value>\fR lines.
|
||||
|
||||
@ -12,88 +10,68 @@ It is composed by a number of sections, each one composed by a section name, enc
|
||||
|
||||
.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
|
||||
\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:
|
||||
|
||||
.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
|
||||
.BR xrdp (8),
|
||||
.BR sesman (8),
|
||||
.BR sesrun (8),
|
||||
|
||||
Loading…
Reference in New Issue
Block a user