r34: ispravke vezano uz cp_db_get
[carnet-tools-cn.git] / README.CARNet
1 carnet-tools-cn
2 ~~~~~~~~~~~~~~~
3
4 Paket carnet-tools-cn sadrzi skripte i shell funkcije koje se cesto
5 koriste u CARNetovim paketima.
6
7 Trenutna verzija sadrzi:
8
9  - cp-update skriptu, koja se koristi u instalacijskim skriptama CARNet
10    paketa za dodavanje blokova teksta u konfiguracijske datoteke.
11
12  - /usr/share/carnet-tools/functions.sh datoteku koja sadrzi sljedece
13    shell funkcije:
14
15 cp_get_ifaddr <interface>
16
17         Funkcija vraca IP adresu mreznog sucelja. U slucaju da nije
18         naveden kao argument, vraca IP adresu od loopback sucelja (lo).
19
20 cp_get_ifmask <interface>
21
22         Funkcija vraca IP netmask mreznog sucelja. U slucaju da nije
23         naveden kao argument, vraca IP netmask od loopback sucelja (lo).
24
25 cp_get_ifdefault [dev|addr]
26
27         Funkcija vraca naziv uredjaj ili adresu podrazumne rute (default
28         route).
29
30 cp_get_netaddr <interface>
31
32         Funkcija vraca podmrezu mreznog sucelja u CIDR obliku.  U slucaju
33         da nije naveden <interface> argument, vraca CIDR sucelja preko
34         kojeg ide default route, a ako isti nije definiran, vraca CIDR
35         loopback sucelja (lo).
36
37 cp_backup_conffile <file>
38
39         Funkcija backupira datoteku u /var/backups/ direktorij. Po
40         potrebi rotira, ako postoje neke razlike.
41
42 cp_check_and_sed <regexp> <sed> <file> [<file> ...]
43
44         Funkcija trazi regularni izraz <regexp> u datotekama, te ako
45         postoji, izvrsi sed program <sed> nad tim datotekama.  Najcesce se
46         koristi za zamjenu stare vrijednosti postavke novom.
47
48 cp_echo [-mailonly|-m] <string>
49
50 cp_mail [-q] <package> <version>
51
52         U kombinaciji, ove funkcije sluze za slanje poruka na stdout _i_ na
53         mail rootu.  Koristiti za informacije koje svakako treba dostaviti
54         sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji
55         kriticnih servisa), cak i ako ne cita dokumentaciju niti prati
56         poruke kod upgradea. :->
57
58         cp_echo se koristi umjesto echo.  Uz -m salje poruku samo na mail.
59         cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez
60         -q opcije cp_mail ce ispisati obavijest o slanju tog maila.
61
62         Ove dvije funkcije koriste globalnu varijablu CP_NOTICE u koju se
63         spremaju poruke za mail.
64
65 cp_mv <new-file> <target-file>
66
67         Funkcija cija je namjena da novu datoteku <new-file> instalira kao
68         zadanu <target-file> datoteku, koja moze i/ili ne postojati. Ako ta
69         datoteka postoji onda se novoj dodjeljuje njeno vlasnistvo i modovi
70         pristupa. Operacija je atomicna.
71
72         Funkcija cp_safe_file_replace je prikladna za koristenje kod raznih
73         sed-like izmjena neke postojece datoteke iako se za samo sed-anje
74         preporuca koristiti funkciju cp_check_and_sed.
75
76 cp_yes_no [<prompt>]
77
78         Funkcija za jednostavni (y)es/(n)o dijalog. Odgovor y/n vraca u RET.
79         Valja napomenuti da je kao i sve ostalo sto trosi stdin/stdout 
80         nekompatibilan s debconfom (doticnog treba pogasiti prvo).
81
82 cp_db_get <package>/<variable>
83
84         Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane
85         greske vrati prazni RET. Kome treba greska neka ga ne koristi.
86         Funkcija je namijenjena koristenju na mjestu gdje se inace poziva 
87         db_get, sto znaci da korisnik mora sam napraviti sve potrebne 
88         predradnje, od  . /usr/share/debconf/confmodule  nadalje.
89
90 Funkcije cije ime pocinje sa cp_get_ pohranjuju rezultat u varijabli $RET,
91 a one s prefiksom cp_check_ kao rezultat vracaju exit status.  U pozivnoj
92 skripti se mogu definirati sljedece varijable koje utjecu na rad svih
93 pomocnih funkcija:
94
95 $CP_SCRIPT_DEBUG
96
97         Potpomaze debugiranje (set -vx).
98
99 $CP_ECHO_RETURN
100
101         Vracanje rezultata na stdout i u varijabli $RET.
102         Ako se cp_ funkcija koja vraca string poziva unutar neke druge cp_
103         funkcije, treba iskljucivo koristiti $RET konvenciju, i sacuvati
104         prethodno stanje varijable CP_ECHO_RETURN.
105
106
107 -- Ivan 'ico' Rako <irako@srce.hr>  Wed, 16 Mar 2005 14:25:14 +0100