source: general/genutils/xscreensaver.xml@ dc2f5ad

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

  <!ENTITY xscreensaver-download-http "http://www.jwz.org/xscreensaver/xscreensaver-&xscreensaver-version;.tar.gz">
  <!ENTITY xscreensaver-download-ftp "ftp://ftp.fu-berlin.de/unix/X11/graphics/xscreensaver/xscreensaver-&xscreensaver-version;.tar.gz">
  <!ENTITY xscreensaver-md5sum        " ">
  <!ENTITY xscreensaver-size          "4.2 MB">
  <!ENTITY xscreensaver-buildsize     "90 MB">
  <!ENTITY xscreensaver-time          "0.97 SBU">
]>

<sect1 id="xscreensaver" xreflabel="XScreenSaver-&xscreensaver-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="xscreensaver.html"?>
<title>XScreenSaver-&xscreensaver-version;</title>

<sect2>
<title>Introduction to <application>XScreenSaver</application></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>


<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application>XScreenSaver</application> dependencies</title>
<sect4><title>Required</title>
<para>
<xref linkend="bc"/> and
<xref linkend="libglade"/> (alternatively
<xref linkend="lesstif"/> but not recommended)
</para>
</sect4>

<sect4><title>Optional</title>
<para>
<xref linkend="libjpeg"/>,
<ulink url="http://linas.org/gle/">GLE</ulink>,
<ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink>,
<ulink url="http://www.ibiblio.org/pub/Linux/games/amusements/fortune/fortune-mod-9708.tar.gz">fortune-mod</ulink>,
<ulink url="http://www.jwz.org/xdaliclock/">XDaliClock</ulink>,
<xref linkend="yelp"/>,
<xref linkend="Linux_PAM"/> and
<ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink> or
<xref linkend="heimdal"/> or
<xref linkend="mitkrb"/>
</para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>XScreenSaver</application></title>

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

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

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

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><option>--with-setuid-hacks</option>:
This switch allows some demos to be installed setuid root which is
needed in order to ping other hosts.    
</para>

<para><option>--with-configdir=/usr/lib/xscreensaver/config</option>:
If GNOME 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>
<title>Configuring <application>XScreenSaver</application></title>

<sect3><title>Config files</title>
<para><filename>~/.xscreensaver</filename></para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>XScreenSaver</application> package contains 
<command>xscreensaver</command>,
<command>xscreensaver-command</command>,
<command>xscreensaver-demo</command>,
<command>xscreensaver-getimage</command>,
<command>xscreensaver-getimage-file</command>,
<command>xscreensaver-getimage-video</command>,
<command>xscreensaver-gl-helper</command> and
<command>screensaver-properties-capplet</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>xscreensaver</title>
<para><command>xscreensaver</command> is a screen saver and
locker daemon.</para></sect3>

<sect3><title>xscreensaver-command</title>
<para><command>xscreensaver-command</command> program controls a running
<command>xscreensaver</command> process by sending it client
messages.</para></sect3>

<sect3><title>xscreensaver-demo</title>
<para><command>xscreensaver-demo</command> is a graphical
front-end for setting the parameters used by the background
<command>xscreensaver</command> daemon.</para></sect3>

<sect3><title>xscreensaver-getimage, xscreensaver-getimage-file,
xscreensaver-getimage-video</title>
<para>These are helper programs for the <command>xscreensaver</command>
hacks that manipulate images.</para></sect3>

<sect3><title>xscreensaver-gl-helper</title>
<para><command>xscreensaver-gl-helper</command> is a helper program for
the <command>xscreensaver</command> OpenGL hacks.</para></sect3>

</sect2>

</sect1>