source: gnome/add/gok.xml@ 005d8327

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gok-download-http "http://ftp.gnome.org/pub/GNOME/sources/gok/1.0/gok-&gok-version;.tar.bz2">
  <!ENTITY gok-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gok/1.0/gok-&gok-version;.tar.bz2">
  <!ENTITY gok-md5sum        "a9334a0e1dc11bbba817c128503260b0">
  <!ENTITY gok-size          "1.3 MB">
  <!ENTITY gok-buildsize     "40.3 MB">
  <!ENTITY gok-time          "0.7 SBU">
]>

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

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

  <title>GOK-&gok-version;</title>

  <indexterm zone="gok">
    <primary sortas="a-GOK">GOK</primary>
  </indexterm>

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

    <para><application>GOK</application> is a dynamic onscreen keyboard. It
    features Direct Selection, Dwell Selection, Automatic Scanning and Inverse
    Scanning access methods and includes word completion.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="libgnomeui"/>,
    <xref linkend="scrollkeeper"/>,
    <xref linkend="libwnck"/>,
    <xref linkend="at-spi"/> and
    <xref linkend="gnome-speech"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="gtk-doc"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --sysconfdir=/etc/gnome --localstatedir=/var/lib &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 &amp;&amp;
chmod -v 644 `pkg-config --variable=prefix ORBit-2.0`\
/share/gnome/help/gok/C/legal.xml</userinput></screen>

  </sect2>

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

    <para><parameter>--sysconfdir=/etc/gnome</parameter>: This switch puts
    configuration files in <filename class="directory">/etc/gnome</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <para><option>--enable-gtk-doc</option>: Use this parameter to build and
    install the API documentation as the source tarball doesn't contain
    pre-built docs.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring GOK</title>

    <sect3>
      <title>Configuration Information</title>

      <para>It is recommended that you configure your input device as an
      <quote>Extended</quote> input device. Exact configuration methods
      depend on the type of hardware attached to your system. See the
      <filename>README</filename> file in the package source tree and
      <application>GOK</application> Help for information on how
      to configure your input device.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>gok and create-branching-keyboard</seg>
        <seg>None</seg>
        <seg>/etc/gnome/gconf/gconf.xml.defaults/apps/gok,
        /etc/gnome/gconf/gconf.xml.defaults/schemas/apps/gok,
        $GNOME_PREFIX/share/gnome/help/gok,
        $GNOME_PREFIX/share/gok,
        $GNOME_PREFIX/share/gtk-doc/html/gok and 
        $GNOME_PREFIX/share/omf/gok</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gok-prog">
        <term><command>gok</command></term>
        <listitem>
          <para>is a dynamic onscreen keyboard utility.</para>
          <indexterm zone="gok gok-prog">
            <primary sortas="b-gok">gok</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>