
   #[1]author [2]home

                                      SMS

   SMS jest programem pozwalajcym na wysyanie wiadomoci na telefony
   komrkowe operatorw polskich sieci komrkowych (Era, Plus, Orange,
   Heyah). Powinna dziaa take obsuga bramki angielskiego operatora O2

   Obecna wersje (2.x) s kompletnym przepisaniem wersji poprzednich.
   Cao zostaa napisana zupenie od nowa.

   Po dugim okresie braku aktywnoci z mojej strony w rozwj programu
   zaangaowaa si nowa osoba: Adam Michalski [3]amichalski@gmail.com.


    Autor: Mikoaj Rydzewski [4]<miki@ceti.pl>

    1. [5]Licencja
    2. [6]Do czego ten program suy?
    3. [7]Jak program dziaa?
    4. [8]Jak go uzywac?
    5. [9]Instalacja i konfiguracja
    6. [10]Powiadamianie o nowej poczcie.
    7. [11]Wicej informacji
     _________________________________________________________________

Licencja.

   Program ten udostpniony jest na zasadach licencji GPL v2, bd
   pniejszej. Tre licencji dostpna jest w pliku COPYING w archiwum z
   kodem programu, bd na stronie [12]http://www.gnu.org.
     _________________________________________________________________

Do czego ten program suy?

   Pozwala on wysya krtkie wiadomoci tekstowe (SMS) poprzez internet
   z komputera wprost na telefon komrkowy. Do wysania wiadomoci nie
   jest potrzebna interakcja z uytkownikiem, moe by wic ona wysana w
   sposb automatyczny. Typowe zastosowania programu to:
     * wysyanie powiadomie o nadejciu nowej poczty
     * wysyanie komunikatw przez serwisy www
     * wysyanie komunikatw dla administratorw przez rne skrypty

   Z racji na uywanie (z reguy) bezpatnych bramek www->sms nie powinno
   si uzalenia od dziaania programu istotnych aplikacji. Jeli
   uruchamia kto powan usug wymagajc wysyania smsw, to z reguy
   te sta go na wykupienie stosownego abonamentu i/lub modemu GSM.
     _________________________________________________________________

Jak program dziaa?

   Nie zgbiajc si w szczegy ;-) program udaje przegldark www i
   wypenia formularze na stronach odpowiednich operatorw. Po
   wypenieniu takiego formularza 'wysya' go do serwera, co skutkuje (na
   og) wysaniem wiadomoci. W zalenoci do strony, program musi si
   czasami przedtem zalogowa, lub dokona innych czynnoci. W niektrych
   przypadkach program moe tylko wysa maila do bramki operatora.

   S te takie nieszczliwe przypadki, kiedy program nie moe poradzi
   sobie ze stron. Tak jest np. w przypadku bramki SMSowej Idei -
   konieczno podania tekstu z graficznego tokena skutecznie zablokowaa
   wysyanie SMSw przez t bramk.

   Wszystkie te czynnoci s dla uytkownika zupenie niewidoczne. Podaje
   on tylko numer telefonu, tre wiadomoci do wysania. Niekiedy musi
   jeszcze okreli przez ktr bramk wiadomo ma zosta wysana.
     _________________________________________________________________

Jak go uywa?

   Oglnie mowic, wywoanie programu ma posta:

     sms [opcje]

   Przy starcie program odczytuje swoje pliki konfiguracyjne (w
   zalenoci od systemu bd 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. Kada
   opcja podana w linii polece moe by zastpiona odpowiednim wpisem w
   pliku konfiguracyjnym. W szczeglnoci monaby wogole nie poda
   adnych opcji w linii polece.

   Plik konfiguracjny zawiera w kadej linii pary nazwa, warto
   oddzielone znakiem rwnoci; linie zaczynajce si od znaku hasha (#)
   traktowane s jak komentarze; podczas odczytywania pliku
   konfiguracyjnego mona korzysta z analogicznego jak w skryptach
   shellowych podstawiania wartoci zmiennych, czyli:
     * ${ZMIENNA} - zwraca warto zmiennej rodowiska o podanej nazwie,
       lub warto innego parametru z pliku konfiguracyjnego programu
     * `polecenie` - zwraca rezultat dziaania podanego polecenia

   Poniej podana jest lista parametrw dostpnych w linii polece (w
   nawiasach klamrowych podana jest nazwa opcji w pliku konfiguracyjnym)
   - niektre opcje dostpne w pliku konfiguracyjnym nie maj
   odpowiednika w linii polece. W archiwum programu dostpny jest
   przykadowy plik konfiguracyjny README.smsrc.

   [gateway]
   -g <bramka>

     Podaje bramk przez ktr naley wysa SMSa. W tej chwili
     zdefiniowane s nastpujce bramki: era, eranet, plus, plusmail,
     miastoplusa, orangembox, o2uk.

   [phone_no]
   -n <numer telefonu>

     Numer telefonu na ktry naley wysa wiadomo. Numer mona poda
     w formacie midzynarodowym, w przeciwnym wypadku dosmylnie
     zostanie przypisany prefiks +48.

   [message]
   -m <wiadomosc>

     Wiadomo do wysania. W przypadku podania znaku '-' (pauza) tekst
     wiadomoci zostanie odczytany ze standardowego wejcia.

   -c <plik>

     Czyci 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 doczany do wiadomoci. Podpis jest wstawiany w
     miejsce wystpienia zmiennej ${signature}.

   -p <czesci>

     Okrela maksymaln liczb SMSow na ktr moe by podzielona tre.
     Innymi sowy jest to maksymalna liczba 160-znakowych fragmentw
     tekstu.

   -h

     Pokazuje ekran pomocy.

   [verbose]
   -v

     Wcza tryb pokazywania szczegowych informacji podczas dziaania
     programu.

   [stats]
   -s

     Jeli dana bramka obsuguje, to pokazane zostan dodatkowe
     informacje - np. ilo wysanych/pozostaych SMSow.

   [notify]
   -r

     Jeli dana bramka obsuguje, to podczas wysyki zostanie wczona
     opcja wysyania potwierdze dorczenia SMSa.

   -V

     Pokae informacje o biecej wersji programu.

   -C

     Sprawdzi czy dostpna jest nowa wersja programu. Jeli tak, to
     program zakoczy si ze statusem 0, w przeciwnym razie ze statusem
     1.

   [sendmail_path]

     cieka do programu sendmail (bd odpowiednika) uywanego do
     wysyania poczty. Niektre bramki (np. plusmail czy o2uk) s
     obsugiwane w ten wanie sposb.

   Przykady wywoania:

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

Instalacja i konfiguracja.

   Aby program zainstalowa naley dysponowa w miar nowym kompilatorem
   C++. Dodatkowo w systemie musz by zainstalowane nastpujce
   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 mona rozpocz kompilacj wpisujc gmake bd make. W razie
   bdw naley ewentualnie poprawi plik Makefile.
     _________________________________________________________________

Powiadamianie o nowej poczcie.

   Program jest chyba najczciej uywany wanie do tego celu. Zreszt
   dlatego te go kiedy napisaem ;-) Poniszy opis ma zastosowanie w
   rodowisku Unix/Linux z tak skonfigurowanym systemem poczty, ze
   moliwe jest korzystanie z programu procmail.

   W katalogu contrib znajduje si przykadowy plik procmailrc, ktry po
   dostosowaniu do lokalnych potrzeb naley umieci w katalogu domowym
   pod nazw .procmailrc.

   Pomocny moe si take okaza perlowy skrypt mimecut, take dostpny w
   tym samym katalogu. Pozwala on usun niepotrzebne (czsto w HTMLu)
   mieci z maili przed wysaniem ich na komrk.
     _________________________________________________________________

Wicej informacji.

   Po wicej informacji odsyam 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/
