source: lxde/desktop/lxde-common.xml@ 8490099

<?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 lxde-common-download-http "&sourceforge-repo;/lxde/lxde-common-&lxde-common-version;.tar.xz">
  <!ENTITY lxde-common-download-ftp  " ">
  <!ENTITY lxde-common-md5sum        "14a9d19c4576dc15d985453ccb8ca9f6">
  <!ENTITY lxde-common-size          "869 KB">
  <!ENTITY lxde-common-buildsize     "2.7 MB">
  <!ENTITY lxde-common-time          "less than 0.1 SBU">
]>

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

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

  <title>lxde-common-&lxde-common-version;</title>

  <indexterm zone="lxde-common">
    <primary sortas="a-lxde-common">lxde-common</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to LXDE Common</title>

    <para>
      The <application>LXDE Common</application> package provides
      a set of default configuration for LXDE.
    </para>

    &lfs7a_checked;

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

    <bridgehead renderas="sect3">LXDE Common Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="lxde-icon-theme"/>,
      <xref linkend="lxpanel"/>,
      <xref linkend="lxsession"/>,
      <xref linkend="openbox"/> (runtime), and
      <xref linkend="pcmanfm"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="hicolor-icon-theme"/>, and
      <xref linkend="shared-mime-info"/>
    </para>

    <bridgehead renderas="sect4">Recommended Runtime Dependencies</bridgehead>
    <para role="recommended">
      <phrase revision="sysv"><xref linkend="consolekit"/> and</phrase>
      <xref linkend="dbus"/>
    </para>

    <bridgehead renderas="sect4">Optional Runtime Dependencies</bridgehead>
    <para role="optional">
      A notification daemon such as
      <xref linkend="notification-daemon"/> or
      <xref linkend="xfce4-notifyd"/>, and a display manager such as
      <xref linkend="lxdm"/> or
      <xref linkend="sddm"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of LXDE Common</title>

    <para>
      Install <application>LXDE Common</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &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>

    <para>
      If you have installed recommended dependencies, run the following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>update-mime-database /usr/share/mime &amp;&amp;
gtk-update-icon-cache -qf /usr/share/icons/hicolor &amp;&amp;
update-desktop-database -q</userinput></screen>

  </sect2>

  <sect2 role="using">
    <title>Starting LXDE</title>

    <para>
      You can start <application>LXDE</application> from runlevel 3, using
      <xref linkend="xinit"/>, or from runlevel 5, using a Display Manager,
      such as <xref linkend="lxdm"/>.
    </para>

    <para>
      To start <application>LXDE</application> using <xref linkend="xinit"/>,
      run the following commands:
    </para>

<screen><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal># No need to run dbus-launch, since it is run by startlxde
ck-launch-session startlxde</literal>
EOF

startx</userinput></screen>

    <para>
      The X session starts on the first unused virtual terminal, normally vt7.
      You can switch to another vt<emphasis>n</emphasis> simultaneously
      pressing the keys Ctrl-Alt-F<emphasis>n</emphasis>
      (<emphasis>n</emphasis>=1, 2, ...).  To switch back to the X session,
      normally started at vt7, use Ctrl-Alt-F7. The vt where the command
      <command>startx</command> was executed will display many messages,
      including X starting messages, applications automatically started with
      the session, and eventually, some warning and error messages. You may
      prefer to redirect those messages to a log file, which not only will keep
      the initial vt uncluttered, but can also be used for debug purposes. This
      can be done starting X with:
    </para>

    <screen><userinput>startx &amp;&gt; ~/.x-session-errors</userinput></screen>

    <note>
      <para>
        You may wish to drop consolekit, just using
        startlxde in ~/.xinitrc. However some capabilities such as mounting or
        umounting file systems from a file manager will not be available, or
        the reboot option will be absent or inoperative, among other problems.
      </para>
    </note>

    <para>
      When shutting down or rebooting, the shutdown messages appear on the vt
      where X was running. If you wish to see those messages, simultaneously
      press keys Alt-F7 (assuming that X was running on vt7).
    </para>

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

    <para>
      <command>ln -svfn profile/LXDE ...</command>: Fixes the wrong path of the
      default <application>LXPanel</application> profile.
    </para>

  </sect2>-->

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

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

      <seglistitem>
        <seg>
          lxde-logout, openbox-lxde and startlxde
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/xdg/{lxpanel,lxsession,openbox,pcmanfm}/LXDE and
          /usr/share/lxde
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxde-logout">
        <term><command>lxde-logout</command></term>
        <listitem>
          <para>
            is used to quit the desktop session for
            <application>LXDE</application>.
          </para>
          <indexterm zone="lxde-common lxde-logout">
            <primary sortas="b-lxde-logout">lxde-logout</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="openbox-lxde">
        <term><command>openbox-lxde</command></term>
        <listitem>
          <para>
            is a wrapper script which runs <application>Openbox</application>
            with <application>LXDE</application> specific config file.
          </para>
          <indexterm zone="lxde-common openbox-lxde">
            <primary sortas="b-openbox-lxde">openbox-lxde</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="startlxde">
        <term><command>startlxde</command></term>
        <listitem>
          <para>
            is used to start the desktop session for
            <application>LXDE</application>.
          </para>
          <indexterm zone="lxde-common startlxde">
            <primary sortas="b-startlxde">startlxde</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>