File: README

package info (click to toggle)
sms-pl 2.1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 376 kB
  • ctags: 355
  • sloc: cpp: 2,618; perl: 109; makefile: 103; sh: 26
file content (248 lines) | stat: -rw-r--r-- 9,264 bytes parent folder | download
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

   #[1]author [2]home

                                      SMS

   SMS jest programem pozwalaj�cym na wysy�anie wiadomo�ci na telefony
   kom�rkowe operator�w polskich sieci kom�rkowych (Era, Plus, Orange,
   Heyah). Powinna dzia�a� tak�e obs�uga bramki angielskiego operatora O2

   Obecna wersje (2.x) s� kompletnym przepisaniem wersji poprzednich.
   Ca�o�� zosta�a napisana zupe�nie od nowa.

   Po d�ugim okresie braku aktywno�ci z mojej strony w rozw�j programu
   zaanga�owa�a si� nowa osoba: Adam Michalski [3]amichalski@gmail.com.


    Autor: Miko�aj Rydzewski [4]<miki@ceti.pl>

    1. [5]Licencja
    2. [6]Do czego ten program s�u�y?
    3. [7]Jak program dzia�a?
    4. [8]Jak go uzywac?
    5. [9]Instalacja i konfiguracja
    6. [10]Powiadamianie o nowej poczcie.
    7. [11]Wi�cej informacji
     _________________________________________________________________

Licencja.

   Program ten udost�pniony jest na zasadach licencji GPL v2, b�d�
   p�niejszej. Tre�� licencji dost�pna jest w pliku COPYING w archiwum z
   kodem programu, b�d� na stronie [12]http://www.gnu.org.
     _________________________________________________________________

Do czego ten program s�u�y?

   Pozwala on wysy�a� kr�tkie wiadomo�ci tekstowe (SMS) poprzez internet
   z komputera wprost na telefon kom�rkowy. Do wys�ania wiadomo�ci nie
   jest potrzebna interakcja z u�ytkownikiem, mo�e by� wi�c ona wys�ana w
   spos�b automatyczny. Typowe zastosowania programu to:
     * wysy�anie powiadomie� o nadej�ciu nowej poczty
     * wysy�anie komunikat�w przez serwisy www
     * wysy�anie komunikat�w dla administrator�w przez r�ne skrypty

   Z racji na u�ywanie (z regu�y) bezp�atnych bramek www->sms nie powinno
   si� uzale�nia� od dzia�ania programu istotnych aplikacji. Je�li
   uruchamia kto� powa�n� us�ug� wymagaj�c� wysy�ania sms�w, to z regu�y
   te� sta� go na wykupienie stosownego abonamentu i/lub modemu GSM.
     _________________________________________________________________

Jak program dzia�a?

   Nie zg��biaj�c si� w szczeg�y ;-) program udaje przegl�dark� www i
   wype�nia formularze na stronach odpowiednich operator�w. Po
   wype�nieniu takiego formularza 'wysy�a' go do serwera, co skutkuje (na
   og�) wys�aniem wiadomo�ci. W zale�no�ci do strony, program musi si�
   czasami przedtem zalogowa�, lub dokona� innych czynno�ci. W niekt�rych
   przypadkach program mo�e tylko wys�a� maila do bramki operatora.

   S� te� takie nieszcz�liwe przypadki, kiedy program nie mo�e poradzi�
   sobie ze stron�. Tak jest np. w przypadku bramki SMSowej Idei -
   konieczno�� podania tekstu z graficznego tokena skutecznie zablokowa�a
   wysy�anie SMS�w przez t� bramk�.

   Wszystkie te czynno�ci s� dla u�ytkownika zupe�nie niewidoczne. Podaje
   on tylko numer telefonu, tre�� wiadomo�ci do wys�ania. Niekiedy musi
   jeszcze okre�li� przez kt�r� bramk� wiadomo�� ma zosta� wys�ana.
     _________________________________________________________________

Jak go u�ywa�?

   Og�lnie mowi�c, wywo�anie programu ma posta�:

     sms [opcje]

   Przy starcie program odczytuje swoje pliki konfiguracyjne (w
   zale�no�ci od systemu b�d� to /etc/smsrc lub /usr/local/etc/smsrc i
   ~/.smsrc). O ile jest zdefiniowana zmienna �rodowiska CONFIG_DIR to
   zamiast pliku ~/.smsrc odczytywany jest plik $CONFIG_DIR/smsrc. Ka�da
   opcja podana w linii polece� mo�e by� zast�piona odpowiednim wpisem w
   pliku konfiguracyjnym. W szczeg�lno�ci mo�naby wogole nie poda�
   �adnych opcji w linii polece�.

   Plik konfiguracjny zawiera w ka�dej linii pary nazwa, warto��
   oddzielone znakiem r�wno�ci; linie zaczynaj�ce si� od znaku hasha (#)
   traktowane s� jak komentarze; podczas odczytywania pliku
   konfiguracyjnego mo�na korzysta� z analogicznego jak w skryptach
   shellowych podstawiania warto�ci zmiennych, czyli:
     * ${ZMIENNA} - zwraca warto�� zmiennej �rodowiska o podanej nazwie,
       lub warto�� innego parametru z pliku konfiguracyjnego programu
     * `polecenie` - zwraca rezultat dzia�ania podanego polecenia

   Poni�ej podana jest lista parametr�w dost�pnych w linii polece� (w
   nawiasach klamrowych podana jest nazwa opcji w pliku konfiguracyjnym)
   - niekt�re opcje dost�pne w pliku konfiguracyjnym nie maj�
   odpowiednika w linii polece�. W archiwum programu dost�pny jest
   przyk�adowy plik konfiguracyjny README.smsrc.

   [gateway]
   -g <bramka>

     Podaje bramk� przez kt�r� nale�y wys�a� SMSa. W tej chwili
     zdefiniowane s� nast�puj�ce bramki: era, eranet, plus, plusmail,
     miastoplusa, orangembox, o2uk.

   [phone_no]
   -n <numer telefonu>

     Numer telefonu na kt�ry nale�y wys�a� wiadomo��. Numer mo�na poda�
     w formacie mi�dzynarodowym, w przeciwnym wypadku dosmy�lnie
     zostanie przypisany prefiks +48.

   [message]
   -m <wiadomosc>

     Wiadomo�� do wys�ania. W przypadku podania znaku '-' (pauza) tekst
     wiadomo�ci zostanie odczytany ze standardowego wej�cia.

   -c <plik>

     Czy�ci poprzednie odczytane parametry po czym odczytuje podany plik
     konfiguracyjny.

   -o <opcja=wartosc>

     Pozwala poda� w linii polece� dowoln� opcj� w formacie takim, w
     jakim jest w pliku konfiguracyjnym, np.: -o phone_no=602111111.

   -t <podpis>

     Definiuje podpis do��czany do wiadomo�ci. Podpis jest wstawiany w
     miejsce wyst�pienia zmiennej ${signature}.

   -p <czesci>

     Okre�la maksymaln� liczb� SMSow na kt�r� mo�e by� podzielona tre��.
     Innymi s�owy jest to maksymalna liczba 160-znakowych fragment�w
     tekstu.

   -h

     Pokazuje ekran pomocy.

   [verbose]
   -v

     W��cza tryb pokazywania szczeg�owych informacji podczas dzia�ania
     programu.

   [stats]
   -s

     Je�li dana bramka obs�uguje, to pokazane zostan� dodatkowe
     informacje - np. ilo�� wys�anych/pozosta�ych SMSow.

   [notify]
   -r

     Je�li dana bramka obs�uguje, to podczas wysy�ki zostanie w��czona
     opcja wysy�ania potwierdze� dor�czenia SMSa.

   -V

     Poka�e informacje o bie��cej wersji programu.

   -C

     Sprawdzi czy dost�pna jest nowa wersja programu. Je�li tak, to
     program zako�czy si� ze statusem 0, w przeciwnym razie ze statusem
     1.

   [sendmail_path]

     �cie�ka do programu sendmail (b�d� odpowiednika) u�ywanego do
     wysy�ania poczty. Niekt�re bramki (np. plusmail czy o2uk) s�
     obs�ugiwane w ten w�a�nie spos�b.

   Przyk�ady wywo�ania:

     sms -g era -n 602123123 -m "wszystko ok"
     /usr/bin/check | sms -g ideambox -n 502123123 -m -
     _________________________________________________________________

Instalacja i konfiguracja.

   Aby program zainstalowa� nale�y dysponowa� w miar� nowym kompilatorem
   C++. Dodatkowo w systemie musz� by� zainstalowane nast�puj�ce
   biblioteki:
     * Curl - [13]http://curl.haxx.se/
     * Pcre - [14]http://www.pcre.org/
     * Pcre++ - [15]http://www.daemon.de/PCRE
     * gdbm - [16]ftp://ftp.gnu.org/gnu/gdbm/

   Do kompilacji wymagany jest pakiet GNUmake (gmake). Po rozpakowaniu
   archiwum mo�na rozpocz�� kompilacj� wpisuj�c gmake b�d� make. W razie
   b��d�w nale�y ewentualnie poprawi� plik Makefile.
     _________________________________________________________________

Powiadamianie o nowej poczcie.

   Program jest chyba najcz�ciej u�ywany w�a�nie do tego celu. Zreszt�
   dlatego te� go kiedy� napisa�em ;-) Poni�szy opis ma zastosowanie w
   �rodowisku Unix/Linux z tak skonfigurowanym systemem poczty, ze
   mo�liwe jest korzystanie z programu procmail.

   W katalogu contrib znajduje si� przyk�adowy plik procmailrc, kt�ry po
   dostosowaniu do lokalnych potrzeb nale�y umie�ci� w katalogu domowym
   pod nazw� .procmailrc.

   Pomocny mo�e si� tak�e okaza� perlowy skrypt mimecut, tak�e dost�pny w
   tym samym katalogu. Pozwala on usun�� niepotrzebne (cz�sto w HTMLu)
   �mieci z maili przed wys�aniem ich na kom�rk�.
     _________________________________________________________________

Wi�cej informacji.

   Po wi�cej informacji odsy�am na:
     * stron� domow� programu -
       [17]http://ceti.pl/~miki/komputery/sms.html
     * list� dyskusyjn� -
       [18]http://www.ma.krakow.pl/mailman/listinfo/sms-users
     * archiwa listy dyskusyjnej -
       [19]http://jsp.rydzewski.org/sms-users/
     _________________________________________________________________

        $Id: readme.html,v 1.6 2006/12/29 10:05:09 wintermute Exp $

References

   1. http://ceti.pl/~miki/
   2. http://ceti.pl/~miki/komputery/sms.html
   3. mailto:amichalski@gmail.com
   4. mailto:miki@ceti.pl
   5. file://localhost/home/miki/src/sms/doc/readme.html#licencja
   6. file://localhost/home/miki/src/sms/doc/readme.html#doczego
   7. file://localhost/home/miki/src/sms/doc/readme.html#jakdziala
   8. file://localhost/home/miki/src/sms/doc/readme.html#jakuzywac
   9. file://localhost/home/miki/src/sms/doc/readme.html#instalacja
  10. file://localhost/home/miki/src/sms/doc/readme.html#powiadomienie
  11. file://localhost/home/miki/src/sms/doc/readme.html#more
  12. http://www.gnu.org/
  13. http://curl.haxx.se/
  14. http://www.pcre.org/
  15. http://www.daemon.de/PCRE
  16. ftp://ftp.gnu.org/gnu/gdbm/
  17. http://ceti.pl/~miki/komputery/sms.html
  18. http://www.ma.krakow.pl/mailman/listinfo/sms-users
  19. http://jsp.rydzewski.org/sms-users/