;<!-- $Id$ -->
<refentry id="overview">
    <refmeta>
        <refentrytitle>pilot-link</refentrytitle>
        <manvolnum>7</manvolnum>
        <refmiscinfo>Copyright FSF 1996-2007</refmiscinfo>
    </refmeta>
    <refnamediv>
        <refname>pilot-link</refname>
        <refpurpose>
            A suite of tools for communicating with Palm handhelds, such as those made by Palm,
            Handspring, Handera, TRGPro, Sony or other Palm Compatible Handheld PDA device. 
        </refpurpose>
    </refnamediv>
    <refsect1>
        <title>Section</title>
        <para>
            Pilot-link: Overview
        </para>
    </refsect1>
    <refsect1>
        <title>description</title>
        <para>
            The pilot-link suite of tools contains 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
            the network.
        </para>
    </refsect1>
    <refsect1>
        <title>target device</title>
        <para>
            The /dev/pilot fallback has been removed in v0.12.  The environment variable <userinput>$PILOTPORT</userinput> can be set in your shell,
            to save specifying the port each time. A serial device specified on the command-line will be used regardless of any
            <userinput>$PILOTPORT</userinput> setting. If <userinput>$PILOTPORT</userinput> is not set, and <option>-p</option> is not supplied, all
            conduits in <emphasis>pilot-link</emphasis> will print the usage information.  The default connection rate is 9600 baud. You are welcome
            to try higher baud rates (19200, 38400, 57600 or higher) by setting the <userinput>$PILOTRATE</userinput> environment variable, but
            various machines have various limitations. (Be careful about values higher than 115200 on older Linux boxes if you've been using
            setserial to change the multiplier).
        </para>
    </refsect1>
    <refsect1>
        <title>Conduits</title>
        
        <para>
            A complete list of conduits available from within the <emphasis>pilot-link</emphasis>
            package as of the date of this manpage.  If you invoke any of the conduits from
            <emphasis>pilot-link</emphasis> with no command-line arguments at all, the usage summary will be printed.
        </para>
        
        <para>
            Note that there are widespread changes in this release - some conduits have been merged, a lot have had new
            options added and some options have been renamed or removed.
        </para>
        
        <refsect2>
            <title>addresses</title>
            <para>
                DEPRECATED: Use pilot-addresses --write|--human-readable instead.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-hinotes</title>
            <para>
                Syncronize your Hi-Notes database with your desktop machine.
            </para>
        </refsect2>
        <refsect2>
            <title>install-datebook</title>
            <para>
                installs a new datebook entry onto your Palm handheld.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-install-expenses</title>
            <para>
                Install an expense record from various parameters and arguments passed at connection time.
            </para>
        </refsect2>
        <refsect2>
            <title>install-hinote</title>
            <para>
                Install local files into your Hi-Note database on your Palm handheld. 
            </para>
        </refsect2>
        <refsect2>
            <title>install-memo</title>
            <para>
                Installs a new Memo Pad entry onto your Palm handheld.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-install-netsync</title>
            <para>
                reads or sets the Network Preferences information on a Palm Device. Modifies the "Network Preference"
                settings and reports additional intormation about the Palm, such as the IP,
                hostname, and other information as they are set on the Palm.
            </para>
        </refsect2>
        <refsect2>
            <title>install-todo</title>
            <para>
                Updates the Palm ToDo list with one new entry.
            </para>
        </refsect2>
        <refsect2>
            <title>install-todos</title>
            <para>
                Updates the Palm ToDo list with entries from a local file.
            </para>
        </refsect2>
        <refsect2>
            <title>install-user</title>
            <para>
                Reads or sets a Palm User and UserID on a Palm Device. Modifies the "User Preference"
                settings and reports additional intormation about the Palm, such as the Username and UserID as they are
                set on the Palm
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-memos</title>
            <para>
                Manipulate Memo entries from a file or your Palm device.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-addresses</title>
            <para>
                Read and write address book databases to and from a Palm handheld. 
            </para>
            <para>
                Changes in 0.12: Incorporates functionality from the now deprecated <filename>addresses</filename>
                conduit.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-archive</title>
            <para>
                DEPRECATED: Use pilot-read-todos -w --archived instead. 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-clip</title>
            <para>
                Get or Set the Palm Clipboard contents from STDOUT/STDIN.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-dedupe</title>
            <para>
                Removes duplicate records from any Palm database.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-file</title>
            <para>
                Dump application and header information from your local PRC/PDB files. 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-foto</title>
            <para>
                Palm 'Foto' Image Installer/Remover/Fetcher/Converter
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-screenshot</title>
            <para>
                Read screenshots from Palm (ScreenShotDB).
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-schlep</title>
            <para>
                Package up any arbitrary file and sync it to your Palm device.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-foto-treo600</title>
            <para>
                Copies Treo 600 foto databases to current directory and extracts .jpg files from them.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-foto-treo650</title>
            <para>
                Copies Treo 600 images and videos to the current directory
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-wav</title>
            <para>
                Decodes Palm Voice Memo files to wav files you can read 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-xfer</title>
            <para>
                Backup, sync, and restore databases from a Palm handheld device.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-expenses</title>
            <para>
                Export Palm Expense application data in a text format.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-ical</title>
            <para>
                Exports the DatebookDB and/or ToDo applications (DatebookDB.pdb and ToDoDB.pdb respectively) to Ical
                format. (The ical application must be installed and working on your system first. This is NOT the same
                thing as the iCal Calendar format, however).
            </para>
        </refsect2>
         <refsect2>
            <title>pilot-read-notepad</title>
            <para>
                List the record information found in the Palm Notepad (Palm OS4 and later) application.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-palmpix</title>
            <para>
                Convert all pictures in the files given or found on a Palm handheld.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-todos</title>
            <para>
                Syncronize your Palm ToDo application's database with your desktop machine.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-read-veo</title>
            <para>
                Synchronize your Veo Traveler databases 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-reminders</title>
            <para>
                Exports your Palm Datebook database into a 'remind' data file format. 
            </para>
        </refsect2>
    </refsect1>
    <refsect1>
        <title>Tools</title>
        <refsect2>
            <title>pilot-debugsh</title>
            <para>
                Simple debugging console for a Palm Handheld device (deprecated).
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-dlpsh</title>
            <para>
                An interactive Desktop Link Protocol (DLP) Shell for your Palm device.  This is very useful for
                debugging potential problems with your serial port. Query the RAM/ROM, list databases, change your
                UserID or Username, and many other useful functions. This is the
                "Swiss Army Knife" of any of pilot-link's tools.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-csd</title>
            <para>
                Connection Service Daemon for Palm Devices
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-getram</title>
            <para>
                Retrieves the RAM image from your Palm device for use in debugging.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-getrom</title>
            <para>
                Retrieves the ROM image from your Palm device for use in debugging. 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-getromtoken</title>
            <para>
                Reads a ROM token from a Palm Handheld device. 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-nredir</title>
            <para>
                Accept connection and redirect via Network Hotsync Protocol. 
            </para>
        </refsect2>
    </refsect1>
    <refsect1>
        <title>Perl Scripts</title>
        <para>(Available from the source code, not always installed from packages).</para>
        <refsect2>
            <title>pilot-ietf2datebook.pl</title>
            <para>
                Converts IETF agenda format to install-datebook format 
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-undelete.pl</title>
            <para>
                Turn previously archived records into normal (non-archived) records by resetting the "dirty" bit.
            </para>
        </refsect2>
        <refsect2>
            <title>pilot-sync-plan.pl</title>
            <para>
                completely synchronize the Palm datebook with the "plan" calendar via
                netplan, including authenticating
                to the netplan server itself.
            </para>
        </refsect2>
    </refsect1>
    <refsect1>
        <title>advanced programs</title>
        <para>
            Some of these programs are not intended for general end-users. More
            detailed documentation on their usage can be obtained by reading the source of
            the application itself.
        </para>
        <refsect2>
            <title>ccexample</title>
            <para>
                test program demonstrating C++ interface.
            </para>
        </refsect2>
        <refsect2>
            <title>iambicexample</title>
            <para>
                test program demonstrating C++ interface.
            </para>
        </refsect2>
        <refsect2>
            <title>validate</title>
            <para>
                experimental program to test C++ features.
            </para>
        </refsect2>
    </refsect1>
    <refsect1>
        <title>obtaining</title>
        <para>
            The most current version of the pilot-link suite of tools can be found at the pilot link homepage:
            http://www.pilot-link.org/
        </para>
    </refsect1>
    <refsect1>
        <title>mailing list</title>
        <para>
            The original pilot-unix mailing list has been taken offline, and is now being hosted and maintained by
            David A. Desrosiers <email>desrod@gnu-designs.com</email>. The original pilot-unix mailing list was
            maintained by Matthew Cravit. Its mandate was:
        </para>
        <blockquote>
            <para>
                The pilot-unix mailing list is for discussion and "idea-sharing" for those interested in using your
                Palm handheld with UNIX systems. This includes people who are interested in helping to develop tools to
                allow the Palm to operate with UNIX and other POSIX systems,
                and possibly to develop an SDK (Software Develop- ment Kit) for the Palm for Unix.
            </para>
        </blockquote>
        <para>
            For more information, including how to subscribe to the pilot-link mailing lists, please visit the
            pilot-link mailing list subscription page:
        </para>
        <para>http://lists.pilot-link.org/</para>
        <para>
            pilot-link specific mailing lists are also available for Development, General, and Announce topics, at the
            following:
        </para>
        
        <para>http://lists.pilot-link.org/mailman/listinfo/pilot-link-devel</para>
        <para>http://lists.pilot-link.org/mailman/listinfo/pilot-link-general</para>
        <para>http://lists.pilot-link.org/mailman/listinfo/pilot-link-announce</para>
    </refsect1>
    <refsect1>
        <title>author</title>
        <para>
            Most of the pilot-link tools were written by Kenneth Albanowski. This manual page was written by David H.
            Silber <email>pilot@orbits.com</email>, and updated for version 0.12 of pilot-link by Neil Williams <email>
                linux@codehelp.co.uk
            </email>
            .
        </para>
        <para>
            Current maintainer of pilot-link as of the authoring of this manpage is David A. Desrosiers
            <email>desrod@gnu-designs.com</email>.
        </para>
        <para>
            Any questions or problems with <emphasis>pilot-link</emphasis> should be directed at the various <emphasis>
                pilot-link
            </emphasis>
            mailing lists or to the irc channel dedicated to supporting <emphasis>pilot-link</emphasis> at <filename>
                irc.pilot-link.org
            </filename>
            in your irc application (not a web browser).
        </para>
    </refsect1>
    <refsect1>
        <title>patches</title>
        <para>
            All patches you wish to submit should be sent to <email>patches@pilot-link.org</email>
            directly, with a brief explanation of what the patch adds or fixes. Please make sure to send your patched
            in unified diff format (diff -u).
        </para>
    </refsect1>
    <refsect1>
        <title>see also</title>
        <para>
            <filename>pilot-addresses</filename>(1), <filename>pilot-dlpsh</filename>(1),
            <filename>pilot-hinotes</filename>(1), <filename>pilot-ietf2datebook</filename>(1),
            <filename>pilot-install-datebook</filename>(1),
            <filename>pilot-install-expenses</filename>(1),
            <filename>pilot-install-hinote</filename>(1), <filename>pilot-install-memo</filename>(1),
            <filename>pilot-install-netsync</filename>(1), <filename>pilot-install-user</filename>(1),
            <filename>pilot-getrom</filename>(1), <filename>pilot-getram</filename>(1),
            <filename>pilot-addresses</filename>(1), <filename>pilot-xfer</filename>(1),
            <filename>pilot-read-ical</filename>(1), <filename>pilot-read-notepad</filename>(1),
            <filename>pilot-read-palmpix</filename>(1)
        </para>
        <para>
            David Silber <email>pilot@orbits.com</email> has written a Pilot HOWTO,
            which you can find at http://www.sgmltools.org/HOWTO/Pilot-HOWTO/t1.html
        </para>
    </refsect1>
</refentry>
