Penguin
Recent Changes
Blame: pilot-xfer(1)
EditPageHistoryDiffInfoLikePages
Annotated edit history of pilot-xfer(1) version 2, including all changes. View license author blame.
Rev Author # Line
1 perry 1 PILOT-XFER
2 !!!PILOT-XFER
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 TARGET DEVICE
7 OPTIONS
8 USAGE
9 EXAMPLES
10 SEE ALSO
11 AUTHOR
12 ----
13 !!NAME
14
15
16 pilot-xfer - backup and restore databases to and from a Palm Computing Device, Handspring Visor, TRGPro, or other Palm Compatible Handheld PDA
17 !!SYNOPSIS
18
19
20 __pilot-xfer__ -p ''[['' [[__--exclude__
21 ''file''] __--backup__ | __--update__ |
22 __--sync__ ''directory''
23
24
25 or
26
27
28 __pilot-xfer__ -p ''[['' [[
29 __--restore__ ''directory'' | __--list__ |
30 __--Listall__ | __--purge__ | __--fetch__
31 ''dbname'' ... | __--delete__ ''dbname'' ... |
32 __--install__ ''file'' ... | __--merge__
33 ''file'' ... ] ...
34
35
36 (Note that some options are not shown above and short option
37 aliases are excluded for clarity)
38 !!DESCRIPTION
39
40
41 __pilot-xfer__ allows the user to install databases
42 contained in the standard .prc and .pdb formats onto a Palm,
43 retrieve databases from the Palm, list the databases
44 contained in a Palm, and backup or restore all of the
45 databases at once. Once the user has executed
2 perry 46 __pilot-xfer__ the user must invoke !HotSync on the target
1 perry 47 device.
48 !!TARGET DEVICE
49
50
51 The default serial device used to communicate with a Palm is
52 __/dev/pilot__. If the environment variable
53 __$PILOTPORT__ is set, its value will override the
54 default. A serial device specified on the command-line will
55 be used regardless of any __$PILOTPORT__
56 setting.
57 !!OPTIONS
58
59
60 Several options exist, including...
61
62
63 __-a__ ''dir''__,__
64
65
66 Archives files which have been removed from the Palm to
67 ''dir'' instead of just deleting (unlinking)
68 them
69
70
71 __-b__ ''dir''__, --backup__
72 ''dir''
73
74
75 Backs up the Palm into the specified directory (which will
76 be created if it does not already exist). This operation
77 must be specified ''after'' any __exclude__
78 option.
79
80
81 __-c --count__
82
83
84 Counts the files as they go by, but shunts the displaying of
85 the
86
87
88 __-d__ ''dbname'' __[[...], --delete__ ''dbname''
89 __[[...]__
90
91
92 Delete the specified database(s) by name (without
93 extension). Obviously, be very careful with this
94 one.
95
96
97 __-e__ ''file''__, --exclude__
98 ''file''
99
100
101 Reads a list of databases from ''file''. Prevents
102 __--backup__, __--sync__, or __--update__ from
103 operating on the listed database(s). This option must be
104 specified before the __--backup__, __--sync__, or
105 __--update__ operation whose action it
106 modifies.
107
108
109 __-f__ ''dbname'' __[[...], --fetch__ ''dbname''
110 __[[...]__
111
112
113 Fetch each specified database out of the Palm into the
114 current directory.
115
116
117 __-F__
118
119
120 Modifies the behavior of __--backup__, __--sync__, and
121 __--update__ to back up non-OS databases which have been
122 stored in FlashROM
123
124
125 __-h, --help__
126
127
128 Displays a summary list of ''pilot-xfer'''s usage and
129 exits.
130
131
132 __-i__ ''file'' __[[...], --install__ ''file
133 [[...]''
134
135
136 Install each specified file into the Palm. Wildcards are
137 valid with this syntax.
138
139
140 __-l, --list__
141
142
143 List the databases in the Palm, excluding OS-specific
144 databases.
145
146
147 __-L, --Listall__
148
149
150 List all of the databases on the Palm, including OS-specific
151 native databases.
152
153
154 __-m__ ''file'' __[[...], --merge__ ''file''
155 __[[...]__
156
157
158 Adds the records in each specified file into the
159 corresponding Palm database.
160
161
162 __-O__
163
164
165 Modifies the behavior of __--backup__, __--sync__, and
166 __--update__ to back up OS databases which are stored in
167 FlashROM
168
169
170 __-p, --purge__
171
172
173 Purge any deleted data that hasn't been cleaned up by a sync
174 (this is a safe operation, and will prevent your Palm from
175 accumulating crud if you delete records but aren't syncing
176 with a PIM.) The only information you can lose is archived
177 but un-synced records.
178
179
180 __-q, --quiet__
181
182
183 Causes ''pilot-xfer'' to be quiet and not display the
184 ''
185
186
187 __-r__ ''dir''__, --restore__
188 ''dir''
189
190
191 Installs all files contained in a directory into the Palm.
192 (Use this to restore your Palm after a hard reset has
193 cleared its memory, using your __backup__ directory as a
194 baseline.)
195
196
197 __-s__ ''dir''__, --sync__ ''dir''
198
199
200 Backs up the Palm into the specified directory (which will
201 be created if it does not already exist). Any Palm databases
202 which have not been modified or created since the versions
203 stored in the specified directory will not be backed
204 up.
205
206
207 __NOTE:__ Any Palm databases which have been deleted will
208 have their corresponding backup file removed. This operation
209 must be specified ''after'' any __exclude__
210 option.
211
212
213 __-u__ ''dir''__, --update__
214 ''dir''
215
216
217 Backs up the Palm into the specified directory (which will
218 be created if it does not already exist). Any Palm databases
219 which have not been modified or created since the versions
220 stored in the specified directory will not be backed up.
221 This operation must be specified ''after'' any
222 __exclude__ option.
223
224
225 __-U__
226
227
2 perry 228 This will back up the !UnsavedPreferences.pdb file from the
1 perry 229 Palm. Normally this file is not backed up by normal means
230 (Palm Computing recommends that you do __not__ restore
231 this file upon restoration of your device using
232 __--restore__
233
234
235 This also modifies the behavior of __--backup --sync__
236 and __--update__
237
238
239 __-v, --version__
240
241
242 Displays the version of ''pilot-link'' from which this
243 program was installed and exits.
244 !!USAGE
245
246
247 The program will connect to a target device and port, prompt
2 perry 248 the user to !HotSync, and perform the requested database
1 perry 249 options specified by the user.
250 !!EXAMPLES
251
252
253 To backup a Palm:
254
255
256 pilot-xfer --backup /home/pilot/Backup
257
258
259 or
260
261
262 pilot-xfer -p /dev/irnine -b /home/pilot/Backup
263
264
265 To restore that backup to a non-standard serial port (for
266 example, to a xcopilot or POSE session, assuming you have
267 xcopilot or POSE configured properly for this operation, see
268 the appropriate man pages for details on configuring your
269 emulator):
270
271
272 pilot-xfer -p /dev/ttyqe --restore
273 /home/pilot/Backup
274 !!SEE ALSO
275
276
277 __pilot-link(7)__.
278 !!AUTHOR
279
280
281 __pilot-xfer__ written by Kenneth Albanowski. This manual
282 page was originally written by Kenneth Albanowski and David
283 H. Silber. Completely rewritten by David A. Desrosiers for
284 pilot-link 0.9.5.
285 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.