summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPhilipp Hahn <hahn@univention.de>2013-01-25 14:27:18 +0100
committerPhilipp Hahn <hahn@univention.de>2013-01-28 11:04:29 +0100
commitab2e950246586fb6af5aed5e94bc7bf76f4b4490 (patch)
treea83920b1c7cf013ffaa24104cf702cc99b90fe97 /docs
parent19efc04e64c8251664897307f8d73dcba382d8df (diff)
downloadxrdp-proprietary-ab2e950246586fb6af5aed5e94bc7bf76f4b4490.tar.gz
xrdp-proprietary-ab2e950246586fb6af5aed5e94bc7bf76f4b4490.zip
doc: xrdp-sesadmin manual page
Add a manual page for xrdp-sessadmin.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/Makefile.am1
-rw-r--r--docs/man/xrdp-sesadmin.857
2 files changed, 58 insertions, 0 deletions
diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am
index 3d816918..daf58d0f 100644
--- a/docs/man/Makefile.am
+++ b/docs/man/Makefile.am
@@ -2,6 +2,7 @@ man_MANS = \
sesman.ini.5 \
xrdp.ini.5 \
xrdp.8 \
+ xrdp-sesadmin.8 \
xrdp-sesman.8 \
xrdp-sesrun.8
diff --git a/docs/man/xrdp-sesadmin.8 b/docs/man/xrdp-sesadmin.8
new file mode 100644
index 00000000..ade1dd58
--- /dev/null
+++ b/docs/man/xrdp-sesadmin.8
@@ -0,0 +1,57 @@
+.TH "xrdp-sesadmin" "8" "0.7.0" "xrdp team"
+.SH NAME
+xrdp\-sesadmin \- console XRDP sessions administration tool
+
+.SH SYNOPSIS
+.B xrdp\-sesadmin
+.RI [ options ]
+.BI -c= command
+
+.SH DESCRIPTION
+This manual page documents briefly the
+.B xrdp\-sesadmin
+command.
+.PP
+\fBxrdp\-sesadmin\fP is a console program to administer running XRDP sessions.
+
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.BI \-u= username
+\fIUsername\fP for authentication on the server.
+Defaults to \fBroot\fP.
+
+.TP
+.BI \-p= password
+The \fIpassword\fP to authenticate with.
+The default is to ask for the password interactively.
+
+.TP
+.BI \-s= server
+The host address of the \fIserver\fP to connect to.
+Defaults to \fBlocalhost\fP.
+
+.TP
+.BI \-i= port
+The TCP \fIport\fP number to connect to.
+Defaults to \fB3350\fP.
+
+.TP
+.BI \-c= command
+Specifies the \fIcommand\fP to execute on the server.
+Valid commands are:
+.RS 4
+.TP
+.B list
+List currently active sessions.
+.TP
+.BI kill: sid
+Kills the session specified the given \fIsession id\fP.
+(not yet implemented).
+.RE
+
+.SH FILES
+xrdp\-sesadmin.log
+
+.SH SEE ALSO
+.BR xrdp (8).