source: gnome/core/sushi.xml@ 503a0c83

<?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.2/sushi-&sushi-version;.tar.xz">
  <!ENTITY sushi-download-ftp  "&gnome-download-ftp;/sushi/0.2/sushi-&sushi-version;.tar.xz">
  <!ENTITY sushi-md5sum        "36f79d8dbd46327d6aefc629a4b61723">
  <!ENTITY sushi-size          "290 KB">
  <!ENTITY sushi-buildsize     "?? MB">
  <!ENTITY sushi-time          "?? SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <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 filepreviewer
    for <application>Nautilus</application>.</para>

    &lfs68_built;

    <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"/>,
    <xref linkend="clutter-gtk"/>,
    <xref linkend="clutter-gst"/>,
    <xref linkend="evince"/>,
    <xref linkend="gjs"/>,
    <xref linkend="gobject-introspection"/>,
    <xref linkend="gst-plugins-base"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="gtksourceview"/>,
    <xref linkend="intltool"/>,
    <xref linkend="libmusicbrainz3"/>, and
    <xref linkend="webkitgtk"/>
    <!-- libdiscid removed from this list, not mentioned in configure -->
    </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=$GNOME_PREFIX \
            --sysconfdir=$GNOME_SYSCONFDIR \
            --libexecdir=$GNOME_PREFIX/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>--sysconfdir=$GNOME_SYSCONFDIR</parameter>: This parameter does
    something mandatory for BLFS purposes.</para>

    <para><parameter>--libexecdir=$GNOME_PREFIX/lib/sushi</parameter>: This parameter does
    something mandatory for BLFS purposes.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>sushi and sushi-start</seg>
        <seg>libsushi-1.0.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{lib/sushi,share/sushi/{js/{ui,util,viewers},style}}</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>does this .....</para>
          <indexterm zone="sushi sushi-prog">
            <primary sortas="b-sushi-prog">sushi-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sushi-start">
        <term><command>sushi-start</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="sushi sushi-start">
            <primary sortas="b-sushi-start">sushi-start</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>