source: gnome/add/gok.xml@ e05cd03f

<?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 gok-download-http "&gnome-download-http;/gok/1.2/gok-&gok-version;.tar.bz2">
  <!ENTITY gok-download-ftp  "&gnome-download-ftp;/gok/1.2/gok-&gok-version;.tar.bz2">
  <!ENTITY gok-md5sum        "2ef1f171385a37f93408dbca7ecfdf11">
  <!ENTITY gok-size          "1.2 MB">
  <!ENTITY gok-buildsize     "50 MB">
  <!ENTITY gok-time          "0.6 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 role="required"><xref linkend="esound"/>,
    <xref linkend="scrollkeeper"/>,
    <xref linkend="at-spi"/>,
    <xref linkend="libwnck"/>,
    <xref linkend="libgnomeui"/>, and
    <xref linkend="gnome-speech"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libusb-compat"/>,
    <xref linkend="intltool"/>, and
    <xref linkend="gtk-doc"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/gok"/></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=&gnome-etc-dir; \
            --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>

    <para>For full functionality of this package, you should install the
    <xref linkend="libgail-gnome"/> package.</para>

  </sect2>

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

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

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

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

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

  </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>The following subdirectories of <envar>$GNOME_PREFIX</envar>/:
        share/{,gnome/help/ ,gtk-doc/html ,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>