source: gnome/core/gnome-session.xml@ f5084dd

<?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 gnome-session-download-http 
           "&gnome-download-http;/gnome-session/3.4/gnome-session-&gnome-session-version;.tar.xz">
  <!ENTITY gnome-session-download-ftp  
           "&gnome-download-ftp;/gnome-session/3.4/gnome-session-&gnome-session-version;.tar.xz">
  <!ENTITY gnome-session-md5sum        "7254bcc8e1e493cbf2a27e4f3cbe966b">
  <!ENTITY gnome-session-size          "712 KB">
  <!ENTITY gnome-session-buildsize     "18 MB">
  <!ENTITY gnome-session-time          "0.3 SBU">
]>

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

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

  <title>gnome-session-&gnome-session-version;</title>

  <indexterm zone="gnome-session">
    <primary sortas="a-gnome-session">gnome-session</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Session</title>

    <para>
      The <application>GNOME Session</application> package contains
      the <application>GNOME</application> session manager.
    </para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">GNOME Session Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="GConf"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="json-glib"/>,
      <xref linkend="startup-notification"/> and
      <xref linkend="upower"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="xmlto"/>
    </para>

    <bridgehead renderas="sect4">Runtime Dependencies</bridgehead>
    <para role="required">
      <xref linkend="consolekit"/> (if you intend to use startx to initiate 
      your <application>GNOME</application> desktop) and
      <xref linkend="polkit-gnome"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of GNOME Session</title>

    <para>
      Install <application>GNOME Session</application> by
      running the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/gnome-session &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

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

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

  </sect2>

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

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

    <para>
      <option>--enable-docbook-docs</option>: This parameter is used to
      build the documentation.
    </para>

  </sect2>

  <sect2 role="configuration" id="gnome-session-config">
    <title>Configuring GNOME Session</title>

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

      <para>
        If you are not using <application>gdm</application> to start your
        <application>GNOME</application> desktop, you will need to invoke
        <command>gnome-session</command> <emphasis>instead of</emphasis> invoking
        a window-manager directly.  All of the packages in the 'Desktop' section of
        this chapter need to be installed first, and some of the 'Applications' - 
        particularly <application>GNOME Terminal</application>
        (<application>xterm</application> does not  install a '.desktop' file and
        so not appear in the menus).
      </para>

      <para>
        When <command>gnome-session</command> is run, it invokes the necessary
        daemons and either <application>Metacity</application> or
        <application>gnome-shell</application>. A desktop manager such as
        <application>gdm</application> will invoke <application>ConsoleKit</application>
        before the window manager, but if you use <command>startx</command> the first
        invocation after booting may fail because the daemon is not already running,
        so we will invoke it first.
      </para>

      <para>
        To automatically start the <application>gnome-session</application>
        window manager when you issue the <command>startx</command> command,
        backup your current <filename>~/.xinitrc</filename> before proceeding.
        Note that you will be able to invoke <application>GNOME Terminal</application>
        from the menu, so there is no reason to invoke xterm here. Create a new
        <filename>.xinitrc</filename> using this command:
      </para>

      <indexterm zone="metacity gnome-session-config">
        <primary sortas="e-AA.xinitrc">~/.xinitrc</primary>
      </indexterm>

<screen><userinput>cat &gt;&gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>exec ck-launch-session dbus-launch --exit-with-session gnome-session</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          gnome-session, gnome-session-properties and gnome-session-quit
        </seg>
        <seg>
          /usr/lib/gnome-session,
          /usr/share/doc/gnome-session and
          /usr/share/gnome-session
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-session-prog">
        <term><command>gnome-session</command></term>
        <listitem>
          <para>
            is used to start up the <application>GNOME</application>
            Desktop environment.
          </para>
          <indexterm zone="gnome-session gnome-session-prog">
            <primary sortas="b-gnome-session">gnome-session</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-session-properties">
        <term><command>gnome-session-properties</command></term>
        <listitem>
          <para>
            allows the users to configure which applications should be
            started at login.
          </para>
          <indexterm zone="gnome-session gnome-session-properties">
            <primary sortas="b-gnome-session-properties">gnome-session-properties</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-session-quit">
        <term><command>gnome-session-quit</command></term>
        <listitem>
          <para>
            is used to end the <application>GNOME</application> Session.
          </para>
          <indexterm zone="gnome-session gnome-session-quit">
            <primary sortas="b-gnome-session-quit">gnome-session-quit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>