source: general/genutils/pilot-link.xml@ 65f676a

<?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 pilot-link-download-http "http://downloads.pilot-link.org/pilot-link-&pilot-link-version;.tar.bz2">
  <!ENTITY pilot-link-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/pilot-link-&pilot-link-version;.tar.bz2">
  <!ENTITY pilot-link-md5sum        "586f84add601e8b86da3093ab784e997">
  <!ENTITY pilot-link-size          "649 KB">
  <!ENTITY pilot-link-buildsize     "15 MB">
  <!ENTITY pilot-link-time          "0.46 SBU">
]>

<sect1 id="pilot-link" xreflabel="pilot-link-&pilot-link-version;">
  <?dbhtml filename="pilot-link.html"?>
  
  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>
  
  <title>Pilot-link-&pilot-link-version;</title>
  
  <indexterm zone="pilot-link">
    <primary sortas="a-Pilot-link">Pilot-link</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Pilot-link</title>
    
    <para>The <application>pilot-link</application> package provides a suite of 
    tools containing a series of conduits, libraries, and language bindings for 
    moving information to and from your Palm device and your desktop or 
    server/workstation system, as well as across a network.</para>
    
    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&pilot-link-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&pilot-link-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &pilot-link-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &pilot-link-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &pilot-link-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &pilot-link-time;</para>
      </listitem>
    </itemizedlist>
    
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink 
        url="&patch-root;/pilot-link-&pilot-link-version;-bindings_fix-1.patch"/></para>
      </listitem>
    </itemizedlist>
    
    <bridgehead renderas="sect3">Pilot-link Dependencies</bridgehead>
    
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="libpng"/>, 
    <xref linkend="jdk"/>, 
    <xref linkend="tcl"/>, 
    <xref linkend="python"/> and 
    <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
    
  </sect2>
  
  <sect2 role="kernel" id="pilot-link-kernel">
    <title>Kernel Configuration</title>
    
    <indexterm zone="pilot-link pilot-link-kernel">
      <primary sortas="d-USB-Palm-devices">USB Palm devices</primary>
    </indexterm>
    
    <para>You may need to configure the <quote>USB_SERIAL_VISOR</quote> device 
    into the kernel before your system can communicate with your Palm device. Add 
    this device by enabling the following kernel parameter setting and 
    rebuilding the kernel (and modules, if applicable):</para>
    
<screen><literal>Device Drivers:
  USB support:
    USB Serial Converter support:
      USB Handspring Visor / Palm m50x / Sony Client Driver</literal></screen>
    
    <para>For additional information about connecting your USB 
    Palm device (it is however, somewhat dated), see: 
    <ulink url="http://www.pilot-link.org/README.usb"/>.</para>

  </sect2>
  
  <sect2 role="installation">
    <title>Installation of Pilot-link</title>

    <para>Install <application>pilot-link</application> by running the following 
    commands:</para>

<screen><userinput>patch -Np1 -i ../pilot-link-&pilot-link-version;-bindings_fix-1.patch &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
    
    <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>

    <para><option>--with-perl --with-java --with-tcl=/usr/lib 
    --with-python</option>: Use any or all of these options to enable the 
    respective language bindings desired.</para>
    
  </sect2>
  
  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Bindings</segtitle>
      <segtitle>Installed Directory</segtitle>
    
    <seglistitem>
      <seg>addresses, ccexample, debugsh, dlpsh, hinotes, ietf2datebook, 
      install-datebook, install-expenses, install-hinote, install-memo, 
      install-netsync, install-todo, install-todos, install-user, memos, money2qif, 
      pi-csd, pi-getram, pi-getrom, pi-getromtoken, pi-nredir, pilot-addresses, 
      pilot-archive, pilot-clip, pilot-datebook, pilot-dedupe, pilot-file, 
      pilot-foto, pilot-prc, pilot-schlep, pilot-undelete, pilot-xfer, pitclsh, 
      read-expenses, read-ical, read-notepad, read-palmpix, read-todos, reminders, 
      and sync-plan</seg>
      <seg>libpisock.[so,a], libpisock++.[so,a], and libpisync.[so,a]</seg>
      <seg>libjpisock.so JDK library, libpitcl.[so,a] 
      <application>Tcl</application> library, and
      <application>Python</application> and <application>Perl</application> 
      modules</seg>
      <seg>/usr/share/pilot-link</seg>
    </seglistitem>
    </segmentedlist>
    
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>
      
      <varlistentry id="pilot-link-programs">
        <term><command>pilot-link programs and utilities</command></term>
        <listitem>
          <para>Describing the functionality of each 
          <application>pilot-link</application> program and utility would take several 
          pages. Instead, after you've installed the package, review the 
          <application>pilot-link</application> man page 
          (<command>man pilot-link</command>). If you wish to review before installing 
          the package, unpack the tarball and issue 
          <command>man doc/man/pilot-link.7.in</command>.</para>
          <indexterm zone="pilot-link pilot-link-programs">
            <primary sortas="b-pilot-link-programs">pilot-link programs</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    
    </variablelist>

  </sect2>

</sect1>