From 85835218dc44103ab0388358fa7b824eea57d95f Mon Sep 17 00:00:00 2001 From: ilsimo Date: Tue, 10 Jan 2006 20:59:18 +0000 Subject: [PATCH] added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes --- docs/man/sesman.8 | 44 +++++++++ docs/man/sesman.8.gz | Bin 500 -> 0 bytes docs/man/sesman.ini.5 | 199 +++++++++++++++++++++++++++++++++++++++ docs/man/sesman.ini.5.gz | Bin 1414 -> 0 bytes docs/man/sesrun.8 | 47 +++++++++ docs/man/sesrun.8.gz | Bin 526 -> 0 bytes docs/man/xrdp.8 | 44 +++++++++ docs/man/xrdp.8.gz | Bin 543 -> 0 bytes docs/man/xrdp.ini.5 | 99 +++++++++++++++++++ docs/man/xrdp.ini.5.gz | Bin 987 -> 0 bytes 10 files changed, 433 insertions(+) create mode 100644 docs/man/sesman.8 delete mode 100644 docs/man/sesman.8.gz create mode 100644 docs/man/sesman.ini.5 delete mode 100644 docs/man/sesman.ini.5.gz create mode 100644 docs/man/sesrun.8 delete mode 100644 docs/man/sesrun.8.gz create mode 100644 docs/man/xrdp.8 delete mode 100644 docs/man/xrdp.8.gz create mode 100644 docs/man/xrdp.ini.5 delete mode 100644 docs/man/xrdp.ini.5.gz 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 +.br +Simone Fedele +.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 217909e2a1a2475ecd03cb6210d015ca5d40c3f1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 500 zcmVgiwFP!000001ASB9Z__Xke)nH-s(2U@bGHY?grqAv% zTvUkv)tUFQEc@$5lns3M{8`8@R?#wzlK3SN()?cp1wwB%kjVBg23jNZ05fp=1iZBy zp{%^)R;mKf@EEQ#FqZ2-ue@n=-Dt_JfNMlN3`HiLKGqAQsaJ_5qNq2}UAOf**@U^c zo%T^J3i4WuLf0*3mdfB9GN|*d2x);E;NSz%QKtKGCf7=|$!9zb=vFC5-pTcMgv~gD zn}Cauw6DqLGjF-H7(Ct`e{jP$ z)YPrM6IgN~s1o+fM`se-CSWcyQ3^PfrNM`PGP)li3?W#sWak%f1s%NYwiSzad+Szs qID0Q47z-*~iLUp6ec$dnQUz?RZQf6(9mnJ@DR~A>=WU\fR=\fI\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\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\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\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 88aa2d5478a5410ec7bb312046a7dbf44cdbafc3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1414 zcmV;11$p`(iwFP!000001FctUYa=%l{XV}!ghF@0J4w1-D4{9j;iLw~4tAC;Y)X)4 zG-FX&GnF*!n704D=SmvS__1w26cRjR-RHUY+$*QgCoD;yer6|D*cI2Q)bfO#e8B%% zdY+!)^VQ@vbAqq%e3GPd$WE>vhIkx5vgEnA?lhl^8GC-mZYo{KvN7DrO0z;L!HUYT zttiCa{O~rIx*g7MW~0Za(R30mJ}sqX_;X9aAk1oB?&(KYgMEuEJ8+yPBS*%vYE@TO z!gQ;y!Ycw;*o}2!#kTR=B$Vh%DOS}!4#suP zd^(oB5wDr3oiCQJI)N4>YVMZyEhE4(ZUvLt3T>s6Uw|qJ&`BMoc+urhx_b zM*!^jGXiYPCoU ze3Q(hC)+lY@(LbmNT%#o6ueQMTJPU~INLKn)O?}DM=Q)Hsq5z(6>-c;^w?1%@gX0L;@6BlQ{4lTM6KoH$7}A!Xq7 z^YmfJa%s?7mD%j272DugX5aiVAI=}HCNI~c$;<6%_Sfl=Trr%$ax{3+fE+#wc&3E& z*kF6ndmByN;?dZhszKKabXWv>ji>kbqsjdNy^ahJ>l-EVzt1z(o05@d2dt{fJB+=3 z0N_0W5C%Lf?G?KRglnsTTp;Lo7{d;WQ3(kF48eu16k3)@($*}@(LQ#t{~zKw$YCtL z2o;l1@p-2;DV8Nimk_TGW^q^s7k+ZyOlQN6%V%-Jzz0;-23ccJVMSQf)~0c&w(ow5 zy>PYW8~ft7lE??hw&W%U{R33(vhs1FE((>Q&h}GiHk-~m@8|p8g)um3-FcNySF;Hk zr5#1|+8Ow+Gho@88ybgUyB)DKn%qr0)%Sf>FO9*pV?t_d&6Qu$SlTk%H z_wqp2W`o(NOEgKbb02DNJ!qh~PZv#zU6_kOf128`m$0@Qw>owBRQ@{^rjE?pWVZgKpLbiDQeR zFO+O=p)rauN-s|vYfe>_adk?+LwciYE9Wt|^d#vA8}Po23G~o!MG3IGQHR!cPTt(@ z&PgB@r02sS!!2zZ6~Zz7?!Xf^Gd)p|?I$U|`S3PLsCPW6h~$_(R0R?Ut3 +.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 on which sesman is running +.TP + +user name of the session being started +.TP + +user password +.TP + +Screen width +.TP + +Screen height +.TP + +Session color depth +.SH "FILES" +.LP +${SESMAN_BIN_DIR}/sesman +.br +${SESMAN_BIN_DIR}/sesrun +.SH "AUTHORS" +.LP +Jay Sorg +.br +Simone Fedele +.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 1e4c55401796700c5cafffcb8fcad8ad3ccc321d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 526 zcmV+p0`dJHiwFP!0000019ekTYuhjoe)q39!X8@al=fk)j1ZQtF3m`j5_zyepeXh^ z(q>CWlAD#W|GtytBy4mKiSDfXK7ZfcnHBdia_DTYM=-jk-zB?ZmvsKLRR zPGQnhq(zGqcEY*6u@!}TRe4FLM75Kif^FAL6WwjjKdtAF#eB7VO_uY*dI#btrguv3 z{*}rgV_OSZA(aCa%DpiS)neT@P#a54aGrn{pgcI$cFhZHQHp1D(5N2>u~U1A8k}h{ zAT2azM{JtdH13ZAgswpJo=Uwc1@T^hm%U3$gSNlQS#r6G2KnHS74&!PS;k`k#J!iQ zl#rYSAJha*lmp<@+brq}F_@ZOk4JS|3=*OitOnd^5D9n4hwC()jF%S4e$3(xT^;6i zxJ>zgi!UgOrOOIaAS8c`R?d=fAujqa?F|DmPmu%A=BumiJ7a`XoNegutAuph9+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 +.br +Simone Fedele +.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 2eef6d0310636cda9645ddfbda6be6a855873ab6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 543 zcmV+)0^t20iwFP!000001BFvvZ__Xoeb2ABs(2_8bvqDZLeoUo4;EIED#@UTqRFk@ z)-<&v+hIc+|DEeN1y2*=p^bgN&N=tUq_~96on}=BI;Z#>kP|ZK_z+l54|wiGB*&^` z_;G^A*&L$f=E4;$HyJE@Kq2D?WjTzw*;`e?Tq~>As)TMfo<9e}^$)K7ko-$h3>WQ~ z2IMP_SoWl16o*K7Xs&xvmhExJ%L=~v?(rlaW%0a-)8r`=VgAb`ZR{@uJg4Z{7+fg;$L$LskvLaDR?zlv}E; z3CRly8>RVHt6DO=8MKyx+JJGTLT*7=Pr{EO0nR?eamL_1y27skT}$bj1Ei<@yRhH6 z>H5>!R=BOkTp^L$fm(s~Q>4f5gl)A?{Mr2icXM+QCpY6b`_*@d-pMvIn!f*= zAwr5r*;yK9OSOHJoyX%KTM6dzhu6hrnjIN@K-Y7nw{Z5|;OEWBJ7=jOM%8-FQ3QG> zxjpxjbAgNCFy)Mw9L_{(F!0Zg=5b6WFr4LS@I0K1?rZmk%z?`8>G2fA(FBY~5l({x hn%wLYaF>BAhI80iTfOajfo9`iqu&u#)4l!!001Wp5kLR{ 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\fR=\fI\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\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\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\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\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 3368af6b3d025a7216470143070418c92ec87d0b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 987 zcmV<110?((iwFP!000001GQFNYuic?eb=uTOrZ(5N_?U866%8MxVeTj32`0@^(CyN zmAzEjRd-i*Lfij-XZFLgmGnNelr%(|osTnT&a9d)2au$9|G?lu7fmXp7{K5){+_0z z^mO3OU^%Ptd61+F^t_sUoZ;i;4J6C*eT-X{x3GK#Qzc8WYBjS$Nhn3dp;Q`zBRU=Z zeeBbm&lc0$`OV$@`YL3*TMGmD&#pPtOhUs}2hpL-@Gu+XPfDiA+)|=k)r~T|fb0<% z$hOY7233OLIr*9)aF(w@N#1h}4j@_0(Mjf2JTqTgra5GqN9+(;o*; zF60BNut_)DNmYSrd}1o^xG-?UA9CJU2hxd!8226xvukq<#CFaM6*pWOVa0~~4(O!d zCf6cE{t;rq5orY($BCp~WEYp$?|385*~3v=|@q>R=4B{eoBwr(2J!_@EB2j zEUS