source: gnome/add/gedit.xml@ 07078cc

<?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 gedit-download-http "&gnome-download-http;/gedit/&gnome-version;/gedit-&gedit-version;.tar.xz">
  <!ENTITY gedit-download-ftp  "&gnome-download-ftp;/gedit/&gnome-version;/gedit-&gedit-version;.tar.xz">
  <!ENTITY gedit-md5sum        "f7d27116971e2d7336231353de7dd2e9">
  <!ENTITY gedit-size          "2.8 MB">
  <!ENTITY gedit-buildsize     "95 MB">
  <!ENTITY gedit-time          "1.8 SBU">
]>

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

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

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

    &lfs70_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="gnome-doc-utils"/>,
    <xref linkend="gsettings-desktop-schemas"/>,
    <xref linkend="gtk-doc"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="gtksourceview"/>,
    <xref linkend="libpeas"/>, and
    <xref linkend="which"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="enchant"/> and
    <xref linkend="iso-codes"/> (to Provide Spell-Checking Capability),
    <xref linkend="rarian"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="attr"/>,
    <xref linkend="libsoup"/>,
    <xref linkend="pygobject3"/>, and
    <ulink url="http://launchpad.net/libzeitgeist">libzeitgeist</ulink></para>

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

  </sect2>

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

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

<!-- /usr/lib/gedit is created for plugins, reuse for libexec's gedit-bugreport.sh -->
<screen><userinput>./configure --prefix=$GNOME_PREFIX \
            --libexecdir=$GNOME_PREFIX/lib/gedit &amp;&amp;
make</userinput></screen>

    <para>This package&apos;s testsuite is intended to be used by the
    maintainer (or not) to check i18n files.</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>

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

    <para><command>--libexecdir=$GNOME_PREFIX/lib/gedit</command> : this
    parameter ensures the libexec file is installed to the same directory as
    the plugins, instead of creating
    <filename class="directory">$GNOME_PREFIX/libexec</filename></para>

    <para><option>--disable-spell</option>: Use this parameter to disables
    spell-checking capability and is required if
    <application>Enchant</application> is not installed.</para>

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

    <para><option>--disable-scrollkeeper</option>: Use this parameter if you
    wish to disable the updates to the scrollkeeper database.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gedit and gnome-text-editor (a symlink to gedit)</seg>
        <seg>libgedit-private.so, libchangecase.so, libdocinfo.so, libfilebrowser.so,
        libmodelines.so, libsort.so, libspell.so, libtime.so</seg>
        <!-- slimmed as much as possible, reformatted to avoid whitespace at wrong places -->
        <seg><envar>$GNOME_PREFIX</envar>/include/gedit-3.0,
        <envar>$GNOME_PREFIX</envar>/lib/gedit,
        <envar>$GNOME_PREFIX</envar>/share/gedit-2,
        <envar>$GNOME_PREFIX</envar>/share/gnome/help/gedit,
        <envar>$GNOME_PREFIX</envar>/share/gtk-doc/html,
        <envar>$GNOME_PREFIX</envar>/share/omf/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
          GNOME desktop.</para>
          <indexterm zone="gedit gedit-prog">
            <primary sortas="b-gedit">gedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>