source: gnome/core/gnome-screensaver.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 gnome-screensaver-download-http 
           "&gnome-download-http;/gnome-screensaver/3.4/gnome-screensaver-&gnome-screensaver-version;.tar.xz">
  <!ENTITY gnome-screensaver-download-ftp  
           "&gnome-download-ftp;/gnome-screensaver/3.4/gnome-screensaver-&gnome-screensaver-version;.tar.xz">
  <!ENTITY gnome-screensaver-md5sum        "d9349c92ea179e2948cb2ede9e751d5a">
  <!ENTITY gnome-screensaver-size          "553 KB">
  <!ENTITY gnome-screensaver-buildsize     "13 MB">
  <!ENTITY gnome-screensaver-time          "0.2 SBU">
]>

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

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

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

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

  <sect2 role="package">
    <title>Introduction to gnome-screensaver</title>

    <para>The <application>gnome-screensaver</application> package contains a
    screen saver and locker designed to have simple, sane, secure defaults
    and be well integrated with the desktop. It supports locking down of
    configuration settings, has translations into many languages and
    convenient user switching.</para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">gnome-screensaver Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="gnome-desktop"/> and
      <xref linkend="linux-pam"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libgnomekbd"/>,
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of gnome-screensaver</title>

    <para>Install <application>gnome-screensaver</application> by running the
    following commands:</para>

<screen><userinput>sed -i 's|etc/pam\.d"|etc"|' data/Makefile.in &amp;&amp;
./configure --prefix=/usr \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/gnome-screensaver \
            --with-pam-prefix=/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>

  </sect2>

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

    <para><command>sed -i 's|etc/pam\.d"|etc|' data/Makefile.in</command>:
    This command is used so that an erroneous message to copy the PAM
    configuration file is not displayed.</para>

<!--    <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/gnome-screensaver</parameter>:
    This parameter causes the libexec files to be installed in the preferred
    location of <filename
    class="directory">/usr/lib/gnome-screensaver</filename> instead of
    <filename class="directory">/usr/libexec</filename>.</para>

    <para><parameter>--with-pam-prefix=/etc</parameter>: This parameter is
    used so that the <application>Linux-PAM</application> configuration file
    for the <application>gnome-screensaver</application> application is
    installed in the correct location.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring gnome-screensaver</title>

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

      <para><filename>/etc/pam.d/gnome-screensaver</filename></para>

      <indexterm zone="gnome-screensaver gnome-screensaver-config">
        <primary sortas="e-etc-pam.d-gnome-screensaver">
        /etc/pam.d/gnome-screensaver</primary>
      </indexterm>

    </sect3>

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

      <sect4>
        <title>Linux-PAM Configuration</title>

        <para>The default <filename>gnome-screensaver</filename> configuration
        file does not work with a BLFS system. Replace the existing file with
        one that can be used on a BLFS system by issuing the following command
        as the <systemitem class='username'>root</systemitem> user:</para>

<screen role="root"><userinput>cat &gt; /etc/pam.d/gnome-screensaver &lt;&lt; "EOF"
<literal># Begin /etc/pam.d/gnome-screensaver

auth     include        system-auth
auth     optional       pam_gnome_keyring.so

account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/gnome-screensaver</literal>
EOF
chmod -v 644 /etc/pam.d/gnome-screensaver</userinput></screen>

      </sect4>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gnome-screensaver and gnome-screensaver-command
        </seg>
        <seg>
          /usr/lib/gnome-screensaver
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-screensaver-prog">
        <term><command>gnome-screensaver</command></term>
        <listitem>
          <para>is a screensaver and screen-locking program designed to
          work seamlessly with the GNOME desktop.</para>
          <indexterm zone="gnome-screensaver gnome-screensaver-prog">
            <primary sortas="b-gnome-screensaver">gnome-screensaver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-screensaver-command">
        <term><command>gnome-screensaver-command</command></term>
        <listitem>
          <para>is a tool for controlling an already
          running instance of gnome-screensaver.</para>
          <indexterm zone="gnome-screensaver gnome-screensaver-command">
            <primary sortas="b-gnome-screensaver-command">gnome-screensaver-command</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>