source: archive/pilot-link.xml@ 48b59802

<?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 pilot-link-download-http "http://downloads.pilot-link.org/pilot-link-&pilot-link-version;.tar.bz2">
  <!ENTITY pilot-link-download-ftp  "&gentoo-ftp-repo;/pilot-link-&pilot-link-version;.tar.bz2">
  <!ENTITY pilot-link-md5sum        "c1f4db8f32a2ee916fedb9a2dac8aa26">
  <!ENTITY pilot-link-size          "964 KB">
  <!ENTITY pilot-link-buildsize     "20 MB">
  <!ENTITY pilot-link-time          "0.4 SBU">
]>

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

  <sect1info>
    <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 role="optional"><xref linkend="libpng"/>,
    <xref linkend="popt"/>,
    <xref linkend="libusb-compat"/>,
    <xref linkend="openjdk"/>, <!-- or <xref linkend="jdk"/>, -->
    <xref linkend="tcl"/>,
    <xref linkend="python2"/>,
    <ulink url="http://www.bluez.org/">BlueZ</ulink>, and
    <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/pilot-link"/></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,
    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 \
            --enable-threads \
            --enable-conduits \
            --with-perl &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;
install -v -m755 -d /usr/share/doc/pilot-link-&pilot-link-version; &amp;&amp;
install -v -m644 README doc/{README.*,TODO,CodingGuidelines} \
                    /usr/share/doc/pilot-link-&pilot-link-version;</userinput></screen>

  </sect2>

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

    <para><parameter>--enable-threads</parameter>: This parameter is required
    to link the threading library into the build.</para>

    <para><parameter>--enable-conduits</parameter>: This parameter is required
    to build the userspace programs. Omit it if you only need the
    <application>pilot-link</application> libraries.</para>

    <para><parameter>--with-perl</parameter>: This parameter is required to
    build the <application>Perl</application> bindings.</para>

    <para><option>--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>pilot-650foto, pilot-addresses, pilot-clip, pilot-csd,
      pilot-debugsh, pilot-dedupe, pilot-dlpsh, pilot-file, pilot-foto,
      pilot-getram, pilot-getrom, pilot-getromtoken, pilot-hinotes,
      pilot-ietf2datebook, pilot-install-datebook, pilot-install-expenses,
      pilot-install-hinote, pilot-install-memo, pilot-install-netsync,
      pilot-install-todo, pilot-install-todos, pilot-install-user,
      pilot-memos, pilot-nredir, pilot-read-expenses, pilot-read-ical,
      pilot-read-notepad, pilot-read-palmpix, pilot-read-screenshot,
      pilot-read-todos, pilot-read-veo, pilot-reminders, pilot-schlep,
      pilot-sync-plan, pilot-treofoto, pilot-undelete, pilot-wav,
      pilot-xfer and optionally, pitclsh</seg>
      <seg>libjpisock.so JDK library,
      libpitcl.{so,a} <application>Tcl</application> library,
      _pisock.so <application>Python</application> module and
      Pilot.so <application>Perl</application> module</seg>
      <seg>/usr/lib/perl5/site_perl/&lfs-perl-version;/i686-linux/auto/PDA,
      /usr/share/doc/pilot-link-0.12.2 and/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>