xrdp/docs/man/xrdp-sesrun.8.in

95 lines
2.6 KiB
Groff
Raw Normal View History

2016-12-23 23:02:55 +03:00
.TH "xrdp\-sesrun" "8" "@PACKAGE_VERSION@" "xrdp team" ""
.SH "NAME"
2020-12-03 14:54:22 +03:00
\fBxrdp\-sesrun\fR \- \fBxrdp\-sesman\fR(8) session launcher
.SH "SYNTAX"
.B xrdp\-sesrun
2020-12-03 14:54:22 +03:00
.I [ options ] username
.SH "DESCRIPTION"
\fBxrdp\-sesrun\fR starts a session using \fBxrdp\-sesman\fR(8).
.br
2020-12-03 14:54:22 +03:00
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 without
a username to see what the defaults are for your installation.
The utility prompts for a password if neither \fB-p\fR or \fB-F\fR is used.
.SH "OPTIONS"
2020-06-22 12:27:54 +03:00
.TP
2020-12-03 14:54:22 +03:00
.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
2020-12-03 14:54:22 +03:00
.B -t <session-type>
Session type - one of Xorg, Xvnc or X11rdp. Alternatively, for testing
only, use the numeric session code.
.TP
2020-12-03 14:54:22 +03:00
.B -D <directory>
Directory to run the new session in. Defaults to $HOME for the specified user.
.TP
2020-12-03 14:54:22 +03:00
.B -S <shell>
Specify an alternate shell to run, instead of the default window manager.
.TP
2020-12-03 14:54:22 +03:00
.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
2020-12-03 14:54:22 +03:00
.B
xrdp-sesrun -F 0 user1 <passwd.txt
Create a default session for user \fBuser1\fR with a password from
a file
2020-06-22 12:27:54 +03:00
.TP
2020-12-03 14:54:22 +03:00
.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"
2021-01-20 15:40:54 +03:00
@sbindir@/xrdp\-sesman
.br
@bindir@/xrdp\-sesrun
2020-06-22 12:27:54 +03:00
.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)
2021-01-20 15:40:54 +03:00
For more info on \fBxrdp\fR see
.UR @xrdphomeurl@
.UE