More documentation work

20 files changed, 264 insertions, 122 deletions

diff --git a/help/C/auto-login.page b/help/C/auto-login.page
deleted file mode 100644
index a35f8c30..00000000
--- a/help/C/auto-login.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="auto-login">
-
-<info>
-  <link type="guide" xref="index#authentication"/>
-</info>
-  
-<title>Automatic Login</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/autologin.page b/help/C/autologin.page
new file mode 100644
index 00000000..cb76c0b0
--- /dev/null
+++ b/help/C/autologin.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="auto-login">
+
+<info>
+  <link type="guide" xref="index#authentication"/>
+</info>
+  
+<title>Automatic/Timed Login</title>
+
+<p>
+Automatic and timed login allows a <link xref="index#sessions">user session</link> to be started without any authentication.
+This is useful for systems where security is not required (for example personal laptops) and kiosk type systems where the user session is considered secure.
+</p>
+<p>
+Automatic login is <link xref="config">configured</link> for a seat by setting the <code>autologin-user</code> setting to the name of the user account to automatically log into or setting <code>autologin-guest</code> to <code>true</code> to automatically log into a guest account.
+You can set <code>autologin-session</code> to set the session to override the <link xref="default-session">default</link>.
+</p>
+<p>
+Timed login is configured by setting <code>autologin-user-timeout</code> to the number of seconds to wait until performing the automatic login.
+During this time a greeter will be displayed allowing the user to pick another account before the timer expires.
+</p>
+<p>
+When performing an automatic login LightDM uses the <code>lightdm-autologin</code> PAM service.
+</p>
+</page>
diff --git a/help/C/available-greeters.page b/help/C/available-greeters.page
deleted file mode 100644
index e6dff66d..00000000
--- a/help/C/available-greeters.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="available-greeters">
-
-<info>
-  <link type="guide" xref="index#greeters"/>
-</info>
-
-<title>Available greeters</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/available-sessions.page b/help/C/available-sessions.page
deleted file mode 100644
index 34ea27c6..00000000
--- a/help/C/available-sessions.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="define-session">
-
-<info>
-  <link type="guide" xref="index#sessions"/>
-</info>
-
-<title>Available sessions</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/config.page b/help/C/config.page
index 5e946007..7caada37 100644
--- a/help/C/config.page
+++ b/help/C/config.page
@@ -9,6 +9,35 @@
 <title>Configuration</title>
 
 <p>
+Configuration is in <file>/etc/lightdm</file>.
+The main configuration file is a keyfile called <file>lightdm.conf</file> containing the following sections:
 </p>
+<list>
+<item>
+<p>
+<code>[LightDM]</code> - Settings that applies to everything in LightDM.
+</p>
+</item>
+<item>
+<p>
+<code>[SeatDefaults]</code> - Settings that apply to all <link xref="seat">seats</link>.
+</p>
+</item>
+<item>
+<p>
+<code>[Seat:<em>name</em>]</code> - Settings for the named seat that overrides settings from <code>[SeatDefaults]</code>.
+</p>
+</item>
+<item>
+<p>
+<code>[XDMCPServer]</code> - Settings for <link xref="xdmcp">remote access using XDMCP</link>.
+</p>
+</item>
+<item>
+<p>
+<code>[VNCServer]</code> - Settings for <link xref="vnc">remote access using VNC</link>.
+</p>
+</item>
+</list>
 
 </page>
diff --git a/help/C/default-greeter.page b/help/C/default-greeter.page
index 4556d7db..1384fc46 100644
--- a/help/C/default-greeter.page
+++ b/help/C/default-greeter.page
@@ -6,9 +6,10 @@
   <link type="guide" xref="index#greeters"/>
 </info>
 
-<title>Setting the greeter</title>
+<title>Default Greeter</title>
 
 <p>
+
 </p>
 
 </page>
diff --git a/help/C/multi-seat.page b/help/C/diagnostics.page
index 1dec7612..95448b8f 100644
--- a/help/C/multi-seat.page
+++ b/help/C/diagnostics.page
@@ -1,14 +1,15 @@
 <page xmlns="http://projectmallard.org/1.0/"
       type="guide"
-      id="multi-seat">
+      id="diagnostics">
 
 <info>
   <link type="guide" xref="index#display-management"/>
 </info>
-  
-<title>Multi Seat</title>
+
+<title>Diagnostics</title>
 
 <p>
+LightDM logs all activity into files in <file>/var/log/lightdm</file>.
 </p>
 
 </page>
diff --git a/help/C/guest.page b/help/C/guest.page
index aca5ff33..e14f0e89 100644
--- a/help/C/guest.page
+++ b/help/C/guest.page
@@ -3,12 +3,18 @@
       id="guest-account">
 
 <info>
-  <link type="guide" xref="index#authentication"/>
+  <link type="guide" xref="index#sessions"/>
 </info>
   
-<title>Guest Account</title>
+<title>Guest Sessions</title>
 
 <p>
+A guest session is a user session that doesn't require authentication.
+When selected a temporary user account is created with a default setup.
+When the guest session is exited the temporary account and its user data is removed.
+</p>
+<p>
+Guest sessions are enabled by default, though depending on what greeter is used they may not be made available to the user.
 </p>
 
 </page>
diff --git a/help/C/index.page b/help/C/index.page
index 6af3348e..ed2c6be9 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -13,8 +13,27 @@
 <title>LightDM Help</title>
     
 <p>
-LightDM is a <em>display manager</em>.
+LightDM is a <em>Display Manager</em>.
+It is a long running process (daemon) that ensures that your graphical display is set up correctly.
 </p>
+<p>
+The LightDM daemon spawns and manages two types of processes:
+</p>
+<list>
+<item>
+<p>
+Display Servers - a process that combines graphical output from one or more process together to display on graphics hardware.
+Also provides input from mice / keyboards etc to the process. For example X is a display server.
+</p>
+</item>
+<item>
+<p>
+Sessions - a session is a process that has access to the display server and allows the user to perform tasks.
+Often a session will be made up of a core component, the shell, that allows the user to run applications.
+Both the shell and the applications communicate with the display server.
+</p>
+</item>
+</list>
     
 <section id="display-management" style="2column">
   <title>LightDM for Display Management</title>
@@ -22,18 +41,30 @@ LightDM is a <em>display manager</em>.
 
 <section id="authentication" style="2column">
   <title>Authentication</title>
+  <p>
+  Authentication is performed using PAM.
+  </p>
 </section>
 
 <section id="greeters" style="2column">
   <title>Greeters</title>
+  <p>
+  A greeter is a session that provides a mechanism for choosing and authentication users.
+  </p>
 </section>
 
 <section id="sessions" style="2column">
-  <title>Sessions</title>
+  <title>User Sessions</title>
+  <p>
+  A user session allows a user to interact with their computer and run applications.
+  </p>
 </section>
 
 <section id="remote-access" style="2column">
   <title>Remote Access</title>
+  <p>
+  You can allow remote computers to connect to LightDM and start sessions.
+  </p>
 </section>
 
 </page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
deleted file mode 100644
index cd9f6c3c..00000000
--- a/help/C/introduction.page
+++ /dev/null
@@ -1,16 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="introduction">
-
-<info>
-  <!-- Place this at the start of the section -->
-  <title type="sort">0</title>
-  <link type="guide" xref="index#display-management"/>
-</info>
-  
-<title>Introduction</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/ldap.page b/help/C/ldap.page
deleted file mode 100644
index bba9dc24..00000000
--- a/help/C/ldap.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="ldap">
-
-<info>
-  <link type="guide" xref="index#authentication"/>
-</info>
-
-<title>Using LDAP accounts</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/local-sessions.page b/help/C/local-sessions.page
new file mode 100644
index 00000000..3c6e27b2
--- /dev/null
+++ b/help/C/local-sessions.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="local-sessions">
+
+<info>
+  <link type="guide" xref="index#sessions"/>
+</info>
+
+<title>Local Sessions</title>
+
+<p>
+A local session allows a user to authenticate from a greeter and access their local system.
+</p>
+<p>
+Local sessions are registered with a desktop file in <file>/usr/share/xsessions/<em>name</em>.desktop</file>.
+The following keys are used:
+</p>
+<list>
+<item>
+<p>
+Name, Comment - May be used in the greeter to describe this session
+</p>
+</item>
+<item>
+<p>
+Exec - Command to run for this session
+</p>
+</item>
+</list>
+
+</page>
diff --git a/help/C/multi-session.page b/help/C/multi-session.page
deleted file mode 100644
index 7859c4d1..00000000
--- a/help/C/multi-session.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="multi-session">
-
-<info>
-  <link type="guide" xref="index#display-management"/>
-</info>
-  
-<title>Multi Session</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/nfs.page b/help/C/nfs.page
deleted file mode 100644
index 129bee60..00000000
--- a/help/C/nfs.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="nfs">
-
-<info>
-  <link type="guide" xref="index#authentication"/>
-</info>
-
-<title>NFS</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/pam.page b/help/C/pam.page
deleted file mode 100644
index 840de5a0..00000000
--- a/help/C/pam.page
+++ /dev/null
@@ -1,14 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="guide"
-      id="pam">
-
-<info>
-  <link type="guide" xref="index#authentication"/>
-</info>
-
-<title>PAM</title>
-
-<p>
-</p>
-
-</page>
diff --git a/help/C/remote-sessions.page b/help/C/remote-sessions.page
new file mode 100644
index 00000000..afc38f9e
--- /dev/null
+++ b/help/C/remote-sessions.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="remote-sessions">
+
+<info>
+  <link type="guide" xref="index#sessions"/>
+</info>
+
+<title>Remote Sessions</title>
+
+<p>
+A remote session allows a user to authenticate from a greeter and access a remote system.
+</p>
+<p>
+Remote sessions are registered with a desktop file in <file>/usr/share/lightdm/remote-sessions/<em>name</em>.desktop</file>.
+The following keys are used:
+</p>
+<list>
+<item>
+<p>
+Name, Comment - May be used in the greeter to describe this session
+</p>
+</item>
+<item>
+<p>
+Exec - Command to run for this session
+</p>
+</item>
+<item>
+<p>
+X-LightDM-PAM-Service - PAM service to authenticate with
+</p>
+</item>
+</list>
+<p>
+Instead of using <link xref="standard-authentication">standard authentication</link> each remote session defines its own PAM service.
+This service should contact the server providing the session, perform authentication and then the command specified in <code>Exec</code> should run a program that displays the remote session.
+</p>
+
+</page>
diff --git a/help/C/seat.page b/help/C/seat.page
new file mode 100644
index 00000000..881843fa
--- /dev/null
+++ b/help/C/seat.page
@@ -0,0 +1,15 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="seat">
+
+<info>
+  <link type="guide" xref="index#display-management"/>
+</info>
+  
+<title>Seats</title>
+
+<p>
+Some systems allow more than one display device to be connected to them to allow multiple users to use the system at once.
+</p>
+
+</page>
diff --git a/help/C/standard-authentication.page b/help/C/standard-authentication.page
new file mode 100644
index 00000000..bc05889a
--- /dev/null
+++ b/help/C/standard-authentication.page
@@ -0,0 +1,21 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="standard-authentication">
+
+<info>
+  <link type="guide" xref="index#authentication"/>
+</info>
+
+<title>Standard Authentication</title>
+
+<p>
+Authentication is performed using the <code>lightdm</code> PAM service.
+This service is configured by default to use the unix PAM modules and performs traditional password authentication.
+Authentication is initiated by the greeter and may involve informational messages and prompts to the user.
+Once authentication is complete the greeter is allowed to start a <link xref="index#sessions">user session</link>.
+</p>
+<p>
+If required this service can be modified to support any authentication scheme that is compatible with PAM.
+</p>
+
+</page>
diff --git a/help/C/user-list.page b/help/C/user-list.page
new file mode 100644
index 00000000..13e10ed3
--- /dev/null
+++ b/help/C/user-list.page
@@ -0,0 +1,17 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="user-list">
+
+<info>
+  <link type="guide" xref="index#greeters"/>
+</info>
+
+<title>User List</title>
+
+<p>
+A greeter may choose to display a list of available users to choose from.
+This list can be accessed using <code>liblightdm</code> and the information is taken from AccountsService.
+If accounts service is not available, then the user list is obtained using the <code>getpwent</code> system call.
+</p>
+
+</page>
diff --git a/help/C/user-switching.page b/help/C/user-switching.page
new file mode 100644
index 00000000..aa5651be
--- /dev/null
+++ b/help/C/user-switching.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="multi-session">
+
+<info>
+  <link type="guide" xref="index#display-management"/>
+</info>
+
+<title>User Switching</title>
+
+<p>
+<em>User switching</em> is a method of running more than one session at a time on a <link xref="seat">seat</link> and switching between them.
+Only one session can be used at a time.
+The session is switched by contacting the display manager using D-Bus and calling the one of the following method on the Seat object:
+</p>
+<list>
+<item>
+<p>
+SwitchToGreeter - A greeter session is started. This allows the user to authenticate for a new session or authenticate to return to their current session.
+</p>
+</item>
+<item>
+<p>
+SwitchToUser - If there is a session for the given user then it is switched to, otherwise a greeter is started.
+</p>
+</item>
+<item>
+<p>
+SwitchToGuest - If a guest session is active it is switched to, otherwise a guest session is started.
+</p>
+</item>
+</list>
+<p>
+Switching is performed using <em>virtual terminals</em> in the kernel.
+Each session has a separate display server and the selected session is activated by changing the active virtual terminal.
+</p>
+
+</page>