source: postlfs/editors/gedit.xml@ 73089ed3

<?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 gedit-download-http "&gnome-download-http;/gedit/46/gedit-&gedit-version;.tar.xz">
  <!ENTITY gedit-download-ftp  " ">
  <!ENTITY gedit-md5sum        "01327f0d35778d8f3a914fffb69e8cd6">
  <!ENTITY gedit-size          "2.6 MB">
  <!ENTITY gedit-buildsize     "66 MB (with tests)">
  <!ENTITY gedit-time          "0.2 SBU (using parallelism=4; with tests)">
]>

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


  <title>Gedit-&gedit-version;</title>

  <indexterm zone="gedit">
    <primary sortas="a-Gedit">Gedit</primary>
  </indexterm>

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

    <para>
      The <application>Gedit</application> package contains a lightweight
      UTF-8 text editor for the <application>GNOME</application> Desktop.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <!--<xref linkend="git"/>, unneeded -->
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="itstool"/>,
      <xref linkend="libpeas"/>,
      <xref linkend="libgedit"/>, and
      <xref linkend="tepl"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gspell"/>,
      <xref role="runtime" linkend="gvfs"/> (runtime),
      <xref linkend="iso-codes"/>, and
      <xref linkend="pygobject3"/>
      (<application>Python</application> 3 module)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="vala"/>, and
      <ulink url="https://launchpad.net/zeitgeist">zeitgeist</ulink>
    </para>

  </sect2>

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

<!-- Not needed in 46.2
    <para>
      First change the <filename>meson.build</filename> script so that
      it can accept a <option>release</option> build.
    </para>

<screen><userinput>sed -i s/plain/release/ meson.build</userinput></screen>
-->

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

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

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </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>
      <parameter>-Dgtk_doc=false</parameter>: This switch disables
      generating the API documentation. Omit this switch if you have
      <xref linkend="gtk-doc"/> installed and wish to generate the API
      documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gedit
        </seg>
        <seg>
          libgedit-46.so
        </seg>
        <seg>
          /usr/include/gedit-46 and
          /usr/{lib,share,share/help/*}/gedit
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gedit-prog">
        <term><command>gedit</command></term>
        <listitem>
          <para>
            is a lightweight text editor integrated with the
            <application>GNOME</application> Desktop
          </para>
          <indexterm zone="gedit gedit-prog">
            <primary sortas="b-gedit">gedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>