~ubuntu-branches/ubuntu/edgy/pilot-link/edgy

« back to all changes in this revision

Viewing changes to doc/man/pilot-link.7

  • Committer: Bazaar Package Importer
  • Author(s): Ludovic Rousseau
  • Date: 2006-09-22 11:51:36 UTC
  • mfrom: (3.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20060922115136-qqmy17bx8j5x0y72
Tags: 0.12.1-5
* urgency medium since libpisock-dev was not usable to build any package
* libpisock-dev now depends on libusb-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"Generated by db2man.xsl. Don't modify this, modify the source.
 
2
.de Sh \" Subsection
 
3
.br
 
4
.if t .Sp
 
5
.ne 5
 
6
.PP
 
7
\fB\\$1\fR
 
8
.PP
 
9
..
 
10
.de Sp \" Vertical space (when we can't use .PP)
 
11
.if t .sp .5v
 
12
.if n .sp
 
13
..
 
14
.de Ip \" List item
 
15
.br
 
16
.ie \\n(.$>=3 .ne \\$3
 
17
.el .ne 3
 
18
.IP "\\$1" \\$2
 
19
..
 
20
.TH "pilot-link" 7 "Copyright 1996-2005 FSF" "0.12.1" "PILOT-LINK"
 
21
.SH NAME
 
22
pilot-link \- 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.
 
23
.SH "SECTION"
 
24
 
 
25
.PP
 
26
Pilot\-link: Overview
 
27
 
 
28
.SH "DESCRIPTION"
 
29
 
 
30
.PP
 
31
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\&.
 
32
 
 
33
.SH "TARGET DEVICE"
 
34
 
 
35
.PP
 
36
The /dev/pilot fallback has been removed in v0\&.12\&. The environment variable\fB$PILOTPORT\fR 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\fB$PILOTPORT\fR setting\&. If \fB$PILOTPORT\fR is not set, and \fB\-p\fR is not supplied, all conduits in \fIpilot\-link\fR 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\fB$PILOTRATE\fR 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)\&.
 
37
 
 
38
.SH "CONDUITS"
 
39
 
 
40
.PP
 
41
A complete list of conduits available from within the \fIpilot\-link\fR package as of the date of this manpage\&. If you invoke any of the conduits from\fIpilot\-link\fR with no command\-line arguments at all, the usage summary will be printed\&.
 
42
 
 
43
.PP
 
44
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\&.
 
45
 
 
46
.SS "addresses"
 
47
 
 
48
.PP
 
49
DEPRECATED: Use pilot\-addresses \-\-write|\-\-human\-readable instead\&.
 
50
 
 
51
.SS "pilot-hinotes"
 
52
 
 
53
.PP
 
54
Syncronize your Hi\-Notes database with your desktop machine\&.
 
55
 
 
56
.SS "install-datebook"
 
57
 
 
58
.PP
 
59
installs a new datebook entry onto your Palm handheld\&.
 
60
 
 
61
.SS "install-expenses"
 
62
 
 
63
.PP
 
64
Install an expense record from various parameters and arguments passed at connection time\&.
 
65
 
 
66
.SS "install-hinote"
 
67
 
 
68
.PP
 
69
Install local files into your Hi\-Note database on your Palm handheld\&.
 
70
 
 
71
.SS "install-memo"
 
72
 
 
73
.PP
 
74
Installs a new Memo Pad entry onto your Palm handheld\&.
 
75
 
 
76
.SS "install-netsync"
 
77
 
 
78
.PP
 
79
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\&.
 
80
 
 
81
.SS "install-todo"
 
82
 
 
83
.PP
 
84
Updates the Palm ToDo list with one new entry\&.
 
85
 
 
86
.SS "install-todos"
 
87
 
 
88
.PP
 
89
Updates the Palm ToDo list with entries from a local file\&.
 
90
 
 
91
.SS "install-user"
 
92
 
 
93
.PP
 
94
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
 
95
 
 
96
.SS "pilot-memos"
 
97
 
 
98
.PP
 
99
Manipulate Memo entries from a file or your Palm device\&.
 
100
 
 
101
.SS "pilot-addresses"
 
102
 
 
103
.PP
 
104
Read and write address book databases to and from a Palm handheld\&.
 
105
 
 
106
.PP
 
107
Changes in 0\&.12: Incorporates functionality from the now deprecated \fIaddresses\fR conduit\&.
 
108
 
 
109
.SS "pilot-archive"
 
110
 
 
111
.PP
 
112
DEPRECATED: Use read\-todos \-w \-\-archived instead\&.
 
113
 
 
114
.SS "pilot-clip"
 
115
 
 
116
.PP
 
117
Get or Set the Palm Clipboard contents from STDOUT/STDIN\&.
 
118
 
 
119
.SS "pilot-dedupe"
 
120
 
 
121
.PP
 
122
Removes duplicate records from any Palm database\&.
 
123
 
 
124
.SS "pilot-file"
 
125
 
 
126
.PP
 
127
Dump application and header information from your local PRC/PDB files\&.
 
128
 
 
129
.SS "pilot-foto"
 
130
 
 
131
.PP
 
132
Palm 'Foto' Image Installer/Remover/Fetcher/Converter
 
133
 
 
134
.SS "pilot-schlep"
 
135
 
 
136
.PP
 
137
Package up any arbitrary file and sync it to your Palm device\&.
 
138
 
 
139
.SS "pilot-treofoto"
 
140
 
 
141
.PP
 
142
Copies Treo foto databases to current directory and extracts \&.jpg files from them\&.
 
143
 
 
144
.SS "pilot-wav"
 
145
 
 
146
.PP
 
147
Decodes Palm Voice Memo files to wav files you can read
 
148
 
 
149
.SS "pilot-xfer"
 
150
 
 
151
.PP
 
152
Backup, sync, and restore databases from a Palm handheld device\&.
 
153
 
 
154
.SS "read-expenses"
 
155
 
 
156
.PP
 
157
Export Palm Expense application data in a text format\&.
 
158
 
 
159
.SS "read-ical"
 
160
 
 
161
.PP
 
162
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)\&.
 
163
 
 
164
.SS "read-notepad"
 
165
 
 
166
.PP
 
167
List the record information found in the Palm Notepad (Palm OS4 and later) application\&.
 
168
 
 
169
.SS "read-palmpix"
 
170
 
 
171
.PP
 
172
Convert all pictures in the files given or found on a Palm handheld\&.
 
173
 
 
174
.SS "read-screenshot"
 
175
 
 
176
.PP
 
177
Read screenshots from Palm (ScreenShotDB)\&.
 
178
 
 
179
.SS "read-todos"
 
180
 
 
181
.PP
 
182
Syncronize your Palm ToDo application's database with your desktop machine\&.
 
183
 
 
184
.SS "read-veo"
 
185
 
 
186
.PP
 
187
Synchronize your Veo Traveler databases
 
188
 
 
189
.SS "pilot-reminders"
 
190
 
 
191
.PP
 
192
Exports your Palm Datebook database into a 'remind' data file format\&.
 
193
 
 
194
.SH "TOOLS"
 
195
 
 
196
.SS "pilot-debugsh"
 
197
 
 
198
.PP
 
199
Simple debugging console for a Palm Handheld device (deprecated)\&.
 
200
 
 
201
.SS "pilot-dlpsh"
 
202
 
 
203
.PP
 
204
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\&.
 
205
 
 
206
.SS "pilot-csd"
 
207
 
 
208
.PP
 
209
Connection Service Daemon for Palm Devices
 
210
 
 
211
.SS "pilot-getram"
 
212
 
 
213
.PP
 
214
Retrieves the RAM image from your Palm device for use in debugging\&.
 
215
 
 
216
.SS "pilot-getrom"
 
217
 
 
218
.PP
 
219
Retrieves the ROM image from your Palm device for use in debugging\&.
 
220
 
 
221
.SS "pilot-getromtoken"
 
222
 
 
223
.PP
 
224
Reads a ROM token from a Palm Handheld device\&.
 
225
 
 
226
.SS "pilot-nredir"
 
227
 
 
228
.PP
 
229
Accept connection and redirect via Network Hotsync Protocol\&.
 
230
 
 
231
.SH "PERL SCRIPTS"
 
232
 
 
233
.PP
 
234
(Available from the source code, not always installed from packages)\&.
 
235
 
 
236
.SS "ietf2datebook.PL"
 
237
 
 
238
.PP
 
239
Converts IETF agenda format to install\-datebook format
 
240
 
 
241
.SS "pilot-undelete.PL"
 
242
 
 
243
.PP
 
244
Turn previously archived records into normal (non\-archived) records by resetting the "dirty" bit\&.
 
245
 
 
246
.SS "sync-plan.PL"
 
247
 
 
248
.PP
 
249
completely synchronize the Palm datebook with the "plan" calendar via netplan, including authenticating to the netplan server itself\&.
 
250
 
 
251
.SH "ADVANCED PROGRAMS"
 
252
 
 
253
.PP
 
254
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\&.
 
255
 
 
256
.SS "ccexample"
 
257
 
 
258
.PP
 
259
test program demonstrating C++ interface\&.
 
260
 
 
261
.SS "iambicexample"
 
262
 
 
263
.PP
 
264
test program demonstrating C++ interface\&.
 
265
 
 
266
.SS "validate"
 
267
 
 
268
.PP
 
269
experimental program to test C++ features\&.
 
270
 
 
271
.SH "OBTAINING"
 
272
 
 
273
.PP
 
274
The most current version of the pilot\-link suite of tools can be found at the pilot link homepage: http://www\&.pilot\-link\&.org/
 
275
 
 
276
.SH "MAILING LIST"
 
277
 
 
278
.PP
 
279
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:
 
280
 
 
281
.PP
 
282
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\&.
 
283
 
 
284
.PP
 
285
For more information, including how to subscribe to the pilot\-link mailing lists, please visit the pilot\-link mailing list subscription page:
 
286
 
 
287
.PP
 
288
http://lists\&.pilot\-link\&.org/
 
289
 
 
290
.PP
 
291
pilot\-link specific mailing lists are also available for Development, General, and Announce topics, at the following:
 
292
 
 
293
.PP
 
294
http://lists\&.pilot\-link\&.org/mailman/listinfo/pilot\-link\-devel
 
295
 
 
296
.PP
 
297
http://lists\&.pilot\-link\&.org/mailman/listinfo/pilot\-link\-general
 
298
 
 
299
.PP
 
300
http://lists\&.pilot\-link\&.org/mailman/listinfo/pilot\-link\-announce
 
301
 
 
302
.SH "AUTHOR"
 
303
 
 
304
.PP
 
305
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 version 0\&.12 of pilot\-link by Neil Williams <linux@codehelp\&.co\&.uk>\&.
 
306
 
 
307
.PP
 
308
Current maintainer of pilot\-link as of the authoring of this manpage is David A\&. Desrosiers <desrod@gnu\-designs\&.com>\&.
 
309
 
 
310
.PP
 
311
Any questions or problems with \fIpilot\-link\fR should be directed at the various \fIpilot\-link\fR mailing lists or to the irc channel dedicated to supporting \fIpilot\-link\fR at \fIirc\&.pilot\-link\&.org\fR in your irc application (not a web browser)\&.
 
312
 
 
313
.SH "PATCHES"
 
314
 
 
315
.PP
 
316
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)\&.
 
317
 
 
318
.SH "SEE ALSO"
 
319
 
 
320
.PP
 
321
\fIpilot\-addresses\fR(1), \fIpilot\-dlpsh\fR(1), \fIpilot\-hinotes\fR(1), \fIietf2datebook\fR(1), \fIinstall\-datebook\fR(1), \fIinstall\-expenses\fR(1), \fIinstall\-hinote\fR(1), \fIinstall\-memo\fR(1), \fIinstall\-netsync\fR(1), \fIinstall\-user\fR(1), \fIpilot\-getrom\fR(1), \fIpilot\-getram\fR(1), \fIpilot\-addresses\fR(1), \fIpilot\-xfer\fR(1), \fIread\-ical\fR(1), \fIread\-notepad\fR(1), \fIread\-palmpix\fR(1)
 
322
 
 
323
.PP
 
324
David Silber <pilot@orbits\&.com> has written a Pilot HOWTO, which you can find at http://www\&.sgmltools\&.org/HOWTO/Pilot\-HOWTO/t1\&.html
 
325