1
.\" -*- eval: (nroff-mode) -*-
7
.\" Like TP, but if specified indent is more than half
8
.\" the current line-length - indent, use the default indent.
10
.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
13
.TH GSMPB 8 "##DATE##" "gsmpb v##VERSION##"
15
gsmpb \- GSM mobile phone phonebook manipulation program
18
[ \fB-b\fP \fIbaudrate\fP ]
19
[ \fB--baudrate\fP \fIbaudrate\fP ]
22
[ \fB-d\fP \fIdestination device or file\fP ]
23
[ \fB--destination\fP \fIdestination device or file\fP ]
28
[ \fB-I\fP \fIinit string\fP ]
29
[ \fB--init\fP \fIinit string\fP ]
30
[ \fB-p\fP \fIphonebook name\fP ]
31
[ \fB--phonebook\fP \fIphonebook name\fP ]
32
[ \fB-s\fP \fIsource device or file\fP ]
33
[ \fB--source\fP \fIsource device or file\fP ]
34
[ \fB-t\fP \fIcharacter set\fP ]
35
[ \fB--charset\fP \fIcharacter set\fP ]
43
[ \fB--synchronize\fP ]
46
\fIgsmpb\fP can store or retrieve phonebook entries residing in a GSM
47
mobile phone's phonebook to or from a file. A synchronization mode is
50
\fIgsmpb\fP reads entries from the source which can be a mobile phone
51
(if a serial device file is given) or a file (if a file name is
52
given). The source is never modified. \fIgsmpb\fP writes phonebook
53
entries to a destination file or device. Depending on the mode the
54
source is copied to the destination file, thus overwriting the
55
destination, or the destination is synchronized with regard to the
56
source which is the default (details see below).
58
If "-" is given as the parameter for the \fB--source\fP or
59
\fB--destination\fP options, the phonebook is read from standard input
60
and/or written to standard output, respectively.
62
Phonebook entries names are encoded using the GSM default alphabet in
63
the mobile phone, whereas they are stored using the Latin-1 encoding
64
in phonebook files. When reading phonebook entries from a mobile phone
65
entry names are converted from the GSM default to Latin-1. Characters
66
that can not be converted to Latin-1 are encoded as character code
67
172 (Latin-1 boolean "not"). When writing file-based phonebook entries
68
to a mobile phone a conversion to the GSM default alphabet takes
69
place. Characters that can not be converted are encoded as GSM delta
70
(code 16). If the default character set has been changed using the
71
\fB--charset\fP option no conversion takes place.
73
Error messages are printed to the standard error output. If the program
74
terminates on error the error code 1 is returned.
78
\fB-b\fP \fIbaudrate\fP, \fB--baudrate\fP \fIbaudrate\fP
79
The baud rate to use. The default baudrate is 38400.
81
\fB-c\fP, \fB--copy\fP
82
This causes the contents of the source to be copied to the
83
destination. After this operation the destination has exactly the same
84
contents as the source.
86
\fB-d\fP \fIdestination\fP, \fB--destination\fP \fIdestination\fP
87
The destination device or file.
89
\fB-h\fP, \fB--help\fP
90
Prints an option summary.
92
\fB-I\fP \fIinit string\fP, \fB--init\fP \fIinit string\fP
93
Initialization string to send to the TA (default: "E0"). Note that the
94
sequence "ATZ" is sent first.
96
\fB-i\fP, \fB--index\fP
97
If the index position is given, \fIgsmpb\fP preserves the assignment
98
of entries to memory slots in the mobile phone's phonebook. This can
99
be used to backup phonebook entries with their position into a
100
phonebook file or to change the position of entries by editing a
101
phonebook file and writing them back to the mobile phone.
102
If this option is given the phonebook file used as the source
103
must contain indices for every entry. Additionally, these indices must
104
be unique, ie. it is not allowed to assign one entry twice to a
105
specific position in the mobile phone's phonebook.
107
\fB-p\fP \fIphonebook\fP, \fB--phonebook\fP \fIphonebook\fP
108
The name of the phonebook to read from or write to. This is only used
109
for device sources and destinations. Commonly available phonebooks
115
SIM fixdialling-phonebook
118
SIM last-dialling-phonebook
124
combined ME and SIM phonebook
134
\fB-s\fP \fIsource\fP, \fB--source\fP \fIsource\fP
135
The source device or file.
137
\fB-t\fP \fIcharacter set\fP, \fB--charset\fP \fIcharacter set\fP
138
Set the character set to use for phonebook operations (default is the
139
GSM default alphabet).
141
\fB-v\fP, \fB--version\fP
142
Prints the program version.
144
\fB-V\fP, \fB--verbose\fP
145
Prints out a detailed progress report.
147
\fB-X\fP, \fB--xonxoff\fP
148
Uses software handshaking (XON/XOFF) for accessing the device.
150
\fB-y\fP, \fB--synchronize\fP
151
This causes the contents of the source to be synchronized with the
152
destination (default). Synchronization in this context means:
157
If the source contains an entry with a name that does not exist in the
158
destination this entry is added to the destination.
161
If the source contains an entry with a name that can also be found in
162
the destination, the entry in the destination is overwritten (ie. the
163
telephone number is updated). Exception: More then one entry with the
164
name exists in the destination. In this case the new entry ist just added.
167
Entries in the destination that do not exist in the source are
170
Note that synchronization has the following properties that differ
171
from copying: This algorithm does not change the location of unchanged
172
entries in the destination phonebook. The synchronization function
173
is not case-sensitive when comparing names.
177
.SH PHONEBOOK FILE FORMAT
178
Phonebook entries are stored in phonebook files that are meant to be
179
human-readable and -editable. There is one phonebook entry per line,
180
and each line has the format:
183
index|text|phone number
186
The fields have the following meanings:
189
The index of the entry which must be a positive number. The index may
190
also be empty. Indices can be used in conjunction with the
191
\fB--index\fP option to store the entry into a specific position in
195
Descriptive text for the entry. The text may contain the special
196
characters '\\', '|', carriage return (ASCII code 13), or line feed
197
(ASCII code 10). These must be written "\\\\", "\\|", "\\r", "\\n",
198
respectively. The text should only contain characters that can be
199
encoded using the GSM default alphabet (see comments above).
202
Phone numbers can only contains the digits 0-9 and the '+' sign. A '+'
203
sign denotes an international number.
206
The following invocation of \fIgsmpb\fP synchronizes the mobile phone's
207
SIM phonebook with the file $HOME/.phonebook:
210
gsmpb --synchronize -b 19200 -d /dev/mobilephone \\
211
-s $HOME/.phonebook -p "SM"
215
Peter Hofmann <software@pxh.de>
218
Report bugs to software@pxh.de. Include a complete, self-contained
219
example that will allow the bug to be reproduced, and say which
220
version of \fIgsmpb\fP you are using.
223
Copyright \(co 1999 Peter Hofmann
225
\fIgsmpb\fP is free software; you can redistribute it and/or modify it under
226
the terms of the GNU Library General Public License as published by the Free
227
Software Foundation; either version 2, or (at your option) any later
230
\fIgsmpb\fP is distributed in the hope that it will be useful, but WITHOUT ANY
231
WARRANTY; without even the implied warranty of MERCHANTABILITY or
232
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
235
You should have received a copy of the GNU Library General Public License along
236
with \fIgsmpb\fP; see the file COPYING. If not, write to the Free Software
237
Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
added
removed
doc/gsmpb.man
