File: pilot-addresses.1

package info (click to toggle)
pilot-link 0.12.5-dfsg-2
  • links: PTS
  • area: main
  • in suites: buster, stretch
  • size: 6,868 kB
  • ctags: 5,811
  • sloc: ansic: 53,153; sh: 10,459; java: 2,584; perl: 2,247; python: 1,044; makefile: 991; yacc: 662; cpp: 551; xml: 39
file content (211 lines) | stat: -rw-r--r-- 7,590 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "pilot-addresses" 1 "Copyright 1996-2007 FSF" "0.12.5" "PILOT-LINK"
.SH NAME
pilot-addresses \- Read and write address book databases to and from a Palm handheld.
.SH "SECTION"

.PP
pilot\-link: Userland conduits

.SH "LOCATION"

.PP
\&./src

.SH "SYNOPSIS"

.PP
 \fIpilot\-addresses\fR [\fB\-p\fR|\fB\-\-port\fR <\fBport\fR>] [\fB\-\-version\fR] [\fB\-?\fR|\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-delete\-all\fR] [\fB\-t\fR|\fB\-\-delimiter\fR  \fBINT\fR] [\fB\-d\fR|\fB\-\-delete\-category\fR  \fB category \fR ] [\fB\-c\fR|\fB\-\-category\fR  \fBcategory\fR] [\fB\-a\fR|\fB\-\-augment\fR] [\fB\-r\fR|\fB\-\-read\fR  \fIfile\fR] [\fB\-w\fR|\fB\-\-write\fR  \fI file \fR ] [\fB\-C\fR|\fB\-\-human\-readable\fR]

.SH "DESCRIPTION"

.PP
 \fIpilot\-addresses\fR allows the user to read all entries from a Palm handheld such as those made by \fIPalm\fR, \fIHandspring\fR, \fIHandera\fR, \fITRGPro\fR, \fISony\fR or other Palm handheld in the Palm Address Book application, write new entries into the database, and delete a category or delete all entries in the database\&.

.SH "COMMANDS"

.PP
Provide exactly one of \-\-read or \-\-write\&.

                    \fB\-r\fR,
                    \fB\-\-read\fR=<\fIfile\fR>
                
.PP
Reads records from <\fIfile\fR> and install them to the Palm Address Book application\&. (Use the \fB\-w\fR <\fIfile\fR> option to get a sample "template file" for input records to see how the fields are laid out)\&.

                    \fB\-w\fR, \-\-write=\fIfile\fR
                
.PP
Reads all address book records from the Palm Address Book application and writes them into \fI file \fR 

.SH "OPTIONS"

.SS "pilot-addresses options"

                        \fB\-a\fR, \fB\-\-augment\fR
                    
.PP
Augments fields in address book records with additional information\&. The augmented information is placed before and separated from the field with a semi\-colon, (;)\&.

.PP
Augmented information can include any of the following below\&.

.PP
 \fBcategory\fR # Placed in front of each record or\&.\&.

.PP
Placed in front of each phone number field:

.PP
["Work"|"Home"|"Fax"|"Other"|"E\-mail"|"Main"|"Pager"|"Mobile"]

.PP
Empty fields are not augmented\&.

                        \fB\-c\fR,
                        \fB\-\-category\fR=\fBcategory\fR
                    
.PP
Install records to category \fBcategory\fR by default\&. Normally \fIpilot\-addresses\fR uses the \fIUnfiled\fR category by default\&. This option is overridden by the category specified in the record with the \fB \-a \fR option\&.

                        \fB\-d\fR, \fB\-\-delete\-category\fR
                    
.PP
Delete all records in the specified category \fBcategory\fR before installing new records\&.

.PP
Note that the long name of this option has changed since 0\&.11\&.8

                        \fB\-D\fR, \fB\-\-delete\-all\fR
                    
.PP
Delete all address book records in all categories\&. Obviously, be \fIvery\fR careful with this one\&.

.PP
Note that the long name of this option has changed since 0\&.11\&.8

                        \fB\-t\fR,
                        \fB\-\-delimiter\fR \fBINT\fR
                    
.PP
Include category in each record, use the delimiter specified to separate all fields of a record\&. Delimiters are specified as follows: 3=tab, 2=;, 1=,\&. This overrides the default delimiter of comma between fields and semi\-colon between a field's augmented information\&. (Please note that this may generate confusing results when used with the \fB\-a\fR option\&.)

.PP
Note that the long name of this option has changed since 0\&.11\&.8

                        \fB\-T\fR, \fB\-\-titles\fR
                    
.PP
Obsolete\&. This option has been removed since 0\&.11\&.8

                        \fB\-C\fR|\fB\-\-human\-readable\fR
                    
.PP
Write generic human\-readable output instead of CSV\&.

.SS "Conduit Options"

                        \fB\-p\fR,
                        \fB\-\-port\fR <\fIport\fR>
                    
.PP
Use device file <\fIport\fR> to communicate with the Palm handheld\&. If this is not specified, \fIpilot\-addresses\fR will look for the \fI $PILOTPORT \fR environment variable\&. If neither are found or supplied, \fIpilot\-addresses\fR will print the usage information\&.

                        \fB\-q\fR, 
                        \fB\-\-quiet\fR
                    
.PP
Suppress 'Hit HotSync button' message

                        \fB\-v\fR, \fB\-\-version\fR
                    
.PP
Display version of \fIpilot\-addresses\fR and exit without connecting\&.

.SS "Help Options"

                        \fB\-h\fR, \fB\-\-help\fR
                    
.PP
Display the help synopsis for \fIpilot\-addresses\fR and exit without connecting\&.

                        \fB\-\-usage\fR 
                    
.PP
Display a brief usage message and exit without connecting\&.

.SH "USAGE"

.PP
The program will connect to the Palm handheld, and perform the requested read or write operation specified by the user\&.

.SH "EXAMPLES"

.PP
To write all address records in a Palm to the file addrbook\&.csv:

.PP
 \fIpilot\-addresses\fR  \fB\-w\fR  \fIaddrbook\&.csv\fR 

.PP
or

.PP
 \fIpilot\-addresses\fR  \fB\-p\fR  \fI/dev/pilot\fR  \fB\-w\fR  \fIaddrbook\&.csv\fR 

.PP
To read the address book records in the file addrbook\&.csv and install them onto the Palm:

.PP
 \fIpilot\-addresses\fR  \fB\-r\fR  \fIaddrbook\&.csv\fR 

.PP
To read the address book records in the file addrbook\&.csv and place them into the Palm address book database category \fISpecial\fR after first deleting all current records in the \fI Special \fR category on the palm:

.PP
 \fIpilot\-addresses\fR  \fB\-c\fR  \fBSpecial\fR  \fB\-d\fR  \fBSpecial\fR  \fB\-r\fR  \fIaddrbook\&.csv\fR 

.SH "AUTHOR"

.PP
 \fIpilot\-addresses\fR originally written by Kenneth Albanowski, this manual page was originally written by Robert Wittig <bob\&.wittig@gt\&.org> and later updated by David A\&. Desrosiers <hacker@gnu\-designs\&.com> and Neil Williams <linux@codehelp\&.co\&.uk>\&.

.SH "REPORTING BUGS"

.PP
We have an online bug tracker\&. Using this is the only way to ensure that your bugs are recorded and that we can track them until they are resolved or closed\&. Reporting bugs via email, while easy, is not very useful in terms of accountability\&. Please point your browser to http://bugs\&.pilot\-link\&.org: \fIhttp://bugs.pilot-link.org\fR and report your bugs and issues there\&.

.SH "COPYRIGHT"

.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.

.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.

.PP
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\&., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301, USA\&.

.SH "SEE ALSO"

.PP
\fIpilot\-link\fR(7)