Added initial infrastructure and content for gdmconfig user guide.

The guide itself is being written by Trevor Curtis, and is not installed yet.

5 files changed, 644 insertions, 0 deletions

diff --git a/docs/gdmconfig/C/Makefile.am b/docs/gdmconfig/C/Makefile.am
new file mode 100644
index 00000000..778a9cf8
--- /dev/null
+++ b/docs/gdmconfig/C/Makefile.am
@@ -0,0 +1,6 @@
+figs = 
+app = gdmconfig
+lang = C
+omffiles=gdmconfig-C.omf
+include $(top_srcdir)/app-docs.make
+dist-hook: app-dist-hook
diff --git a/docs/gdmconfig/C/gdmconfig-C.omf b/docs/gdmconfig/C/gdmconfig-C.omf
new file mode 100644
index 00000000..faa1c4f5
--- /dev/null
+++ b/docs/gdmconfig/C/gdmconfig-C.omf
@@ -0,0 +1,14 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+  <resource>
+    <title>
+      The GDM Configurator Manual
+    </title>
+    <subject>
+      <category>GNOME|Core Desktop</category>
+    </subject>
+    <format mime="text/sgml"/>
+    <identifier url="gdmconfig.sgml"/>
+    <language code="C"/>
+  </resource>
+</omf>
diff --git a/docs/gdmconfig/C/gdmconfig.sgml b/docs/gdmconfig/C/gdmconfig.sgml
new file mode 100644
index 00000000..ff112d1a
--- /dev/null
+++ b/docs/gdmconfig/C/gdmconfig.sgml
@@ -0,0 +1,622 @@
+<!DOCTYPE article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+        <!-- if not using PNG graphic, replace reference above with
+             .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
+         -->
+<!ENTITY version "2.0.97.1"> <!-- replace with application version -->
+]>
+
+
+<!-- 
+  This is a GNOME documentation template, designed by the GNOME
+  Documentation Project Team. Please use it for writing GNOME
+  documentation, making obvious changes. In particular, all the words
+  written in UPPERCASE (with the exception of GNOME) should be
+  replaced. As for "legalnotice", please leave the reference
+  unchanged.
+
+  Remember that this is a guide, rather than a perfect model to follow
+  slavishly. Make your manual logical and readable.  And don't forget
+  to remove these comments in your final documentation!  ;-)
+-->
+
+<!-- 
+      (Do not remove this comment block.)
+  Maintained by the GNOME Documentation Project
+  http://developer.gnome.org/projects/gdp
+  Template version: 1.0.3
+  Template last modified: Nov 16, 2000
+-->
+
+
+<!-- =============Document Header ============================= -->
+
+<article id="index"> <!-- please do not change the id -->
+
+  <artheader>
+    <title>Gdmconfig Manual</title>
+    <copyright>
+      <year>2001</year>
+      <holder>Trevor Curtis</holder>
+    </copyright>
+
+  <!-- translators: uncomment this:
+
+  <copyright>
+   <year>2000</year>
+   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+  </copyright>
+
+   -->
+
+  <!-- do not put authorname in the header except in copyright - use
+  section "authors" below -->
+
+  <!-- Use this legal notice for online documents which depend on -->
+  <!-- core GNOME packages.                                       -->
+  <legalnotice id="legalnotice">
+   <para>
+    Permission is granted to copy, distribute and/or modify this document
+    under the terms of the <ulink type="help" 
+    url="gnome-help:fdl"><citetitle>GNU Free Documentation
+    License</citetitle></ulink>, Version 1.1 or any later version 
+    published by the Free Software Foundation with no Invariant Sections, 
+    no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
+    can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
+   </para>
+   <para>
+    Many of the names used by companies to distinguish their products and
+    services are claimed as trademarks. Where those names appear in any
+    GNOME documentation, and those trademarks are made aware to the members
+    of the GNOME Documentation Project, the names have been printed in caps
+    or initial caps.
+   </para>
+  </legalnotice>
+
+  <!-- Use this legal notice for documents which are placed on  -->
+  <!-- the web, shipped in any way other than online documents  -->
+  <!-- (eg. PS, PDF, or RTF), or which do not depend on the     -->
+  <!-- core GNOME distribution.                                 -->
+  <!--                                                          -->
+  <!-- If you use this version, you must place the following    -->
+  <!-- line in the document declaration at the top of your      -->
+  <!-- document:                                                -->
+  <!--   <!ENTITY FDL SYSTEM "fdl.sgml">                        -->
+  <!-- and the following line at the bottom of your document    -->
+  <!-- after the last </sect1>.                                 -->
+  <!--   &FDL;                                                  -->
+  <!--
+  <legalnotice id="legalnotice">
+   <para>
+    Permission is granted to copy, distribute and/or modify this document
+    under the terms of the <link linkend="fdl"><citetitle>GNU
+    Free Documentation License</citetitle></link>, Version 1.1 or any later
+    version published by the Free Software Foundation with no Invariant
+    Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
+    license can be found in <xref linkend="fdl">.
+   </para>
+   <para>
+    Many of the names used by companies to distinguish their products and
+    services are claimed as trademarks. Where those names appear in any
+    GNOME documentation, and those trademarks are made aware to the members
+    of the GNOME Documentation Project, the names have been printed in caps
+    or initial caps.
+   </para>
+  </legalnotice>
+  -->
+
+  <!-- This is the manual version, not application version. --> 
+    <releaseinfo>
+       This is version 1.0 of manual.
+    </releaseinfo>
+
+  </artheader>
+
+ <!-- ============= Document Body ============================= -->
+
+ <!-- ============= Introduction ============================== -->
+  <sect1 id="intro">
+    <title>Introduction</title>
+
+    <para>
+     <application>GDM Configurator, (GNOME Display Manager Configurator)</application> is a configuration application
+     for the GDM (Gnome Display Manager). Typically, when running your
+     system in a
+     graphical login mode, the GDM is the application that facilites
+     logins. <application>GDM Configurator</application> allows for easy
+     configuration of the GDM at various levels of detail.
+     Customizations affect both operations and appearances.
+    </para>
+
+    <para>
+      To run <application>GDM Configurator</application>, select
+      <menuchoice>
+	<guisubmenu>System</guisubmenu>
+	<guimenuitem>GDM Configurator</guimenuitem>
+      </menuchoice>
+      from the <guimenu>Main Menu</guimenu>, or type
+      <command>gdmconfig</command> on the command line.
+    </para>
+
+    <note><title>Root access required</title>
+    <para><application>GDM Configurator</application> requires root access to run.
+    </para> </note>
+
+    <para>
+      <application>GDM Configurator</application> is included in the
+      <filename>Gnome-Core</filename> package, which is part of the
+      GNOME desktop environment. This document describes version
+      &version; of <application>GDM Configurator</application>.
+    </para>
+  </sect1>
+
+
+ <!-- ================ Usage ================================ -->
+ <!-- This section should describe basic usage of the application. -->
+
+  <sect1 id="usage">
+    <title>Using Gnome Display Manager Configurator</title>
+    <para>
+      <application>GDM Configurator</application> can be used to
+      change the login apperance, and behaviour as well as
+      security and environment options of the GDM to varying
+      degrees of detail. This section describes basic usage of
+      <application>GDM Configurator</application>.
+    </para>
+
+    <!-- ========= Basic Usage =========================== -->
+    <sect2 id="mainwin">
+      <title>Basic usage</title>
+      <para>
+        Starting <application>GDM Configure</application> opens the
+        <interface>Main window</interface>, shown in <xref
+        linkend="mainwindow-fig">. This window contains all
+        options relating to the GDM's configuration.
+
+        <!-- ==== Figure ==== -->
+        <figure id="mainwindow-fig">
+	  <title>MY-GNOME-APP Main Window</title>
+	  <screenshot>
+	    <screeninfo>MY-GNOME-APP Main Window</screeninfo>
+	    <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
+            </graphic>
+	  </screenshot>
+	</figure>
+    <!-- ==== End of Figure ==== -->
+      </para> 
+
+
+ <!-- For this app, one could put "proving" or "edit" (probably even
+      both of them) as sect2's seperate from the main window
+      section. Since they were both so closely involved with the main
+      window, I decided to have them as sect3's isntead. Judgement
+      call. -->
+
+      <sect3 id="options">
+	<title>Options</title>
+	<para>
+          The <guilabel>Options</guilabel> box in the upper left hand
+          corner controls the level of detail and customization
+          offered on the tabs to its right. Below the the Options box
+          is a brief description of the level chosen, and what can be
+          done in that level. The levels are explained below.
+        </para>
+	<para>
+                <variablelist>
+	    <varlistentry>
+	      <term><guilabel>Basic</guilabel></term>
+	      <listitem>
+		<para>
+                  This exposes the <guilabel>Login
+                  appearance</guilabel>, <guilabel>Login
+                  behaviour</guilabel>, and <guilabel>Face
+                  browser</guilabel> tabs to the right
+                  of the <guilabel>Options</guilabel> box.
+                </para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+            <term><guilabel>Expert</guilabel></term>
+	    <listitem>
+	      <para>
+	        This exposes the <guilabel>Security</guilabel>,
+                <guilabel>XDMCP</guilabel>, and <guilabel>X-server 
+                setup</guilabel> tabs to the right
+                of the <guilabel>Options</guilabel> box.               
+	      </para>
+	    </listitem>
+            </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>System</guilabel></term>
+	      <listitem>
+	      <para>
+	        This exposes the <guilabel>Paths</guilabel>,
+                <guilabel>Environment</guilabel>, and <guilabel>
+		Chooser</guilabel> tabs to the right
+                of the <guilabel>Options</guilabel> box.             
+              </para>
+	    </listitem>
+            </varlistentry>
+	  </variablelist>
+          </para>
+
+   <!-- You might want to include a note, warning, or tip, e.g. -->
+	
+	<caution>
+	  <title>Expert option and security</title>
+	  <para>
+	    Enabling export mode, allows for changes in GDM's
+	    security to be made. Improper configuration may lead to
+	    vulnerabilities for attackers.
+          </para>
+	</caution>
+	<warning>
+	  <title>System option and system health</title>
+	  <para>
+	    Enabling system mode, allows for very specific changes
+	    which can impact the operation of your system. This option
+	    is only recommended for those who know exactly what they
+	    are doing.  You have been warned!
+	  </para>
+	</warning>
+      </sect3>
+      <sect3 id="basic">
+	<title>The Basic options</title>
+	<para>
+	  Below are the options for the <guilabel>Login
+	  appearance</guilabel>, <guilabel>Login behaviour</guilabel>
+	  and <guilabel>Face browser</guilabel> tabs.
+        </para>
+
+     <variablelist><title><guilabel>Login appearance</guilabel></title>
+	    <varlistentry>
+	      <term><guibutton>Minimised Icon:</guibutton></term>
+	      <listitem>
+	        <para>
+		  Change the icon that represents the login screen
+		  when minimized.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Logo</guilabel></term>
+	      <listitem>
+	        <para>
+		  Change the image that is displayed in the login
+		  window
+		</para>
+              </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Gtk+ RC file</guilabel></term>
+	      <listitem>
+	        <para>
+		  Specify the location of <filename>.gtkrc</filename>
+		</para>
+	      </listitem>
+	    </varlistentry>
+	 </variablelist>
+
+     <variablelist><title><guilabel>Login behaviour</guilabel></title>
+	    <varlistentry>
+	      <term><guibutton>Show the 'system' menu:</guibutton></term>
+	      <listitem>
+	        <para>
+		  Enable shutdown, and reboots from the login screen
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guibutton>Quiver on failure</guibutton></term>
+	      <listitem>
+	        <para>
+		  If login fails, make the login window shake.
+		</para>
+              </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Exclude these users</guilabel></term>
+	      <listitem>
+	        <para>
+		  Do not show the users in the user menu, on the login box.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guibutton>Default font:</guibutton></term>
+	      <listitem>
+	        <para>
+		  The font to display and default to.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Welcome message</guilabel></term>
+	      <listitem>
+	        <para>
+		  The text message to display in the login screen.
+		</para>
+		<note><title>Display machine name</title> 
+		  <para>To have GDM display your machine name you can
+		  type %n in the <guilabel>Welcome message</guilabel>
+		  field, and it will
+		  always be replaced with whatever your machine's name 
+		  is.
+		  </para> 
+	        </note>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Background Program</guilabel></term>
+	      <listitem>
+	        <para> ????????????? 
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Default locale</guilabel></term>
+	      <listitem>
+	        <para>The locale that should be set as default in the
+	        GDM
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guibutton>Lock position</guibutton></term>
+	      <listitem>
+	        <para>Lock the login box, such that it cannot be moved
+	          within the login screen.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guibutton>Manually set
+	        position</guibutton></term>
+	      <listitem>
+	        <para>Allow for the login box to be moved manually
+	          within the login screen
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>X position</guilabel></term>
+	      <listitem>
+	        <para>The x coordinate for the login box placement
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Y position</guilabel></term>
+	      <listitem>
+	        <para>The y coordinate for the login box placement
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><guilabel>Xinerama screen</guilabel></term>
+	      <listitem>
+	        <para>???????????
+		</para>
+              </listitem>
+	    </varlistentry>
+	 </variablelist>
+
+	 <variablelist><title><guilabel>Face browser</guilabel>
+	                    </title>
+	   <varlistentry>
+	     <term><guibutton>Show choosable user
+	     images</guibutton></term>
+	     <listitem>
+	       <para>Customization of user images in the face
+	         browser
+	       </para>
+	     </listitem>
+	   </varlistentry>
+	   <varlistentry>
+	     <term><guilabel>Default face image</guilabel></term>
+             <listitem>
+	       <para>Change the image used for default users in the
+	       face browser
+	       </para>
+	     </listitem>
+	   </varlistentry>
+	   <varlistentry>
+	     <term><guilabel>Global faces
+	     directory</guilabel></term>
+	     <listitem>
+	       <para>The directory where the face images reside
+	       </para>
+	     </listitem>
+	   </varlistentry>
+	   <varlistentry>
+	     <term><guilabel>Maximum face width</guilabel></term>
+	     <listitem>
+	       <para>The maximum width any given face image may be
+	       </para>
+	     </listitem>
+	   </varlistentry>
+	   <varlistentry>
+	     <term><guilabel>Maximum face height</guilabel></term>
+	     <listitem>
+	       <para>The maximum height any given face image may be
+	       </para>
+	     </listitem>
+	   </varlistentry>
+	 </variablelist>
+      </sect3>
+
+
+  <!-- If there are other functions performed from the main window,
+       they belong here.   -->
+
+    </sect2>
+ 
+    <!-- ========================================================= 
+      Additional Sect2's should describe additional windows, such as
+      larger dialog boxes, or functionality that differs significantly
+      from the most immediate functions of the application. Make the
+      structure logical.
+      =============================================================  -->
+
+
+    <sect2 id="menubar">
+      <title>Toolbar</title>
+      <para>
+        Toolbar Menus
+      </para>
+      <para>
+        <figure id="figure-usage-toolbar">
+	  <title><application>GDM Configurator</application> Toolbar</title>
+	  <screenshot>
+	    <screeninfo><application>GDM Configurator</application> 
+	                   Toolbar</screeninfo>
+	    <graphic fileref="usage-toolbar.png" format="png"></graphic>
+	  </screenshot>
+	</figure>
+        <variablelist><title><guimenu>Configuration
+	</guimenu></title>
+	  <varlistentry>
+	    <term><guimenuitem>Revert settings</guimenuitem></term>
+	    <listitem>
+	      <para>
+                Reset current changes to initial settings
+              </para>
+	    </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term><guimenuitem>Apply</guimenuitem></term>
+	    <listitem>
+	      <para>
+                Apply current changes  
+              </para>
+	    </listitem>
+	  </varlistentry>
+	</variablelist>
+       </para>
+       
+       <para>
+       <variablelist><title><guimenu>Help</guimenu></title>
+         <varlistentry>
+           <term><guimenuitem>GDM
+             Configurator
+             users guide</guimenuitem>
+           </term>
+	   <listitem>
+	     <para>How to get this document from within <application>GDM
+	       Configurator</application>.
+	     </para>
+	   </listitem>
+	 </varlistentry>
+	 <varlistentry>
+	   <term><guimenuitem>About...</guimenuitem></term>
+	   <listitem>
+	     <para>A little bit of kudos for all of the very hard
+	       working guys/gals who made it all possible	
+	     </para>
+	   </listitem>
+	 </varlistentry>
+       </variablelist>
+       </para>
+       
+    </sect2>
+ </sect1>
+    
+ <!-- ============= Bugs ================================== -->
+ <!-- This section should describe known bugs and limitations of
+      the program if there are any - please be frank and list all
+      problems you know of. -->
+ <sect1 id="bugs">
+  <title>Known Bugs and Limitations</title>
+  <para>
+   This application has no known bugs.
+  </para>
+ </sect1>
+
+
+<!-- ============= Authors ================================ -->
+
+ <sect1 id="authors">
+  <title>Authors</title>
+  <para>
+   <application>GDM Configure</application> was written by Lee Mallabone
+   (<email>lee@fonicmonkey.net</email>). To find more information about
+   <application>GDM Configure</application>, please visit the <ulink
+   url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+   page</ulink>.  Please send all comments, suggestions, and bug
+   reports to the <ulink url="http://bugzilla.gnome.org" type="http">GNOME
+   bug tracking database</ulink>.  (Instructions for submitting bug
+   reports can be found <ulink
+   url="http://bugzilla.gnome.org/Reporting.html" type="http">
+   on-line</ulink>.)  You can also use <application>Bug Report
+   Tool</application> (<command>bug-buddy</command>), available in the
+   <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
+   Menu</guimenu>, for submitting bug reports.
+  </para>
+
+  <para>
+   This manual was written by Trevor Curtis
+   (<email>trevor.curtis@home.com</email>). Please send all comments and
+   suggestions regarding this manual to the <ulink type="http"
+   url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+   Project</ulink> by sending an email to
+   <email>docs@gnome.org</email>. You can also add your comments
+   online by using the <ulink type="http"
+   url="http://developer.gnome.org/projects/gdp/doctable/">GNOME
+   Documentation Status Table</ulink>.
+  </para>
+
+  <!-- For translations: uncomment this:
+
+  <para>
+   Latin translation was done by ME
+   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
+   suggestions regarding this translation to SOMEWHERE.
+  </para>
+
+  -->
+
+ </sect1>
+
+
+ <!-- ============= Application License ============================= -->
+
+ <sect1 id="license">
+  <title>License</title>
+  <para>
+   This program is free software; you can redistribute it and/or
+   modify it under the terms of the  <ulink type="help" url="gnome-help:gpl">
+    <citetitle>GNU General Public License</citetitle></ulink> as
+   published by the Free Software Foundation; 
+   either version 2 of the License, or (at your option) any later
+   version.
+  </para>
+  <para>
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   <citetitle>GNU General Public License</citetitle> for more details.
+  </para>
+  <para>
+   A copy of the <citetitle>GNU General Public License</citetitle> is
+   included as an appendix to the <citetitle>GNOME Users
+   Guide</citetitle>.  You may also obtain a copy of the
+   <citetitle>GNU General Public License</citetitle> from the Free
+   Software Foundation by visiting <ulink type="http"
+   url="http://www.fsf.org">their Web site</ulink> or by writing to
+   <address>
+    Free Software Foundation, Inc.
+    <street>59 Temple Place</street> - Suite 330
+    <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
+    <country>USA</country>
+   </address>
+  </para>
+ </sect1>
+</article>
+
+
+
+
+
+
+
+
+
diff --git a/docs/gdmconfig/C/topic.dat b/docs/gdmconfig/C/topic.dat
new file mode 100644
index 00000000..67004b6f
--- /dev/null
+++ b/docs/gdmconfig/C/topic.dat
@@ -0,0 +1 @@
+index.html GDM Configurator users guide.
diff --git a/docs/gdmconfig/Makefile.am b/docs/gdmconfig/Makefile.am
new file mode 100644
index 00000000..42ffacc2
--- /dev/null
+++ b/docs/gdmconfig/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = C