source: x/wm/sawfish.xml@ de53c9be

<?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;

    <!-- 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 sawfish-download-http "&sourceforge-repo;/sawmill/sawfish-&sawfish-version;.tar.gz">
  <!ENTITY sawfish-download-ftp  " ">
  <!ENTITY sawfish-md5sum        "9e5ce5e76c60acecdb1889c1f173295a">
  <!ENTITY sawfish-size          "1.5 MB">
  <!ENTITY sawfish-buildsize     "17.5 MB">
  <!ENTITY sawfish-time          "0.26 SBU">
]>

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

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

  <title>sawfish-&sawfish-version;</title>

  <indexterm zone="sawfish">
    <primary sortas="a-Sawfish">Sawfish</primary>
  </indexterm>

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

    <para>The <application>sawfish</application> package contains a window
    manager. This is useful for organizing and displaying windows where all
    window decorations are configurable and all user-interface policy is
    controlled through the extension language.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="rep-gtk"/> and
    <xref linkend="esound"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --libexec=/usr/sbin \
    --infodir=/usr/share/info --disable-themer &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><parameter>--disable-themer</parameter>: This
    option prevents building the <application>sawfish</application> themer.
    This program was not migrated to <application>GTK-2</application>.</para>

    <para><option>--with-audiofile</option>: This command directs
    <application>sawfish</application> to use
    <filename class="libraryfile">libaudiofile</filename>
    for sound manipulation.</para>

    <para><option>--with-esd</option>: This command directs
    <application>sawfish</application> to use the Enlightened Sound
    Daemon.</para>

  </sect2>

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

    <sect3 id="sawfish-config">
      <title>Configuration Information</title>

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

      <para>Be sure to backup your current <filename>.xinitrc</filename>
      before proceeding.</para>

<screen><userinput>cat &gt;&gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>exec sawfish</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>sawfish, sawfish-client, and sawfish-ui</seg>
        <seg>None</seg>
        <seg>/usr/share/sawfish, /usr/sbin/sawfish, and /usr/lib/rep/*/</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sawfish-prog">
        <term><filename>sawfish</filename></term>
        <listitem>
          <para>is the extensible window manager using a
          <application>Lisp</application>-based scripting language.</para>
          <indexterm zone="sawfish sawfish-prog">
            <primary sortas="b-sawfish">sawfish</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sawfish-client">
        <term><filename>sawfish-client</filename></term>
        <listitem>
          <para>allows you to connect to a window manager process and
          evaluate arbitrary <application>Lisp</application> forms.</para>
          <indexterm zone="sawfish sawfish-client">
            <primary sortas="b-sawfish-client">sawfish-client</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sawfish-ui">
        <term><filename>sawfish-ui</filename></term>
        <listitem>
          <para>is the <application>sawfish</application> configurator.</para>
          <indexterm zone="sawfish sawfish-ui">
            <primary sortas="b-sawfish-ui">sawfish-ui</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>