PILOT-LINK(7)

NAME
pilot-link - a suite of tools for communicating with Palm handhelds, such as those made from Palm, Handspring, Handera, TRGPro, Sony or other Palm Compatible Handheld PDA device.

DESCRIPTION
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.

TARGET DEVICE
All of the pilot-link programs will default to /dev/pilot as the default device used to communicate with a Palm. In general, if the environment variable $PILOTPORT is set in your shell, its value will override this default. A serial device specified on the command-line will be used regardless of any $PILOTPORT setting. If $PILOTPORT is not set, and -p is not supplied, any of the conduits in pilot-link will default to /dev/pilot. The default connection rate is 9600 baud. You are welcome to try higher baud rates (19200, 38400, 57600 or higher) by setting the $PILOTRATE 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).

USAGE
Here is a list of programs available from within the pilot-link package as of the date of this manpage.

addresses
    dump the Palm Address book into a generic text-output format.

debugsh
    commandline interface to a Palm debug monitor (deprecated).

dlpsh
    commandline interface to Palm DLP HotSync protocol. 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.

getrom
    program to fetch ROM using getrom.prc or getrom2.prc.

getrom.prc
    Palm program to help dump a 512K ROM. This must be installed on your Palm handheld.

getrom2.prc
    Palm program to help dump a 1024K ROM (used for PalmOS 2.x devices only).

ietf2datebook
    convert an IETF calendar to format used by install-datebook.

install-datebook
    import datebook records from a text file onto the Palm handheld.

install-memo
    import Memo records from a text format into the Palm.

install-netsync
    modify the "Network Preference" settings and report additional intormation about the Palm, such as the IP, hostname, and other information as they are set on the Palm.

install-todos
    import ToDo records from a text format into the Palm.

install-user
    modify the "User Preference" settings and report additional intormation about the Palm, such as the Username and UserID as they are set on the Palm.

memos
    export memos from the Palm in mailbox format into one file, or one of two formats: one-file-per-record or one-directory-per-category.

pi-csd
    this must be running to accept Network HotSync(tm) connects.

pi-getram
    program that retrieves the RAM image from Palm.

pi-getrom
    program that retrieves a ROM image from Palm (without using getrom.prc).

pi-getromtoken
    program that retrieves the ROM tokens from the Palm, such as the serial number of the device, if available. Does not work on OS5 devices, currently.

pi-nredir
    program that accepts connections and redirects them via the Network HotSync(tm) protocol.

pi-port
    experimental program to abstract the serial layer from pilot-link.

pilot-addresses
    import and export records from the Address Book (AddressDB.pdb) on your Palm.

pilot-clip
    experimental program to import and export data from Palm clipboard.

pilot-debug
    graphical and command-line program to interface with Palm debug monitor.

pilot-dedupe
    strips duplicate records from Palm databases.

pilot-file
    dissect .prc and .pdb files to view header, app_info, and record information.

pilot-mail
    import mail from POP3 mailbox into Palm's default Mail application, and send mail via sendmail. This has been replaced by pilot-mailsync from Hollis Blanchard <hollis@amulet.co.jp>. Please see the CREDITS file for additional information on how to obtain this package.

pilot-schlep
    stores a single file of any data type (such as .zip or .mp3) on the Palm or retrieves one from the Palm.

pilot-undelete
    turn previously archived records into normal (non-archived) records by resetting the "dirty" bit.

pilot-xfer
    backup, restore, install and delete Palm databases. The most-used pilot-link conduit.

read-expenses
    export Palm expense database into a simple text format.

read-ical
    export Palm Datebook and ToDo databases (DatebookDB.pdb and ToDoDB.pdb respectively) into an Ical calendar (the ical application must be installed and working on your system first. This is NOT the same thing as the iCal Calendar format, however).

read-notepad
    reads record information and images created with the Palm OS4 and later NotePad application.

read-palmpix
    reads images created with the Kodak PalmPix "snap-on" camera.

read-todos
    export Palm ToDo database into generic text format.

reminders
    export Palm Datebook into a 'remind' data file.

sync-plan
    completely synchronize the Palm datebook with the "plan" calendar via netplan, including authenticating to the netplan server itself.

ADVANCED PROGRAMS
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.

ccexample
    test program demonstrating C++ interface.

iambicexample
    test program demonstrating C++ interface.

validate
    experimental program to test C++ features.

OBTAINING
The most current version of the pilot-link suite of tools can be found at the pilot link homepage:

    http://www.pilot-link.org/

MAILING LIST
The original pilot-unix mailing list has been taken offline, and is now being hosted and maintained by David A. Desrosiers <desrod@gnu-designs.com>. The original pilot-unix mailing list was maintained by Matthew Cravit. Its mandate was:

    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 Development Kit) for the Palm for Unix.

For more information, including how to subscribe to the pilot-link mailing lists, please visit the pilot-link mailing list subscription page:

    http://lists.pilot-link.org/

pilot-link specific mailing lists are also available for Development, General, and Announce topics, at the following:

    http://lists.pilot-link.org/mailman/listinfo/pilot-link-devel http://lists.pilot-link.org/mailman/listinfo/pilot-link-general http://lists.pilot-link.org/mailman/listinfo/pilot-link-announce

AUTHOR
Most of the pilot-link tools were written by Kenneth Albanowski. This manual page was written by David H. Silber <pilot@orbits.com>, and updated for this version of pilot-link by David A. Desrosiers <desrod@gnu-designs.com>. Current maintainer of pilot-link as of the authoring of this manpage is David A. Desrosiers <desrod@gnu-designs.com>. Any questions or problems with pilot-link should be directed at the various fBpilot-link mailing lists or to the irc channel dedicated to supporting pilot-link at irc.pilot-link.org in your irc application (not a web browser).

PATCHES
All patches you wish to submit should be sent to <patches@pilot-link.org> 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).

SEE ALSO
addresses(1), dlpsh(1), hinotes(1), ietf2datebook(1), install-datebook(1), install-expenses(1), install-hinote(1), install-memo(1), install-netsync(1), install-user(1), pi-getrom(1), pi-getram(1), pilot-addresses(1), pilot-xfer(1), read-ical(1), read-notepad(1), read-palmpix(1) David Silber <pilot@orbits.com> has written a Pilot HOWTO, which you can find at http://www.sgmltools.org/HOWTO/Pilot-HOWTO/t1.html