source: gnome/platform/nautilus.xml@ 206a253d

<?xml version="1.0" encoding="UTF-8"?>
<!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 nautilus-download-http
           "&gnome-download-http;/nautilus/&gnome-47;/nautilus-&nautilus-version;.tar.xz">
  <!ENTITY nautilus-download-ftp  " ">
  <!ENTITY nautilus-md5sum        "76d2af66902a174dae0a5c69a9b35c70">
  <!ENTITY nautilus-size          "3.1 MB">
  <!ENTITY nautilus-buildsize     "93 MB (with tests)">
  <!ENTITY nautilus-time          "0.6 SBU (with tests, both using parallelism=4)">
]>

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


  <title>Nautilus-&nautilus-version;</title>

  <indexterm zone="nautilus">
    <primary sortas="a-Nautilus">Nautilus</primary>
  </indexterm>

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

    <para>
      The <application>Nautilus</application> package contains the
      <application>GNOME</application> file manager.
    </para>

    &lfs122_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="bubblewrap"/>,
      <xref linkend="gexiv2"/>,
      <xref linkend="gnome-autoar"/>,
      <xref linkend="gnome-desktop"/>,
      <xref linkend="libadwaita1"/>,
      <xref linkend="libnotify"/>,
      <xref linkend="libportal"/>,
      <xref linkend="libseccomp"/>, and
      <xref linkend="tinysparql"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="exempi"/>,
      &gobject-introspection;,
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="libcloudproviders"/>, and
      <xref linkend="libexif"/>
    </para>

    <bridgehead renderas="sect4">Optional (for generating documentation)</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/>
    </para>

    <bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
    <para role="recommended">
      <xref role="runtime" linkend="adwaita-icon-theme"/> and
      <xref role="runtime" linkend="gvfs"/> (For hotplugging and device
        mounting to work)
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr       \
            --buildtype=release \
            ..                  &amp;&amp;

ninja</userinput></screen>

    <para>
      If you wish to generate and install the API documentation, issue the
      following commands:
    </para>

<screen><userinput remap="doc">sed "/docdir =/s@\$@ / 'nautilus-&nautilus-version;'@" -i ../meson.build &amp;&amp;
meson configure -D docs=true</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. The tests
      need to be run in a graphical environment.  One test is known to fail
      if <xref linkend="localsearch"/> is not installed. One test is also
      known to timeout if the user running the tests has a large home directory.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
                href="../../xincludes/gsettings-destdir.xml"/>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <option>-D cloudproviders=false</option>: Use this switch if you do not
      have <xref linkend="libcloudproviders"/> installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          nautilus and nautilus-autorun-software
        </seg>
        <seg>
          libnautilus-extension.so
        </seg>
        <seg>
          /usr/{include,lib,share}/nautilus and
          /usr/share/doc/nautilus-&nautilus-version; (optional)
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="nautilus-prog">
        <term><command>nautilus</command></term>
        <listitem>
          <para>
            is the <application>GNOME</application> file manager
          </para>
          <indexterm zone="nautilus nautilus-prog">
            <primary sortas="b-nautilus">nautilus</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnautilus-extension">
        <term><filename class="libraryfile">libnautilus-extension.so</filename></term>
        <listitem>
          <para>
            supplies the functions needed by the file manager extensions
          </para>
          <indexterm zone="nautilus libnautilus-extension">
            <primary sortas="c-libnautilus-extension">libnautilus-extension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>