mirror of https://github.com/neutrinolabs/xrdp
109 lines
3.0 KiB
Groff
109 lines
3.0 KiB
Groff
.TH "xrdp\-sesrun" "8" "@PACKAGE_VERSION@" "xrdp team" ""
|
|
.SH "NAME"
|
|
\fBxrdp\-sesrun\fR \- \fBxrdp\-sesman\fR(8) session launcher
|
|
|
|
.SH "SYNTAX"
|
|
.B xrdp\-sesrun
|
|
.I --help
|
|
.br
|
|
|
|
.B xrdp\-sesrun
|
|
.I [ options ] [ username ]
|
|
|
|
.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.
|
|
|
|
Default values for the options are set at compile-time. Run the utility with
|
|
the '--help' option to see what the defaults are for your installation.
|
|
|
|
If no username is used, the current username is used, and no password
|
|
needs to be provided. In this instance, it is important that any necessary
|
|
authentication tokens for a GUI session (e.g. a Kerberos ticket) have
|
|
already been acquired.
|
|
|
|
If a username is provided, a password must also be provided. In this instance
|
|
the utility prompts for a password if neither \fB-p\fR or \fB-F\fR is used.
|
|
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.B -g <width>x<height>
|
|
Set session geometry.
|
|
.br
|
|
Note that most configurations will resize the session on connection, so this
|
|
option may not do what you expect.
|
|
.TP
|
|
.B -b <bits-per-pixel>
|
|
Set session bits-per-pixel (colour depth). Some session types (i.e. Xorg)
|
|
will ignore this setting.
|
|
.TP
|
|
.B -t <session-type>
|
|
Session type - one of Xorg or Xvnc. Alternatively, for testing
|
|
only, use the numeric session code.
|
|
.TP
|
|
.B -D <directory>
|
|
Directory to run the new session in. Defaults to $HOME for the specified user.
|
|
.TP
|
|
.B -S <shell>
|
|
Specify an alternate shell to run, instead of the default window manager.
|
|
.TP
|
|
.B -p <password>
|
|
Password for user. USE FOR TESTING ONLY - the password will be visible
|
|
in the output of the \fBps\fR command.
|
|
.TP
|
|
.B -F <file-descriptor>
|
|
Specify a file descriptor (normally 0) to read the password in from. This
|
|
is a secure way to pass the password in to the utility.
|
|
.TP
|
|
.B -c <sesman-ini>
|
|
Specify a different sesman.ini file. This file is used to find out how to
|
|
connect to \fBxrdp\-sesman\fR.
|
|
|
|
.SH "ENVIRONMENT"
|
|
.TP
|
|
.I SESRUN_LOG_LEVEL
|
|
Override the default logging level. One of "error", "warn", "info",
|
|
"debug", "trace" or a number 1-5.
|
|
|
|
.SH "EXAMPLES"
|
|
.TP
|
|
.B
|
|
xrdp-sesrun
|
|
Create a default session for the current user.
|
|
.TP
|
|
.B
|
|
xrdp-sesrun -F 0 user1 <passwd.txt
|
|
Create a default session for user \fBuser1\fR with a password from
|
|
a file
|
|
.TP
|
|
.B
|
|
xrdp-sesrun -t Xvnc -S /usr/bin/xterm user1
|
|
Create an extremely minimal Xvnc session for user \fBuser1\fR. This
|
|
could be useful for debugging why the standard session is not starting
|
|
properly. Note you would need to install the \fBxterm\fR utility
|
|
first. The \fBgnome\-terminal\fR utility probably won't work here.
|
|
|
|
.SH "FILES"
|
|
@sbindir@/xrdp\-sesman
|
|
.br
|
|
@bindir@/xrdp\-sesrun
|
|
.br
|
|
@sysconfdir@/xrdp/sesman.ini
|
|
|
|
.SH "AUTHORS"
|
|
Jay Sorg <jsorg71@users.sourceforge.net>
|
|
.br
|
|
Simone Fedele <ilsimo@users.sourceforge.net>
|
|
|
|
.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
|
|
.UR @xrdphomeurl@
|
|
.UE
|