source: general/genutils/xscreensaver.xml@ 0aeb696

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

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY xscreensaver-download-http "http://www.jwz.org/xscreensaver/xscreensaver-&xscreensaver-version;.tar.gz">
  <!ENTITY xscreensaver-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/xscreensaver-&xscreensaver-version;.tar.gz">
  <!ENTITY xscreensaver-md5sum        "27491d117a8f7ae57d1fdf5f15d61ac6">
  <!ENTITY xscreensaver-size          "4.9 MB">
  <!ENTITY xscreensaver-buildsize     "112.7 MB">
  <!ENTITY xscreensaver-time          "1.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">xscreensaver-&xscreensaver-version;.tar</keyword>
      <keyword role="ftpdir">xscreensaver</keyword>
    </keywordset>
  </sect1info>

  <title>XScreenSaver-&xscreensaver-version;</title>

  <indexterm zone="xscreensaver">
    <primary sortas="a-xscreensaver">Xscreensaver</primary>
  </indexterm>

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

    <para>The <application>XScreenSaver</application> is a modular screen
    saver and locker for the X Window System. It is highly customizable and
    allows the use of any program that can draw on the root window as a
    display mode. The purpose of <application>XScreenSaver</application> is
    to display pretty pictures on your screen when it is not in use, in
    keeping with the philosophy that unattended monitors should always be
    doing something interesting, just like they do in the movies. However,
    <application>XScreenSaver</application> can also be used as a screen
    locker, to prevent others from using your terminal while you are
    away.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="bc"/> and
    <xref linkend="libglade"/> (alternatively
    <xref linkend="lesstif"/> but not recommended)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"> <xref linkend="libjpeg"/>,
    <ulink url="http://linas.org/gle/">GLE</ulink>,
    <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink>,
    <ulink url="http://www.jwz.org/xdaliclock/">XDaliClock</ulink>,
    <xref linkend="linux-pam"/>,
    <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>, and
    <xref linkend="heimdal"/> or
    <xref linkend="mitkrb"/></para>

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

  </sect2>

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

    <!-- Apparently, this issue is now fixed
    <para><application>XScreenSaver</application> makes some poor choices
    where to put all the files if <application>GNOME</application> is installed.
    To get around this, run the following command and see an optional configure
    switch described later below.</para>

<screen><userinput>sed -i -e "s,@GNOME_DATADIR@,$GNOME_PREFIX/share," driver/Makefile.in</userinput></screen>
    -->

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

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

    <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><option>--with-setuid-hacks</option>: This switch allows some
    demos to be installed setuid <systemitem class="username">root</systemitem>
    which is needed in order to ping other hosts.</para>

    <para><option>--enable-locking</option>: This switch provides support for
    locking the display.</para>

    <!-- Not required any longer
    <para><option>-with-configdir=/usr/lib/xscreensaver/config</option>:
    If <application>GNOME</application> is installed, you can use this
    switch to put the configuration files in a single directory rather than
    spreading them all over the disk.</para>
    -->

  </sect2>

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

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

      <para><filename>/etc/X11/app-defaults/XScreenSaver</filename>,
      <filename>~/.xscreensaver</filename> and
      <filename>/etc/pam.d/xscreensaver</filename> or
      <filename>/etc/pam.conf</filename></para>

      <indexterm zone="xscreensaver xscreensaver-config">
        <primary sortas="e-etc-X11-app-defaults-XScreenSaver">.../app-.../XScreenSaver</primary>
      </indexterm>
      <indexterm zone="xscreensaver xscreensaver-config">
        <primary sortas="e-AA.xscreensaver">~/.xscreensaver</primary>
      </indexterm>
      <indexterm zone="xscreensaver xscreensaver-config">
        <primary sortas="e-etc-pam.d-xscreensaver">/etc/pam.d/xscreensaver</primary>
      </indexterm>
      <indexterm zone="xscreensaver xscreensaver-config">
        <primary sortas="e-etc-pam.conf">/etc/pam.conf</primary>
      </indexterm>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>xscreensaver, xscreensaver-command, xscreensaver-demo, xscreensaver-getimage,
        xscreensaver-getimage-file, xscreensaver-getimage-video, xscreensaver-gl-helper,
        and xscreensaver-text</seg>
        <seg>None</seg>
        <seg>/usr/lib/xscreensaver and /usr/share/xscreensaver</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xscreensaver-prog">
        <term><command>xscreensaver</command></term>
        <listitem>
          <para>is a screen saver and locker daemon.</para>
          <indexterm zone="xscreensaver xscreensaver-prog">
            <primary sortas="b-xscreensaver">xscreensaver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-command">
        <term><command>xscreensaver-command</command></term>
        <listitem>
          <para>controls a running <command>xscreensaver</command>
          process by sending it client messages.</para>
          <indexterm zone="xscreensaver xscreensaver-command">
            <primary sortas="b-xscreensaver-command">xscreensaver-command</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-demo">
        <term><command>xscreensaver-demo</command></term>
        <listitem>
          <para>is a graphical front-end for setting the parameters used
          by the background <command>xscreensaver</command> daemon.</para>
          <indexterm zone="xscreensaver xscreensaver-demo">
            <primary sortas="b-xscreensaver-demo">xscreensaver-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-getimage">
        <term><command>xscreensaver-getimage</command></term>
        <listitem>
          <para>is a helper program for the <command>xscreensaver</command>
          modules that manipulate images.</para>
          <indexterm zone="xscreensaver xscreensaver-getimage">
            <primary sortas="b-xscreensaver-getimaage">xscreensaver-getimage</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-getimage-file">
        <term><command>xscreensaver-getimage-file</command></term>
        <listitem>
          <para>is a helper program for the <command>xscreensaver</command>
          modules that manipulate images.</para>
          <indexterm zone="xscreensaver xscreensaver-getimage-file">
            <primary sortas="b-xscreensaver-getimaage-file">xscreensaver-getimage-file</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-getimage-video">
        <term><command>xscreensaver-getimage-video</command></term>
        <listitem>
          <para>is a helper program for the <command>xscreensaver</command>
          modules that manipulate images.</para>
          <indexterm zone="xscreensaver xscreensaver-getimage-video">
            <primary sortas="b-xscreensaver-getimaage-video">xscreensaver-getimage-video</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-gl-helper">
        <term><command>xscreensaver-gl-helper</command></term>
        <listitem>
          <para>is a helper program for the <command>xscreensaver</command>
          OpenGL modules.</para>
          <indexterm zone="xscreensaver xscreensaver-gl-helper">
            <primary sortas="b-xscreensaver-gl-helper">xscreensaver-gl-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xscreensaver-text">
        <term><command>xscreensaver-text</command></term>
        <listitem>
          <para>prints some text to stdout, for use by screen savers.</para>
          <indexterm zone="xscreensaver xscreensaver-text">
            <primary sortas="b-xscreensaver-text">xscreensaver-text</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>