summaryrefslogtreecommitdiff
path: root/data
diff options
context:
space:
mode:
authorRobert Ancell <robert.ancell@canonical.com>2013-11-07 16:24:11 +1300
committerRobert Ancell <robert.ancell@canonical.com>2013-11-07 16:24:11 +1300
commit58f7de828c079106f5de546dbc1d2a8973a549c2 (patch)
tree35484dbfdc03dea3e461e45352f87b217b7368b7 /data
parent5b71a7c7fd842a46979f136235c53b2f3f1244d1 (diff)
downloadlightdm-58f7de828c079106f5de546dbc1d2a8973a549c2.tar.gz
Add a dm-tool man page
Diffstat (limited to 'data')
-rw-r--r--data/Makefile.am3
-rw-r--r--data/dm-tool.163
2 files changed, 65 insertions, 1 deletions
diff --git a/data/Makefile.am b/data/Makefile.am
index ff69580f..89bea381 100644
--- a/data/Makefile.am
+++ b/data/Makefile.am
@@ -24,7 +24,8 @@ dist_apparmor_profile_abstractions_DATA = \
apparmor/abstractions/lightdm \
apparmor/abstractions/lightdm_chromium-browser
-dist_man1_MANS = lightdm.1 \
+dist_man1_MANS = dm-tool.1 \
+ lightdm.1 \
lightdm-set-defaults.1
EXTRA_DIST = apparmor/lightdm-guest-session.in
diff --git a/data/dm-tool.1 b/data/dm-tool.1
new file mode 100644
index 00000000..f4ceae23
--- /dev/null
+++ b/data/dm-tool.1
@@ -0,0 +1,63 @@
+.TH DM-TOOL 1 "7 November 2013"
+.SH NAME
+dm-tool \- a tool to control the display manager
+.SH SYNOPSIS
+.B dm-tool
+[
+.I OPTIONS
+]
+.I COMMAND
+[
+.I ARGS
+]
+.SH DESCRIPTION
+.B dm-tool
+is a tool to communicate with the LightDM display manager.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show help options
+.TP
+.B \-\-version
+Show release version
+.TP
+.B \-\-session-bus
+Attempt to connect to the display manager using the session bus.
+This is useful if you are running a display manager in a test mode.
+If this option is not present dm-tool will connect using the system bus.
+.TP
+The following commands are available:
+.TP
+.B switch-to-greeter
+Switch to the greeter suitable for logging into a new session.
+.TP
+.B switch-to-user USERNAME [SESSION]
+Switch to a user session.
+If this user is already logged in then the display manager will switch to that session, otherwise a new session is started.
+If authentication is required a greeter will start to collect this.
+If the session option is provided then this session type will be used, otherwise the default for this user is used.
+.TP
+.B switch-to-guest [SESSION]
+Switch to a guest session.
+If the guest session is already active the display manager will switch to that session, otherwise the guest session is started.
+If the session option is provided then this session type will be used, otherwise the default for the guest user is used.
+.TP
+.B lock
+Lock the current seat.
+This will swith to a greeter with a hint that the screen is locked.
+You can return to this session by authenticating in the greeter.
+.TP
+.B list-seats
+List the active seats and sessions that are running.
+.TP
+.B add-nested-seat
+Start an X server inside a session and connect it to a display manager.
+.TP
+.B add-local-x-seat DISPLAY_NUMBER
+Connect an existing X server to the display manager.
+.TP
+.B add-seat TYPE [NAME=VALUE...]
+Add a dynamic seat.
+.SH SEE ALSO
+.BR lightdm (1),
+.BR lightdm-set-defaults (1)