1gnokii(1)                           gnokii                           gnokii(1)
2
3
4

NAME

6       gnokii - modem/fax driver for the mobile phones
7

SYNOPSIS

9       gnokii [CONFIG OPTIONS] [OPTIONS]
10

DESCRIPTION

12       gnokii  is  a  multiple  systems  tool suite and (eventually) modem/fax
13       driver for the mobile phones.
14
15       gnokii at the beginning was designed to support the proprietary  proto‐
16       cols  of Nokia phones and at the moment it also supports phones and GSM
17       modems that understand AT commands, both from Nokia and from other ven‐
18       dors,  and  SIM  cards in PC/SC compatible Smart Card readers.  Limited
19       support for the older and slow Nokia MBUS protocol is also available.
20
21       You can assume that your phone is supported,  however  there  are  rare
22       cases  that you will get very limited functionality with gnokii. If you
23       have a fairly modern phone you should use the following  model  setting
24       in your config file:
25        - model = series40, if you have Nokia non-Symbian phone
26        -  model  =  gnapplet, if you have Nokia Symbian Series60 prior to 3rd
27       Edition phone
28        - model = AT, for all other
29        - if you have some older Nokia phone you may try using its brand name,
30       eg. for Nokia 6210 use model = 6210.
31
32       See  also  our <http://wiki.gnokii.org/index.php/Config> for configura‐
33       tions known to work.
34
35       Symbian series60 3rd edition (most Nokia n and e series) are  not  sup‐
36       ported  by  gnapplet  driver due to changes in Symbian API. For now you
37       can get some functionality using AT driver.
38
39       Please note that currently there are Nokia models with almost the  same
40       names  as  the  old ones, like 6110c vs 6110 or 3110c vs 3110. They are
41       completly incompatible. DO NOT use model = 6110 or model = 3110 setting
42       for them.
43
44

CONFIG OPTIONS

46       --config filename
47              reads    configuration   from   filename   instead   of   trying
48              $HOME/.gnokiirc first and /etc/gnokiirc last.
49
50       --phone name
51              usees parameters from the given phone  section  of  your  config
52              file. A phone section named 'foo' starts with [phone_foo] and is
53              used as --phone foo
54
55

OPTIONS

57       The options that are recognized by gnokii can be divided  into  several
58       different groups.
59
60
61   GENERAL
62       --help displays usage information.
63
64       --version
65              displays version and copyright information.
66
67       --monitor [delay|once]
68              continually  updates  phone  status  to  stderr.  Optional delay
69              parameter sets the refresh interval to delay seconds. Default is
70              1.  once means the output will be printed only once.
71
72       --shell
73              runs  interactive  session that will allow to run sequent gnokii
74              commands without a need to reconnect for the sequent commands.
75
76
77   DIALING
78       --getspeeddial location
79              reads speed dial from the specified location.
80
81       --setspeeddial number memory_type location
82              specify speed dial.  location number 1 is usually  reserved  for
83              voice mailbox number and it is unavailable as speed dial.
84
85       --dialvoice number
86              initiate  voice call.  On success print the callid identifier to
87              be used with the --hangup command.  The --monitor command can be
88              used to show the callid.
89
90       --senddtmf string
91              send DTMF sequence.
92
93       --answercall callid
94              answer  an incoming call.  callid is a small integer number used
95              to identify one of the incoming calls.   The  --monitor  command
96              can be used to show the callid.
97
98       --hangup callid
99              hangup  an incoming call or an already established call.  callid
100              is a small integer number used to identify one of  the  incoming
101              calls.   If  you initiated the call with --dialvoice this is the
102              number printed by that command.  The --monitor  command  can  be
103              used to show the callid.
104
105       --divert  {--op|-o} {register|enable|query|disable|erasure} {--type|-t}
106       {all|busy|noans|outofreach|notavail}  {--call|-c}  {all|voice|fax|data}
107       [{--timeout|-m} time_in_seconds] [{--number|-n} number]
108              Manage call diverting/forwarding.
109
110              --op specifies one of the operations: register enable query dis‐
111              able erasure
112
113              --type specifies one of the event types: busy  noans  outofreach
114              notavail unconditional all
115
116              --call specifies one of the call types: voice fax data all
117
118              --timeout  is  the  number of seconds an incoming call will ring
119              before being forwarded to the registered number (use with --type
120              noans)
121
122              --number is the phone number to which calls are to be forwarded
123
124
125   PHONE SETTINGS
126       --getdisplaystatus
127              shows what icons are displayed.
128
129       --displayoutput
130              show texts displayed in phone's screen.
131
132       --getprofile [number]
133              show settings for selected(all) profile(s).
134
135       --setprofile
136              sets settings for selected(all) profile(s).
137
138       --getactiveprofile
139              reads the active profile.
140
141       --setactiveprofile profile_no
142              sets active profile to the profile number profile_no.
143
144       --netmonitor {reset|off|field|devel|next|nr}
145              setting/querying netmonitor mode.
146
147       --reset [soft|hard]
148              resets the phone.
149
150
151   TODO
152       --gettodo start_number [end_number|end] [-v|--vCal]
153              get  the notes with numbers from start_number to end_number from
154              ToDo list.  end is a keyword that denotes 'everything  till  the
155              end'.
156
157
158       -v - output in vCalendar 1.0 format
159
160       --writetodo vCalendarfile start_number [end_number|end]
161              write  the  notes  with  numbers from start_number to end_number
162              from vCal file vcalfile to ToDo list.  More than one note a time
163              can  be  saved.   end is a keyword that denotes 'everything till
164              the end'.
165
166       number - location of the note in the vCalendar file
167
168       --deletealltodos
169              delete all notes from the ToDo list.
170
171
172   CALENDAR
173       --getcalendarnote start_number [end_number|end] [-v|--vCal]
174              get the notes with numbers from start_number to end_number  from
175              calendar.   end  is  a keyword that denotes 'everything till the
176              end'.
177
178       -v - output in vCalendar 1.0 format
179
180       --writecalendarnote vcalfile start_number [end_number|end]
181              write the notes with numbers  from  start_number  to  end_number
182              from vCal file vcalfile to a phone calendar.  More than one note
183              a time can be saved.  end is a keyword that denotes  'everything
184              till the end'.
185
186       number - location of the note in the vCalendar file
187
188       --deletecalendarnote start_number [end_number|end]
189              delete  the  notes  with numbers from start_number to end_number
190              from calendar. end is a keyword that  denotes  'everything  till
191              the end'.
192
193
194   SMS
195       --getsms  memory_type  start  [end]  [-f|--file  file] [-F|--force-file
196       file] [-a|--append-file file] [-d|--delete]
197              gets SMS messages from specified memory type starting  at  entry
198              start  and  ending at end.  For the memory types you usually use
199              SM for the SIM card and ME for the phone memory (or MT for mixed
200              phone  and  SIM  memory, which preferred type for modern Motoro‐
201              las). The exception are the phones supported  by  nk7110  (Nokia
202              7110/6210/6250)  and  nk6510 (Nokia 6310/6510/8310) drivers. For
203              these you should use IN for the Inbox, OU for the Outbox, AR for
204              the  Archive,  TE for the Templates and F1, F2, ... for your own
205              folders.  Use the --showsmsfolderstatus command to get a list of
206              memory  types  available  in your phone.  end can be a number or
207              the string 'end'.  If end is not specified only one  location  -
208              start is read.  Messages are printed to stdout. Additionally, if
209              --file file is used, messages are saved in file in mbox  format.
210              If  file  already  exists, user is prompted whether to overwrite
211              it. If --force-file file is  used  gnokii  overwrites  the  file
212              without  asking.  If  --append-file  file  is  used messages are
213              appended to the file.  If --delete switch is used,  the  message
214              is deleted after reading.
215
216       --deletesms memory_type start [end]
217              deletes  SMS  messages  from  specified  memory type starting at
218              entry start and ending at end.  If end is not specified only one
219              location - start is deleted.
220
221       --sendsms  destination  [--smsc  message_center_number  | --smscno mes‐
222       sage_center_index]    [-r|--report]    [-8|--8bit]    [-C|--class    n]
223       [-v|--validity   n]   [-l|--long   n]   [-i|--imelody]  [-a|--animation
224       file;file;file;file] [-o|--concat this;total;serial] [-w|--wappush url]
225              sends an SMS message to destination via message_center_number or
226              SMSC  number  taken  from phone memory from address message_cen‐
227              ter_index.  If this argument is omitted  SMSC  number  is  taken
228              from  phone  memory from location 1.  Message text is taken from
229              STDIN.  Meaning of other optional parameters:
230
231       -r | --report - request for delivery report
232
233       -8 | --8bit - set 8bit coding
234
235       -C | --class n - Class Message n, where n can be 0..3
236
237       -v | --validity n - validity in minutes
238
239       -l | --long n - send no more then n characters, default is 160
240
241       -i | --imelody - send iMelody within SMS
242
243       -a | --animation file;file;file;file - send animation message
244
245       -o | --concat this;total;serial - send this part  of  all  total  parts
246       identified by serial
247
248       -w | --wappush url - send wappush to the given url
249
250       Sample usage:
251              echo "This is a test message" | gnokii --sendsms +48501123456 -r
252
253
254       --savesms [--sender from] [--smsc message_center_number | --smscno mes‐
255       sage_center_index] [--folder folder_id] [--location number]  [--sent  |
256       --read] [--deliver] [--datetime YYMMDDHHMMSS]
257              saves  SMS  messages to phone. Messages are read from STDIN. You
258              can specify the following optional arguments:
259
260       --sender - set the sender number (only --deliver)
261
262       --smsc message_center_number - set the SMSC number (only --deliver)
263
264       --smscno message_center_index - SMSC number  taken  from  phone  memory
265       from address message_center_index (only --deliver)
266
267       --folder folder_id - folder ID where to save the SMS to (only valid for
268       newer phones, i.e. 6210/6510 series). For legal values see --getsms.
269
270       --location number - save the message to location number
271
272       --sent | --read - mark the message saved/read depending on --deliver
273
274       --deliver - set the message type to SMS_Deliver
275
276       --datetime YYMMDDHHMMSS - sets datetime of delivery, i.e.  031123185713
277       would set message delivery time to 23rd November 2003, 6:57:13 PM
278
279
280       --getsmsc [start_number [end_number]] [-r|--raw]
281              show  the  SMSC parameters from specified location(s) or for all
282              locations.
283
284
285       --setsmsc
286              set SMSC  parameters  read  from  STDIN.  See  --raw  output  of
287              --getsmsc for syntax.
288
289
290       --createsmsfolder name
291              create SMS folder with name name.
292
293
294       --deletesmsfolder number
295              delete folder # number of 'My Folders'.
296
297
298       --showsmsfolderstatus
299              list SMS folder names with memory types and total number of mes‐
300              sages available.
301
302
303       --smsreader
304              keeps reading incoming SMS and saves them into the mailbox.
305
306
307   MMS
308       --getmms memory_type start [end] [{--pdu|--raw} file] [-o|--overwrite]
309              gets MMS messages from specified memory type starting  at  entry
310              start  and  ending at end.  Default output format is human read‐
311              able, alternative output formats are --pdu which is  the  binary
312              format  of  MMS  as  received  by the phone from the network and
313              --raw which saves the data as read from the phone.
314
315       When the -o or --overwrite option is used, existing files are overwrit‐
316       ten without asking.
317
318   LOGOS
319       --sendlogo {caller|op|picture} destination logofile [network_code]
320              send the logofile to destination as operator or CLI logo.
321
322       --setlogo op [logofile [network_code]]
323
324       --setlogo startup [logofile]
325
326       --setlogo caller [logofile [caller_group_number [group_name]]]
327              set or clear operator, startup or caller logo.
328
329       --setlogo {dealer|text} [text]
330              set or clear welcome note.
331
332       --getlogo op [logofile [network_code]]
333
334       --getlogo startup [logofile [network_code]]
335
336       --getlogo caller [caller_group_number [logofile [network_code]]]
337              get operator, startup or caller logo.
338
339       --getlogo {dealer|text}
340              get welcome note.
341
342       --viewlogo logofile
343              print the logofile as ASCII art.  Formats that are automatically
344              detected are: NOL, NGG, NSM, NLM, BMP, I61, GGP,  XPM.  The  OTA
345              format  can  be  used  only  if  the filename ends with the .otb
346              extension.
347
348       Format of network_code parameter is 3 digits MCC, a space, 2 digits MNC
349       surrounded by single or double quotes, eg. "123 45".
350
351
352   RINGTONES
353       --sendringtone destination rtttlfile
354              send the rtttlfile to destination as ringtone.
355
356       --setringtone rtttlfile
357              set the rtttlfile as ringtone (on 6110).
358
359
360   PHONEBOOK
361       --getphonebook      memory_type      start_number      [end_number|end]
362       [[-r|--raw]|[-v|--vcard]|[-l|--ldif]]
363              reads specified memory location from phone.   If  end_number  is
364              not  specified only one location - start is read.  If instead of
365              end_number the text end is specified then gnokii will read  from
366              start_number until it encounters a non-existant location.  Valid
367              memory types are: ME, SM, FD, ON, EN, DC, RC, MC, LD:
368
369              ME Internal memory of the mobile equipment
370
371              SM SIM card memory
372
373              FD Fixed dial numbers
374
375              ON Own numbers
376
377              EN Emergency numbers
378
379              DC Dialled numbers
380
381              RC Received calls
382
383              MC Missed calls
384
385              LD Last dialed numbers
386
387       Normally you get verbose output.  You can use -v or --vcard  switch  to
388       get output in vCard format or -l or --ldif switch to get output in ldif
389       format or -r or --raw switch to get the raw output which  is  explained
390       below.  You can use it then with --writephonebook.
391
392       --writephonebook    [-o|--overwrite]   [-f|--find-free]   [-m|--memory-
393       type|--memory  memory_type]  [-n|--memory-location|--location   number]
394       [[-v|--vcard]|[-l|--ldif]]
395              reads  data  from  stdin and writes to phonebook.  Uses the same
396              format as provided by the output of  the  getphonebook  command.
397              Default is raw format (see below for details) and alternate for‐
398              mats are vCard and ldif.
399
400       With --memory-type memory_type and --memory-location number you can set
401       a memory type and a location if the input data doesn't specify them.
402
403       When  the -o or --overwrite option is used, existing entries at a given
404       location are overwritten.
405
406       When the -f or --find-free option is given, gnokii tries to find a free
407       location.   In  this case, you can omit the location field in the input
408       data.
409
410       The raw phonebook format is very  simple.   Each  line  represents  one
411       entry.   Fields are separated by semicolons.  Semicolons aren't allowed
412       inside a field.  The fields have to be in this  order  (the  subentries
413       are optional, ie. you can repeat all subentry field multiple times, but
414       they have to be alltogether in the given order):
415
416            name
417
418            number
419
420            memory_type
421
422            entry_location
423
424            caller_group_number
425
426            subentry_type
427
428            subentry_number_type
429
430            subentry_id
431
432            subentry_text
433
434       Possible values of caller_group_number  and  the  corresponding  caller
435       groups  are  (these are defaults, you are able to change these manually
436       in your phone):
437
438              0 Family
439
440              1 VIP
441
442              2 Friends
443
444              3 Colleagues
445
446              4 Other
447
448              5 No group
449
450       Possible subentry types are described in the gnokii/common.h file:
451
452              7 subentry is the name
453
454              8 subentry is the email address
455
456              9 subentry is the postal address (snail mail)
457
458              10 subentry is the note (text field)
459
460              11 subentry is the number
461
462              12 subentry is the ringtone
463
464              19 subentry is the date
465
466              26 subentry is the pointer
467
468              27 subentry is the logo
469
470              28 subentry is the logo switch
471
472              30 subentry is the group
473
474              44 subentry is the URL
475
476       Possible subentry number types are  described  in  the  gnokii/common.h
477       file:
478
479              2 number is the home phone number
480
481              3 number is the mobile phone number
482
483              4 number is the fax number
484
485              6 number is the work phone number
486
487              10 number is the general number
488
489       For  the  subentry  types  that  don't  care about number type (as text
490       files) this should be set to 0.
491
492       --deletephonebook memory_type start_number [end_number|end]
493              delete entries with start_number to end_number  from  the  phone
494              book  in  memory_type. end is a keyword that denotes 'everything
495              till the end'.
496
497
498   WAP
499       --getwapbookmark number
500              reads the specified WAP bookmark from phone
501
502       --writewapbookmark name URL
503              write WAP bookmark to phone
504
505       --deletewapbookmark number
506              delete WAP bookmark from phone
507
508       --getwapsetting number [-r|--raw]
509              read WAP setting from phone
510
511       --writewapsetting
512              reads data from stdin and writes it to phone.  Hint: see  syntax
513              from --getwapsetting -r option
514
515       --activatewapsetting number
516              activate WAP setting number
517
518
519
520   DATE, TIME AND ALARM
521       --setdatetime [YYYY [MM [DD [HH [MM]]]]]
522              set the date and the time of the phone.
523
524       --getdatetime
525              shows current date and time in the phone.
526
527       --setalarm HH MM
528              set the alarm of the phone.
529
530       --getalarm
531              shows current alarm.
532
533
534   SECURITY
535       --identify
536              get manufacturer, IMEI, model and revision.
537
538       --entersecuritycode {PIN|PIN2|PUK|PUK2|SEC}
539              asks for the code and sends it to the phone.
540
541       --getsecuritycode
542              shows the currently set security code.
543
544       --getsecuritycodestatus
545              show if a security code is needed.
546
547       --getlocksinfo
548              show  information  about  the  (sim)locks of the phone: the lock
549              data, whether a lock is open or closed, whether it is a user  or
550              factory lock and the number of unlock attempts.
551
552
553   FILE
554       Note  that  some phones (like Nokia 6610i) support only id based opera‐
555       tions (gnokii options with "byid" suffix). Use gnokiifs for the  trans‐
556       parent support.
557
558       --getfilelist remote_path
559              lists  files  from  the given directory. Use A:\* or B:\* to get
560              the root directory from either phone memory or card memory.
561
562       --getfiledetailsbyid [id]
563              lists file details or directory contents from the entry  identi‐
564              fied  by id.  If no identifier is given, list the root directory
565              contents.
566
567       --getfileid remote_filename
568              gets id of the file.
569
570       --getfile remote_filename [local_filename]
571              gets file identified by name and path from the phone and  stores
572              it at the local computer.
573
574       --getfilebyid id [local_filename]
575              gets  file  identified by id from the phone and stores it at the
576              local computer.
577
578       --getallfiles remote_path
579              gets all files from the remote path.
580
581       --putfile local_filename remote_filename
582              stores the file in the phone memory or on the memory card.
583
584       --deletefile remote_filename
585              removes the file from the phone.
586
587       --deletefilebyid id
588              removes the file from the phone.
589
590
591   MISC
592       --keysequence
593              emulates pressing keys on phone keyboard.  Input  is  read  from
594              stdin.
595
596              Supported keys (any other char is ignored):
597
598                   M menu
599
600                   N names
601
602                   P power
603
604                   G green phone
605
606                   R red phone
607
608                   U up
609
610                   D down
611
612                   + increase volume
613
614                   - decrease volume
615
616                   0123456789#* as is
617
618              Example: to increase volume
619
620                echo "+" | gnokii --keysequence
621
622              Note: this command isn't supported by all phones/drivers.
623
624
625       --enterchar
626              emulates  typing  a  character  on phone keyboard.  By emulating
627              multiple pressions of keys, it can  input  all  characters  sup‐
628              ported  by the phone in use, but to input an SMS predictive text
629              should be disabled.  Input is  read  from  stdin,  with  newline
630              interpreted  as  the  "Menu"  key  and escape interpreted as the
631              "Names" key.
632
633              Note: this command isn't supported by all phones/drivers.
634
635
636       --listnetworks
637              prints a list of cellular network operators with their  3-digits
638              MCC  (Mobile  country  code)  and  2-digits  MNC (Mobile Network
639              Code).
640
641              Note: this command doesn't need a valid .gnokiirc or a phone  to
642              work.
643
644
645       --getnetworkinfo
646              prints information about the network currently in use.
647
648

DIAGNOSTICS

650       Various error messages are printed to standard error.  The exit code is
651       0 for correct functioning.  Errors which appear to be caused by invalid
652       or  abused  command  line parameters cause an exit code of 2, and other
653       errors cause an exit code of 1.
654
655

BUGS

657       We write quality software here ;) but see KNOWN_BUGS just in  case.  If
658       you'd  like  to  send  us the bugreport please read the README and Bugs
659       files.
660
661

AUTHOR

663       Hugh Blemings <hugh at blemings dot org>, Pavel Janik ml.  <Pavel.Janik
664       at suse dot cz> and Pawel Kot <gnokii at gmail dot com>.
665
666       Manual  page  written  by  Dag  Wieers  <dag at mind dot be>, Pawel Kot
667       <gnokii at gmail dot com> and Daniele Forsi <daniele at forsi dot it>.
668
669       See also Docs/CREDITS from gnokii sources.
670
671

COPYING

673       This program is distributed under the GNU Public License Version 2,  or
674       (at your option) any later version.
675
676

SEE ALSO

678       gnokiid, xgnokii, mgnokiidev, ppm2nokia, sendsms, todologo
679
680
681
682Dag Wieers, Pawel Kot            Sep 29, 2008                        gnokii(1)
Impressum