source: gnome/add/gok.xml@ 139e755

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

<!ENTITY gok-download-http "http://ftp.gnome.org/pub/GNOME/sources/gok/0.11/gok-&gok-version;.tar.bz2">
<!ENTITY gok-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gok/0.11/gok-&gok-version;.tar.bz2">
<!ENTITY gok-md5sum "6bfe9d4efb35ae20ef1c05c191dc8ad7">
<!ENTITY gok-size "1.2 MB">
<!ENTITY gok-buildsize "37 MB">
<!ENTITY gok-time "0.59 SBU">
]>

<sect1 id="gok" xreflabel="GOK-&gok-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="gok.html"?>
<title>GOK-&gok-version;</title>

<sect2>
<title>Introduction to <application><acronym>GOK</acronym></application></title>

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

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application><acronym>GOK</acronym></application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="libgnomeui"/>, 
<xref linkend="scrollkeeper"/>, 
<xref linkend="libwnck"/>, 
<xref linkend="at-spi"/> and 
<xref linkend="gnome-speech"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="gtk-doc"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>GOK</acronym></application></title>

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

<screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --sysconfdir=/etc/gnome --localstatedir=/var/lib &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
chmod 644 `pkg-config --variable=prefix ORBit-2.0`\
/share/gnome/help/gok/C/*.xml</command></userinput></screen>

</sect2>

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

</sect2>

<sect2>
<title>Configuring <application><acronym>GOK</acronym></application></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><acronym>GOK</acronym></application> Help for information on how 
to configure your input device.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>GOK</acronym></application> package contains
<command>gok</command> and <command>create-branching-keyboard</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>gok</title>
<para><command>gok</command> is a dynamic onscreen keyboard
utility.</para></sect3>

</sect2>

</sect1>