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

.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
Substitute variables in manual pages 2016-12-23 23:02:55 +03:00			`.TH "xrdp\-sesrun" "8" "@PACKAGE_VERSION@" "xrdp team" ""`
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "NAME"`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`\fBxrdp\-sesrun\fR \- \fBxrdp\-sesman\fR(8) session launcher`
doc: Man page cleanup Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start. 2013-01-25 15:51:57 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "SYNTAX"`
doc: Follow xrdp- rename sesman and sesrun were prefixed with xrdp- a long time ago. Update the manual pags to follow that change as well. 2013-01-25 16:15:15 +04:00			`.B xrdp\-sesrun`
Update sesman tools for new interfaces The sesman tools sesrun and sesadmin now use the separate authentication/authorization (AA) interface introduced to sesman by the previous comment. sesrun can use either password or UDS authentication. With some limitations, this can allow for automatic creation of sessions for local users without a password being needed. sesadmin now operates using UDS logins only and so a username and password are not required. To use sesadmin for another user, use su/sudo/doas to authenticate as the other user. 2022-09-08 17:10:37 +03:00			`.I --help`
			`.br`

			`.B xrdp\-sesrun`
			`.I [ options ] [ username ]`
doc: Format manual page references Use .BR to fromat name(section) as recommended by man(7). Use .I for variable arguments. 2013-01-25 12:58:59 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "DESCRIPTION"`
doc: Follow xrdp- rename sesman and sesrun were prefixed with xrdp- a long time ago. Update the manual pags to follow that change as well. 2013-01-25 16:15:15 +04:00			`\fBxrdp\-sesrun\fR starts a session using \fBxrdp\-sesman\fR(8).`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.br`
Update sesman tools for new interfaces The sesman tools sesrun and sesadmin now use the separate authentication/authorization (AA) interface introduced to sesman by the previous comment. sesrun can use either password or UDS authentication. With some limitations, this can allow for automatic creation of sessions for local users without a password being needed. sesadmin now operates using UDS logins only and so a username and password are not required. To use sesadmin for another user, use su/sudo/doas to authenticate as the other user. 2022-09-08 17:10:37 +03:00			`This is a tool useful for testing. It simply behaves like xrdp when some`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`user logs in a new session and authenticates, thus starting a new session.`

Update sesman tools for new interfaces The sesman tools sesrun and sesadmin now use the separate authentication/authorization (AA) interface introduced to sesman by the previous comment. sesrun can use either password or UDS authentication. With some limitations, this can allow for automatic creation of sessions for local users without a password being needed. sesadmin now operates using UDS logins only and so a username and password are not required. To use sesadmin for another user, use su/sudo/doas to authenticate as the other user. 2022-09-08 17:10:37 +03:00			`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.`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00
Update sesman tools for new interfaces The sesman tools sesrun and sesadmin now use the separate authentication/authorization (AA) interface introduced to sesman by the previous comment. sesrun can use either password or UDS authentication. With some limitations, this can allow for automatic creation of sessions for local users without a password being needed. sesadmin now operates using UDS logins only and so a username and password are not required. To use sesadmin for another user, use su/sudo/doas to authenticate as the other user. 2022-09-08 17:10:37 +03:00			`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.`
doc: Man page cleanup Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start. 2013-01-25 15:51:57 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "OPTIONS"`
Added --config/-c to sesman 2020-06-22 12:27:54 +03:00			`.TP`
sesrun improvements and doc fixes 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.`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.TP`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`.B -t <session-type>`
Remove support for x11rdp X11rdp has been deprecated now since xrdp v0.9.7 (June 2018). This commit removes support for it from xrdp itself. 2023-01-05 14:17:35 +03:00			`Session type - one of Xorg or Xvnc. Alternatively, for testing`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`only, use the numeric session code.`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.TP`
sesrun improvements and doc fixes 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.`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.TP`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`.B -S <shell>`
			`Specify an alternate shell to run, instead of the default window manager.`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.TP`
sesrun improvements and doc fixes 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"`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.TP`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`.B`
Update sesman tools for new interfaces The sesman tools sesrun and sesadmin now use the separate authentication/authorization (AA) interface introduced to sesman by the previous comment. sesrun can use either password or UDS authentication. With some limitations, this can allow for automatic creation of sessions for local users without a password being needed. sesadmin now operates using UDS logins only and so a username and password are not required. To use sesadmin for another user, use su/sudo/doas to authenticate as the other user. 2022-09-08 17:10:37 +03:00			`xrdp-sesrun`
			`Create a default session for the current user.`
			`.TP`
			`.B`
sesrun improvements and doc fixes 2020-12-03 14:54:22 +03:00			`xrdp-sesrun -F 0 user1 <passwd.txt`
			`Create a default session for user \fBuser1\fR with a password from`
			`a file`
Added --config/-c to sesman 2020-06-22 12:27:54 +03:00			`.TP`
sesrun improvements and doc fixes 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.`
doc: Man page cleanup Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start. 2013-01-25 15:51:57 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "FILES"`
Minor manpage fixes 2021-01-20 15:40:54 +03:00			`@sbindir@/xrdp\-sesman`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.br`
docs: sesman and sesrun now have xrdp- prefix 2019-03-20 10:55:02 +03:00			`@bindir@/xrdp\-sesrun`
Added --config/-c to sesman 2020-06-22 12:27:54 +03:00			`.br`
			`@sysconfdir@/xrdp/sesman.ini`
doc: Man page cleanup Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start. 2013-01-25 15:51:57 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "AUTHORS"`
			`Jay Sorg <jsorg71@users.sourceforge.net>`
docs: remove trailing space, put a period at a end of sentence 2016-11-11 08:08:33 +03:00			`.br`
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`Simone Fedele <ilsimo@users.sourceforge.net>`
doc: Man page cleanup Simlify example sections. Remove un-needed .LP after section start. Insert empty line before section start. 2013-01-25 15:51:57 +04:00
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00			`.SH "SEE ALSO"`
doc: Follow xrdp- rename sesman and sesrun were prefixed with xrdp- a long time ago. Update the manual pags to follow that change as well. 2013-01-25 16:15:15 +04:00			`.BR xrdp\-sesman (8),`
doc: Format manual page references Use .BR to fromat name(section) as recommended by man(7). Use .I for variable arguments. 2013-01-25 12:58:59 +04:00			`.BR sesman.ini (5),`
			`.BR xrdp (8),`
			`.BR xrdp.ini (5)`
added new options in sesman.ini old gzipped manpages replaced with unzipped ones to show changes 2006-01-10 23:59:18 +03:00
Minor manpage fixes 2021-01-20 15:40:54 +03:00			`For more info on \fBxrdp\fR see`
			`.UR @xrdphomeurl@`
			`.UE`