<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY app "<application>Gsynaptics</application>">
  <!ENTITY appversion "0.9.7">
  <!ENTITY manrevision "0.1">
  <!ENTITY date "Sunday, April 1, 2007">

  <!ENTITY project "The GSynaptics Project">

  <!ENTITY documentation-license SYSTEM "documentation-license.xml">
  <!ENTITY software-license SYSTEM "software-license.xml">

]>

<!-- $Id: mail-notification.xml,v 1.133 2006/06/14 07:44:48 jylefort Exp $ -->
<!-- Mail Notification Manual -->

<!-- Copyright (C) 2007 Olivier Berger -->
<!-- All rights reserved. -->

<!-- Redistribution and use in source (SGML DocBook) and 'compiled' -->
<!-- forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or -->
<!-- without modification, are permitted provided that the following -->
<!-- conditions are met: -->
<!-- 1. Redistributions of source code (SGML DocBook) must -->
<!--    retain the above copyright notice, this list of conditions and -->
<!--    the following disclaimer as the first lines of this file -->
<!--    unmodified. -->
<!-- 2. Redistributions in compiled form (transformed to other -->
<!--    DTDs, converted to PDF, PostScript, RTF and other formats) -->
<!--    must reproduce the above copyright notice, this list of -->
<!--    conditions and the following disclaimer in the documentation -->
<!--    and/or other materials provided with the distribution. -->

<!-- THIS DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND -->
<!-- CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, -->
<!-- INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -->
<!-- MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -->
<!-- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS -->
<!-- BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -->
<!-- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED -->
<!-- TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -->
<!-- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -->
<!-- ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR -->
<!-- TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF -->
<!-- THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY -->
<!-- OF SUCH DAMAGE. -->

<!-- This document does its best to adhere to the -->
<!-- GNOME Documentation Style Guide V1.3 -->
<!-- (http://developer.gnome.org/documents/style-guide) -->

<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo>
    <title>&app; Manual V&manrevision;</title>

    <copyright>
      <year>2007</year>
      <holder>Olivier Berger</holder>
    </copyright>
<!-- translators: uncomment this:

  <copyright>
   <year>2002</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->
    <publisher>
      <publishername>&project;</publishername>
    </publisher>

    &documentation-license;

    <authorgroup>
      <author>
	<firstname>Olivier</firstname>
	<surname>Berger</surname>
	<affiliation>
	  <orgname>&project;</orgname>
	  <address><email>oberger@ouvaton.org</email></address>
	</affiliation>
      </author>
      
<!-- This is appropriate place for other contributors: translators,
     maintainers,  etc. Commented out by default.
     
      <othercredit role="translator">
		<firstname>Latin</firstname> 
		<surname>Translator 1</surname> 
		<affiliation> 
	  		<orgname>Latin Translation Team</orgname> 
	  		<address> <email>translator@gnome.org</email> </address> 
		</affiliation>
		<contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>

<!-- The revision numbering system for GNOME manuals is as follows: -->
<!-- * the revision number consists of two components -->
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->  
    <revhistory>
      <revision>
	<revnumber>GSynaptics Manual V&manrevision;</revnumber>
	<date>&date;</date>
	<revdescription>
	  <para role="author">
	    Olivier Berger
	    <email>oberger@ouvaton.org</email>
	  </para>
	  <para role="publisher">&project;</para>
	</revdescription>
      </revision>
    </revhistory>

    <releaseinfo>
      This manual describes version &appversion; of GSynaptics.
    </releaseinfo>
    <legalnotice>
      <title>Feedback</title>
      <para>To report a bug or make a suggestion regarding the &app;
	application or this manual, follow the directions in
	<xref linkend="problem-reports"/>.
      </para>
      <!-- Translators may also add here feedback address for translations -->
    </legalnotice>
  </articleinfo>

  <indexterm zone="index">
    <primary>Mail Notification</primary>
  </indexterm>

  <sect1 id="introduction">
    <title>Introduction</title>
    <para>
      &app; is a tool designed to help setting configuration values
      for the X Synaptics touchpad driver.
    </para>
    <para>
      It helps configure the X synaptics touchpad driver parameters
      without editing X configuration files, through the use of the
      <command>synclient</command> tool in the backend.
    </para>
  </sect1>

  <sect1 id="getting-started">
    <title>Getting Started</title>

    <sect2 id="to-start">
    <title>To Start &app;</title>
      <para>
	You can start &app; in the following ways:
      </para>
      <variablelist>
    	<varlistentry>
	  <term><guimenu>Desktop</guimenu> menu</term>
	  <listitem>
	    <para>Choose
	      <menuchoice>
    		<guisubmenu>Preferences</guisubmenu>
    		<guimenuitem>Touchpad</guimenuitem>
	      </menuchoice> (this location may vary across systems).</para>
	  </listitem>
    	</varlistentry>

    	<varlistentry>
	  <term>Command line</term>
	  <listitem>
	    <para>
	      To start &app; from a command line, type the following
	      command, then press <keycap>Return</keycap>:
	    </para>
	    <para>
	      <command>gsynaptics</command>
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>

    <sect2 id="to-save">
      <title>To save your settings</title>

      <para>To use the values you have set at each start of your Gnome
      session, you have to run <command>gsynaptics-init</command> on
      session start.</para>

      <para>Choose <guimenu>Desktop</guimenu> menu,
      <menuchoice>
	<guisubmenu>Preferences</guisubmenu>
	<guimenuitem>Sessions</guimenuitem>
      </menuchoice> (this location may vary across systems).</para>

      <para>Then in <guilabel>Startup Programs</guilabel>, you have to
      add <command>gsynaptics-init</command>.
      </para>
    </sect2>

  </sect1>


  <sect1 id="requirements">
    <title>X server configuration requirements</title>

    <para>
      This tool can be used only if the synaptics driver is used by the X server.
    </para>
    <para>Also, it will only be able to communicate with the driver,
    if the <command>synclient</command> tool is installed and
    operational, which means there is <term>"SHMConfig" "true"</term>
    in the section of the synaptics driver in
    <filename>xorg.conf</filename> or <filename>XF86Config</filename>.
    </para>

    <para>Example:
    <programlisting>Section "InputDevice"
        Identifier      "Synaptics Touchpad"
        Driver          "synaptics"
        Option          "SendCoreEvents"        "true"
        Option          "Device"                "/dev/psaux"
        Option          "Protocol"              "auto-dev"
        Option          "HorizScrollDelta"      "0"
        Option          "SHMConfig"             "true"
EndSection
    </programlisting></para>


  </sect1>

  <sect1 id="properties"> 
    <title>Setting preferences</title> 
    <para>To configure &app;, choose
	      <menuchoice>
    		<guisubmenu>Preferences</guisubmenu>
    		<guimenuitem>Touchpad</guimenuitem>
	      </menuchoice> (this location may vary across systems).</para>

    <para>
      The <guilabel>Preferences</guilabel> dialog contains the
      following tabbed sections:
    </para>
    <itemizedlist>
      <listitem>
	<para><link linkend="properties-general">General</link></para>
      </listitem>
      <listitem>
	<para><link linkend="properties-tapping">Tapping</link></para>
      </listitem>
      <listitem>
	<para><link linkend="properties-scrolling">Scrolling</link></para>
      </listitem>
    </itemizedlist>

    <sect2 id="properties-general">
      <title>General</title>
      <variablelist>
	<varlistentry>
	  <term><guilabel>Enable touchpad</guilabel></term>
	  <listitem>
	    <para>
	      If this option is enabled, the touchpad will be active.
	    </para>
	    <variablelist>
	      <varlistentry>
		<term><guilabel>Sensitivity</guilabel></term>
		<listitem>
		  <para>
		    This will set the sensitivity level (from low to
		    high). This represents the sensitivity of the
		    touchpad to react to pressure.
		    <note>
		      <para>
			Depending on the actual sensitivity of your
			touchpad device, you may need to fine-tune
			this setting so that short pressure taps can
			be detected properly.
		      </para>
		    </note>
		  </para>
		</listitem>
	      </varlistentry>
	    </variablelist>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>
    
    <sect2 id="properties-tapping">
      <title>Tapping</title>
      <variablelist>
	<varlistentry>
	  <term><guilabel>Enable tapping</guilabel></term>
	  <listitem>
	    <para>
	      If this option is enabled, tapping the touchpad can be used to make clicks at the cursor position.
	    </para>
	    <variablelist>
	      <varlistentry>
		<term><guilabel>Tapping time</guilabel></term>
		<listitem>
		  <para>
		    This will set the sensitivity of taps/clicks
		    detection as a function of the length of the
		    period during which the finger will stay in
		    contact to the touchpad.
		  </para>
		</listitem>
	      </varlistentry>
	      <varlistentry>
		<term><guilabel>Enable faster tapping</guilabel></term>
		<listitem>
		  <para>
		    <quote>
		    Makes the driver react faster to a single tap, but
		    also makes double clicks caused by double tapping
		    slower </quote>. (borrowed from <command>man 5
		    synaptics</command> for <term>FastTaps</term>
		    configuration value of the driver)
		  </para>
		</listitem>
	      </varlistentry>
	    </variablelist>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>

    <sect2 id="properties-scrolling">
      <title>Scrolling</title>
      <variablelist>
	<varlistentry>
	  <term><guilabel>Scrolling</guilabel></term>
	  <listitem>
	    <para>
	      The touchpad can be used to control scrolling, as could
	      be done with a scroll-wheel mouse.
	    </para>
	  </listitem>
	  <listitem>
	    <variablelist>
	      <varlistentry id="enable-mail-summary-popup">
		<term><guilabel>Enable vertical scrolling</guilabel></term>
		<listitem>
		  <para>
		    If this option is enabled, vertical scrolling
		    (emulating a scroll mouse) is possible when moving
		    the finger along the right side of the touchpad.
		  </para>
		</listitem>
		<listitem>
		  <para>The scrolling speed can be set here.</para>
		</listitem>
	      </varlistentry>
	      <varlistentry>
		<term><guilabel>Enable horizontal scrolling</guilabel></term>
		<listitem>
		  <para>
		    If this option is enabled, horizontal scrolling is
		    possible when moving the finger along the bottom
		    side of the touchpad.
		  </para>
		</listitem>
		<listitem>
		  <para>The scrolling speed can be set here.</para>
		</listitem>
	      </varlistentry>
	      <varlistentry>
		<term><guilabel>Enable Circular scrolling</guilabel></term>
		<listitem>
		  <para>
		    If this option is enabled, the touchpad can act as
		    a scrolling wheel, by drawing a circle with the
		    finger on the touchpad.
		  </para>
		</listitem>
		<listitem>
		  <para>The scrolling speed can be set here.</para>
		</listitem>
		<listitem>
		  <para>The start point of the circle for circular scrolling can also be set here.</para>
		</listitem>
	      </varlistentry>
	    </variablelist>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guilabel>On an edge</guilabel></term>
	  <listitem>
	    <variablelist>
	      <varlistentry>
		<term><guilabel>continue scrolling</guilabel></term>
		<listitem>
		  <para>
		    TBD
		  </para>
		</listitem>
	      </varlistentry>
	      <varlistentry>
		<term><guilabel>cursor movement</guilabel></term>
		<listitem>
		  <para>
		    TBD
		  </para>
		</listitem>
	      </varlistentry>
	    </variablelist>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>
  </sect1>

  <sect1>
    <title>Advanced configuration</title>
    <para>
      The &app; program won't allow you to set all possible
      configuration options for the synaptics driver. For more
      advanced configuration, please refer to the
      <command>synclient</command> command.
    </para>
  </sect1>

  <sect1 id="about">
    <title>About &app;</title>
    <para>
      &app; was written by Hiroyuki Ikezoe
      <email>poincare@ikezoe.net</email>, Takuro Ashie
      <email>ashie@homa.ne.jp</email> and Ikuya Awashiro
      <email>ikuya@fruitsbasket.info</email>. To find more information
      about &app;, visit the <ulink
      url="http://gsynaptics.sourceforge.jp/" type="http">GSynaptics
      web page</ulink>.
    </para>

    <sect2 id="problem-reports">
      <title>Reporting Bugs and Other Feedback</title>
      <para>
	Bug reports and feedback should be sent to Hiroyuki Ikezoe
      <email>poincare@ikezoe.net</email>, Takuro Ashie
      <email>ashie@homa.ne.jp</email> and Ikuya Awashiro
      <email>ikuya@fruitsbasket.info</email>.
      </para>
    </sect2>


    <sect2 id="licensing-terms">
      <title>Licensing Terms</title>
      &software-license;
    </sect2>
  </sect1>

</article>
