:pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Sun Nov 25 22:56 CET 2001
[gnokii.git] / Docs / man / gnokii.1
1 .TH "gnokii" "1" "July 15, 2000" "" "Gnokii"
2 .SH "NAME"
3 gnokii \- modem/fax driver for Nokia mobile phones
4 .SH "SYNOPSIS"
5 .B gnokii
6 \fIOPTION\fR [\fIARGUMENT\fR]...
7 .SH "DESCRIPTION"
8 .PP 
9 .B gnokii
10 is a Linux/Unix tool suite and (eventually) modem/fax driver for Nokia mobile phones, released under the GPL.
11 .PP 
12 .B gnokii
13 supports most phones from the 3810/8110 and 5110/6110 series, details including bugs specific to each series appear in the files Docs/README\-3810 and Docs/README\-6110 respectively.  
14
15 .SH "OPTIONS"
16 The options that are recognized by
17 .B gnokii
18 can be divided into several different groups.
19
20 .SS GENERAL
21 .TP 
22 .BR "\-\-help"
23 display usage information.
24 .TP 
25 .BR "\-\-version"
26 displays version and copyright information.
27 .TP 
28 .BR "\-\-monitor"
29 continually updates phone status to stderr.
30
31 .SS DIALING
32 .TP 
33 .BR "\-\-getspeeddial \fIn\fP"
34 reads speed dial from the specified location.
35 .TP 
36 .BR "\-\-setspeeddial \fInumber\fP \fImemory_type\fP \fIlocation\fP"
37 specify speed dial.
38 .TP 
39 .BR "\-\-dialvoice \fInumber\fP"
40 initiate voice call.
41 .TP 
42 .BR "\-\-senddtmf \fIstring\fP"
43 send DTMF sequence.
44
45 .SS PHONE SETTINGS
46 .TP 
47 .BR "\-\-getdisplaystatus"
48 shows what icons are displayed.
49 .TP 
50 .BR "\-\-displayoutput"
51 show texts displayed in phone's screen.
52 .TP 
53 .BR "\-\-getprofile [\fInumber\fP]"
54 show settings for selected(all) profile(s).
55 .TP 
56 .BR "\-\-netmonitor {\fIreset\fP|\fIoff\fP|\fIfield\fP|\fIdevel\fP|\fInext\fP|\fInr\fP}"
57 setting/querying netmonitor mode.
58 .TP 
59 .BR "\-\-reset [\fIsoft\fP|\fIhard\fP]"
60 resets the phone.
61
62 .SS CALENDAR
63 .TP 
64 .BR "\-\-getcalendarnote \fIstart\fP [\fIsend\fP] [\-v]"
65 get the note with numbers from \fIstart\fR to \fIend\fR from calendar.
66 .PP 
67 [\-v] \- output in vCalendar 1.0 format
68 .TP 
69 .BR "\-\-writecalendarnote"
70 write the note to calendar.
71 .TP 
72 .BR "\-\-deletecalendarnote \fIstart\fP [\fIend\fP]"
73 delete the note with numbers from \fIstart\fR to \fIend\fR from calendar.
74
75 .SS SMS
76 .TP 
77 .BR "\-\-getsms \fImemory_type\fR \fIstart\fP [\fIend\fP] [\-f \fIfile\fP] [\-d]"
78 gets SMS messages from specified \fImemory type\fR starting at entry [\fIstart\fR] and ending at [\fIend\fR].
79 If [\fIend\fR] is not specified only one location \- [\fIstart\fR] is read.
80 If [\-f \fIfile\fR] is used entries are saved in \fIfile\fR.
81 Otherwise they are dumped to stdout.
82 If [\-d] switch is used, a message is deleted after reading.
83 .TP 
84 .BR "\-\-deletesms \fImemory_type\fP \fIstart\fP [\fIend\fP]"
85 deletes SMS messages from specified \fImemory type\fR starting at entry [\fIstart\fR] and ending at [\fIend\fR].
86 If [\fIend\fI] is not specified only one location \- [\fIstart\fR] is read.
87 .TP 
88 .BR "\-\-sendsms \fIdestination\fP [\-\-smsc \fImessage_center_number\fP | \-\-smscno \fImessage_center_index\fP] [\-r] [\-C \fIn\fP] [\-v \fIn\fP] [\-\-long \fIn\fP]"
89 sends an SMS message to \fIdestination\fR via \fImessage_center_number\fR or SMSC number taken from phone memory from address \fImessage_center_index\fR.
90 If this argument is ommited SMSC number is taken from phone memory from location 1.
91 Message text is taken from STDIN.
92 This function has had limited testing and may not work at all on your network.
93 Meaning of other optional parameters:
94 .PP 
95 [\-r] \- request for delivery report
96 .PP 
97 [\-C \fIn\fR] \- Class Message \fIn\fR, where \fIn\fR can be 0..3
98 .PP 
99 [\-v \fIn\fR] \- validity in minutes
100 .PP 
101 [\-\-long \fIn\fR] \- send no more then \fIn\fR characters, default is 160
102 .TP 
103 .BR "\-\-savesms [\-m] [\-l \fIn\fP] [\-i]"
104 saves SMS messages to the Outbox. Messages are read from STDIN. You can specify the following optional arguments:
105 .PP 
106 [\-m] \- mark the message as sent
107 [\-l \fIn\fR] \- save the message at location \fIn\fR on the SIM card
108 [\-i] \- ask before overwriting specified location
109 .TP 
110 .BR "\-\-getsmsc \fInumber\fP"
111 show the SMSC number from location \fInumber\fR.
112
113 .SS LOGOS
114 .TP 
115 .BR "\-\-sendlogo {\fIcaller\fP|\fIop\fP} \fIdestination\fP \fIlogofile\fP [\fInetwork_code\fP]"
116 send the \fIlogofile\fR to \fIdestination\fR as operator or CLI logo.
117 .TP 
118 .BR "\-\-setlogo \fIlogofile\fP [\fInetwork_code\fP]"
119 .TP 
120 .BR "\-\-setlogo \fIlogofile\fP [\fIcaller_group_number\fP] [\fIgroup_name\fP]"
121 .TP 
122 .BR "\-\-setlogo \fItext\fP [\fIstartup_text\fP]"
123 .TP 
124 .BR "\-\-setlogo \fIdealer\fP [\fIdealer_startup_text\fP]"
125 set caller, startup or operator logo.
126 .TP 
127 .BR "\-\-getlogo \fIlogofile\fP {\fIcaller\fP|\fIop\fP|\fIstartup\fP} [\fIcaller_group_number\fP]"
128 get caller, startup or operator logo.
129
130 .SS RINGTONES
131 .TP 
132 .BR "\-\-sendringtone \fIdestination\fI \fIrtttlfile\fP"
133 send the \fIrtttlfile\fR to \fIdestination\fR as ringtone.
134 .TP 
135 .BR "\-\-setringtone \fIrtttlfile\fP"
136 set the \fIrtttlfile\fR as ringtone (on 6110).
137
138 .SS PHONEBOOK
139 .TP 
140 .BR "\-\-getmemory \fImemory_type\fP \fIstart\fP [\fIend\fP]"
141 reads specificed memory location from phone.
142 If [\fIend\fR] is not specified only one location \- [\fIstart\fR] is read.
143 Valid \fImemory types\fR are: ME, SM, FD, ON, EN, DC, RC, MC, LD.
144 .TP 
145 .BR "\-\-writephonebook [\-i]"
146 reads data from stdin and writes to phonebook
147 When \-i option is used, refuses to overwrite existing entries.
148 Uses the same format as provided by the output of the getphonebook command.
149
150 .SS DATE, TIME AND ALARM
151 .TP 
152 .BR "\-\-setdatetime [\fIYYY\fP [\fIMM\fP [\fIDD\fP [\fIHH\fP [\fIMM\fP]]]]]"
153 set the date and the time of the phone.
154 .TP 
155 .BR "\-\-getdatetime"
156 shows current date and time in the phone.
157 .TP 
158 .BR "\-\-setalarm \fIHH\fP \fIMM\fP"
159 set the alarm of the phone.
160 .TP 
161 .BR "\-\-getalarm"
162 shows current alarm.
163
164 .SS SECURITY
165 .TP 
166 .BR "\-\-identify"
167 get IMEI, model and revision.
168 .TP 
169 .BR "\-\-entersecuritycode {\fIPIN\fP|\fIPIN2\fP|\fIPUK\fP|\fIPUK2\fP}"
170 asks for the code and sends it to the phone.
171 .TP 
172 .BR "\-\-getsecuritycodestatus"
173 show if a security code is needed.
174
175 .SH "DIAGNOSTICS"
176 Various error messages are printed to standard error.  The exit code
177 is 0 for correct functioning.  Errors which appear to be caused by
178 invalid or abused command line parameters cause an exit code of 2, and
179 other errors cause an exit code of 1.
180
181 .SH "BUGS"
182 .PP 
183 We write quality software here ;)
184
185 .SH "AUTHOR"
186 Hugh Blemings <hugh@blemings.org> and Pavel Janik ml. <Pavel.Janik@suse.cz>
187
188 Manual page written by Dag Wieers <dag@mind.be> and Pawel Kot <pkot@linuxnews.pl>
189
190 See also Docs/CREDITS from Gnokii sources.
191
192 .SH "COPYING"
193 This program is distributed under the GNU Public License.
194
195 .SH "SEE ALSO"
196 gnokiid, xgnokii