1Directory structure
2===================
3
4libgammu directory
5------------------
6
7This directory contains sources of Gammu library. You can find all phone
8communication and data encoding functionality here.
9
10There are following subdirectories:
11
12``device``
13  drivers for devices such serial ports or irda
14``device/serial``
15  drivers for serial ports
16``device/irda``
17  drivers for infrared over sockets
18``protocol``
19  protocol drivers
20``protocol/nokia``
21  Nokia specific protocols
22``phone``
23  phone modules
24``phone/nokia``
25  modules for different Nokia phones
26``misc``
27  different services. They can be used for any project
28``service``
29  different gsm services for logos, ringtones, etc.
30
31gammu directory
32---------------
33
34Sources of Gammu command line utility. It contains interface to libGammu
35and some additional functionality as well.
36
37smsd directory
38--------------
39
40Sources of SMS Daemon as well as all it's service backends.
41
42The ``services`` subdirectory contains source code for :ref:`smsd_services`.
43
44helper directory
45----------------
46
47These are some helper functions used either as replacement for
48functionality missing on some platforms (eg. strptime) or used in more
49places (message command line processing which is shared between SMSD and
50Gammu utility).
51
52docs directory
53--------------
54
55Documentation for both end users and developers as well as SQL scripts
56for creating SMSD database.
57
58``config``
59    configuration file samples
60``examples``
61    examples using libGammu
62``manual``
63    sources of The Gammu Manual which you are reading
64``sql``
65    SQL scripts to create table structures for :ref:`smsd`
66``user``
67    user documentation like man pages
68
69admin directory
70---------------
71
72Administrative scripts for updating locales, making release etc.
73
74cmake directory
75---------------
76
77CMake include files and templates for generated files.
78
79include directory
80-----------------
81
82Public headers for libGammu.
83
84locale directory
85----------------
86
87Gettext po files for translating Gammu, libGammu and user documentation.
88See :doc:`localization` for more information.
89
90tests directory
91---------------
92
93CTest based test suite for libGammu.
94See :doc:`testing` for more information.
95
96utils directory
97---------------
98
99Various utilities usable with Gammu.
100
101contrib directory
102-----------------
103
104This directory contains various things which might be useful with Gammu.
105Most of them were contributed by Gammu users.
106
107.. note::
108
109    Please note that that code here might have different license terms than
110    Gammu itself.
111
112.. warning::
113
114    Most of scripts provided here are not actively maintained and might
115    be broken.
116
117bash-completion
118***************
119
120Completion script for bash.
121
122conversion
123**********
124
125Various scripts for converting data.
126
127init
128****
129
130Init scripts for Gammu SMSD.
131
132media
133*****
134
135Sample media files which can be used with Gammu.
136
137perl
138****
139
140Various perl scripts which interface to Gammu or SMSD.
141
142php
143***
144
145Various PHP frontends to SMSD or Gammu directly.
146
147sms
148***
149
150This directory contains SMS default alphabet saved in Unicode text file
151(:file:`charset.txt`) and table used for converting chars during saving
152SMS with default alphabet (:file:`convert.txt`).
153
154sms-gammu2android
155*****************
156
157Perl script to convert :ref:`gammu-smsbackup` into XML suitable for
158Android SMS Backup & Restore application.
159
160.. seealso:: http://blog.ginkel.com/2009/12/transferring-sms-from-nokia-to-android/
161
162smscgi
163******
164
165Simple cgi application gor handling SMS messages (a bit lighter version
166of SMSD).
167
168sql
169***
170
171Various SQL snippets and triggers useful with SMSD.
172
173testing
174*******
175
176Helper scripts for automatic testing or git bisect.
177
178sqlreply
179********
180
181System for automatic replying to SMS messages.
182
183symbian
184*******
185
186GNapplet sources and binaries. This comes from Gnokii project, but Gammu
187includes slightly modified version.
188
189s60
190***
191
192Series60 applet to use with recent Symbian phones.
193
194.. seealso:: :ref:`s60`
195
196win32
197*****
198
199Unsupported applications built on top of libGammu.dll on Windows.
200