source: archive/gnome/sushi.xml@ 48b59802

<?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 sushi-download-http "&gnome-download-http;/sushi/0.4/sushi-&sushi-version;.tar.xz">
  <!ENTITY sushi-download-ftp  "&gnome-download-ftp;/sushi/0.4/sushi-&sushi-version;.tar.xz">
  <!ENTITY sushi-md5sum        "b5021f3120f6452c41ee1d1d660e46f9">
  <!ENTITY sushi-size          "292 KB">
  <!ENTITY sushi-buildsize     "5.5 MB">
  <!ENTITY sushi-time          "0.3 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Sushi-&sushi-version;</title>

  <indexterm zone="sushi">
    <primary sortas="a-Sushi">Sushi</primary>
  </indexterm>

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

    <para>
      The <application>Sushi</application> package contains a quick file previewer
      for <application>Nautilus</application>.
    </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter-gtk"/>,
      <xref linkend="clutter-gst"/>,
      <xref linkend="evince"/>,
      <xref linkend="gjs"/>,
      <xref linkend="gtksourceview"/> and
      <xref linkend="libmusicbrainz3"/>
    </para>

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

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

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

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

    <para>
      To test the results, issue: <command>make check</command>.
    </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>
      <parameter>--libexecdir=/usr/lib/sushi</parameter>: This parameter
      ensures <filename>sushi-start</filename> is installed in a FHS-compliant
      location.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          sushi
        </seg>
        <seg>
          libsushi-1.0.so
        </seg>
        <seg>
          /usr/lib/sushi and
          /usr/share/sushi
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sushi-prog">
        <term><command>sushi</command></term>
        <listitem>
          <para>
            is a graphical file viewer.
          </para>
          <indexterm zone="sushi sushi-prog">
            <primary sortas="b-sushi-prog">sushi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsushi-1">
        <term><filename class='libraryfile'>libsushi-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>Sushi</application> API functions.
          </para>
          <indexterm zone="sushi libsushi-1">
            <primary sortas="c-libsushi-1">libsushi-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>