source: gnome/core/gdm.xml@ 4c2be438

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gdm-download-http "&gnome-download-http;/gdm/3.4/gdm-&gdm-version;.tar.xz">
  <!ENTITY gdm-download-ftp  "&gnome-download-ftp;/gdm/3.4/gdm-&gdm-version;.tar.xz">
  <!ENTITY gdm-md5sum        "fda0470340f9c0bc2f8daccb280af520">
  <!ENTITY gdm-size          "1.6 MB">
  <!ENTITY gdm-buildsize     "50 MB">
  <!ENTITY gdm-time          "0.8 SBU">
]>

<sect1 id="gdm" xreflabel="GDM-&gdm-version;">
  <?dbhtml filename="gdm.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>GDM-&gdm-version;</title>

  <indexterm zone="gdm">
    <primary sortas="a-GDM">GDM</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GDM</title>

    <para>The <application>GDM</application> package contains
    <application>GNOME</application>'s Display Manager daemon. This is
    useful for allowing configurable graphical logins.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&gdm-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gdm-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gdm-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gdm-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gdm-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gdm-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/gdm-&gdm-version;-vt-allocation-hack-1.patch"/></para>
      </listitem>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/gdm-&gdm-version;-blfs-patch-1.patch"/></para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GDM Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="accountsservice"/>,
      <xref linkend="dconf"/>,
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="linux-pam"/> and
      <xref linkend="nss"/>
    </para>

    <bridgehead renderas="sect4">Required (runtime)</bridgehead>
    <para role="required">
      <xref linkend="gnome-session"/> and either
      <xref linkend="gnome-shell"/> or
      <xref linkend="gnome-panel"/> and
      <xref linkend="metacity"/> (for the Greeter Window Manager).
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="consolekit"/>
      (Required for Shutdown/Restart functionality),
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libxklavier"/>,
      <xref linkend="rarian"/> and
      <xref linkend="upower"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="check"/> (required to run the testsuite) and
      <xref linkend="tcpwrappers"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/gdm"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GDM</title>

    <para>It is recommended to have a dedicated user and group to take
    control of the <command>gdm</command> daemon after it is
    started. Issue the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>groupadd -fg 21 gdm &amp;&amp;
useradd -c "GDM Daemon Owner" -d /var/lib/gdm -u 21 \
        -g gdm -s /bin/false gdm</userinput></screen>

    <para>Install <application>GDM</application> by running
    the following commands as an unprivileged user:</para>

<screen><userinput>patch -Np1 -i ../gdm-&gdm-version;-vt-allocation-hack-1.patch &amp;&amp;
patch -Np1 -i ../gdm-&gdm-version;-blfs-patch-1.patch &amp;&amp;
./configure --prefix=/usr \
            --sysconfdir=/etc \
            --localstatedir=/var \
            --libexecdir=/usr/lib/gdm \
            --with-at-spi-registryd-directory=/usr/lib/at-spi2-core \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>If you have installed <xref linkend="check"/> and you wish to run
    the testsuite, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install &amp;&amp;
chown -R -v gdm:gdm /var/lib/gdm /var/cache/gdm /var/log/gdm
</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

<!--    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/> -->

    <para><parameter>--libexecdir=/usr/lib/gdm</parameter>: This
    parameter is used so that the <application>GDM</application> internal
    support programs are installed in the preferred location of <filename
    class='directory'>/usr/lib/gdm</filename> instead of <filename
    class='directory'>/usr/libexec</filename>.</para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/without-scrollkeeper.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring GDM</title>

    <sect3 id="gdm-config">
      <title>Config Files</title>

      <para><filename>/etc/gdm/custom.conf</filename></para>

      <indexterm zone="gdm gdm-config">
        <primary sortas="e-etc-gdm-custom.conf">
        /etc/gdm/custom.conf</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>The GDM daemon is configured using the
      <filename>/etc/gdm/custom.conf</filename> file.
      Default values are stored in GConf in the
      <filename>gdm.schemas</filename> file. It is recommended that end-users
      modify the <filename>/etc/gdm/custom.conf</filename> file
      because the schemas file may be overwritten when the user updates their
      system to have a newer version of GDM.</para>

      <important>
        <para>If the system-wide <application>D-BUS</application> daemon was
        running during the installation of <application>gdm</application>,
        ensure you stop and restart the <application>D-BUS</application>
        daemon before attempting to start <command>gdm</command>.</para>
      </important>

      <para><command>gdm</command> can be tested by executing it as the
      <systemitem class="username">root</systemitem> user. If you wish to stop
      it you will need to go to a different tty and then kill it.</para>

    </sect3>

    <sect3 id="gdm-init">
      <title>Boot Script</title>

      <para>To start a graphical login when the system is booted, install the
      <filename>/etc/rc.d/init.d/gdm</filename> init script included in the
      <xref linkend="bootscripts"/> package.<!-- If your
      <envar>GNOME_PREFIX</envar> environment variable is anything other than
      <filename class='directory'>/usr</filename> or <filename
      class='directory'>/opt/gnome-&gnome-version;&gnome-minor-version;</filename>,
      you will need to modify the <envar>PATH</envar> statement in the script
      to include the path where you have <application>GNOME</application>
      installed.--></para>

      <indexterm zone="gdm gdm-init">
        <primary sortas="f-gdm">gdm</primary>
      </indexterm>

<screen role="root"><userinput>make install-gdm</userinput></screen>

      <para>Now edit <filename>/etc/inittab</filename> with the following
      commands.</para>

<screen role="root"><userinput>sed -i 's/id:3:initdefault:/id:5:initdefault:/' \
    /etc/inittab</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gdm, gdmflexiserver and gdm-screenshot
        </seg>
        <seg>
          libgdmgreeter.so and libgdmsimplegreeter.so
        </seg>
        <seg>
          /etc/dconf/db/gdm.d, /etc/gdm, /usr/include/gdm,
          /usr/lib/gdm, /usr/share/gdm, /usr/share/gnome/help/gdm,
          /usr/share/omf/gdm and /var/{cache,lib,log,run}/gdm
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gdm-prog">
        <term><command>gdm</command></term>
        <listitem>
          <para>is the <application>GNOME</application> based login prompt.</para>
          <indexterm zone="gdm gdm-prog">
            <primary sortas="b-gdm">gdm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdmflexiserver">
        <term><command>gdmflexiserver</command></term>
        <listitem>
          <para>is the flexi server mechanism which allows to run GDM sessions
          on demand, in a new virtual console.</para>
          <indexterm zone="gdm gdmflexiserver">
            <primary sortas="b-gdmflexiserver">gdmflexiserver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdm-screenshot">
        <term><command>gdm-screenshot</command></term>
        <listitem>
          <para>is a screenshot tool.</para>
          <indexterm zone="gdm gdm-screenshot">
            <primary sortas="b-gdm-screenshot">gdm-screenshot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>