r8:

[carnet-tools-cn.git] / README.CARNet

diff --git a/README.CARNet b/README.CARNet
index e8f8179..6c82673 100644 (file)
--- a/README.CARNet
+++ b/README.CARNet
@@ -24,8 +24,10 @@ cp_get_ifmask <interface>
 
 cp_get_cidr <interface>
 
-       Funkcija vraca CIDR mreznog sucelja. U slucaju da nije
-       naveden kao argument, vraca CIDR od loopback sucelja (lo).
+       Funkcija vraca podmrezu mreznog sucelja u CIDR obliku.  U slucaju
+       da nije naveden <interface> argument, vraca CIDR sucelja preko
+       kojeg ide default route, a ako isti nije definiran, vraca CIDR
+       loopback sucelja (lo).
 
 cp_backup_conffile <file>
 
@@ -38,17 +40,34 @@ cp_check_and_sed <regexp> <sed> <file> [<file> ...]
        postoji, izvrsi sed program <sed> nad tim datotekama.  Najcesce se
        koristi za zamjenu stare vrijednosti postavke novom.
 
+cp_echo [-mailonly|-m] <string>
 
+cp_mail [-q] <package> <version>
 
-Svaka funkcija vraca argument u varijabli $RET, dok se prije startanja bilo
-koje funkcije mogu definirati varijable:
+       U kombinaciji, ove funkcije sluze za slanje poruka na stdout _i_ na
+       mail rootu.  Koristiti za informacije koje svakako treba dostaviti
+       sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji
+       kriticnih servisa), cak i ako ne cita dokumentaciju niti prati
+       poruke kod upgradea. :->
+
+       cp_echo se koristi umjesto echo.  Uz -m salje poruku samo na mail.
+       cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez
+       -q opcije cp_mail ce ispisati obavijest o slanju tog maila.
+
+       Ove dvije funkcije koriste globalnu varijablu CP_NOTICE u koju se
+       spremaju poruke za mail.
+
+Funkcije cije ime pocinje sa cp_get_ pohranjuju rezultat u varijabli $RET,
+a one s prefiksom cp_check_ kao rezultat vracaju exit status.  U pozivnoj
+skripti se mogu definirati sljedece varijable koje utjecu na rad svih
+pomocnih funkcija:
 
 $CP_SCRIPT_DEBUG
 
-       Ukljucuje debugiranje (set -vx).
+       Potpomaze debugiranje (set -vx).
 
 $CP_ECHO_RETURN
 
-       Vracanje rezultata na STDIN i u varijabli $RET.
+       Vracanje rezultata na stdout i u varijabli $RET.
 
 -- Ivan 'ico' Rako <irako@srce.hr>  Wed, 16 Mar 2005 14:25:14 +0100