r79: update changeloga za 2.4.3.
[carnet-tools-cn.git] / carnet-tools.7
1 .\" Copied from from Pod::Man template\r
2 .\" Wed, 23 Mar 2005 11:51:08 +0100\r
3 .\"\r
4 .\" Standard preamble:\r
5 .\" ======================================================================\r
6 .de Sh \" Subsection heading\r
7 .br\r
8 .if t .Sp\r
9 .ne 5\r
10 .PP\r
11 \fB\\$1\fR\r
12 .PP\r
13 ..\r
14 .de Sp \" Vertical space (when we can't use .PP)\r
15 .if t .sp .5v\r
16 .if n .sp\r
17 ..\r
18 .de Ip \" List item\r
19 .br\r
20 .ie \\n(.$>=3 .ne \\$3\r
21 .el .ne 3\r
22 .IP "\\$1" \\$2\r
23 ..\r
24 .de Vb \" Begin verbatim text\r
25 .ft CW\r
26 .nf\r
27 .ne \\$1\r
28 ..\r
29 .de Ve \" End verbatim text\r
30 .ft R
31
32 .fi
33 ..\r
34 .\"\r
35 .\" For nroff, turn off justification.  Always turn off hyphenation; it\r
36 .\" makes way too many mistakes in technical documents.\r
37 .hy 0\r
38 .if n .na\r
39 .\"
40 .IX Title "carnet-tools 7"
41 .TH carnet-tools 7 "March 2005" CARNet "CARNet Packaging Tools"
42 .SH NAME\r
43 carnet-tools \- pomocni alati za laksi zivot package maintainera\r
44 .\"\r
45 .SH PREGLED\r
46 .B . /usr/share/carnet-tools/functions.sh\r
47 .\"\r
48 .SH OPIS
49 Paket carnet-tools-cn sadrzi skripte i shell funkcije koje se cesto\r
50 koriste u CARNetovim paketima. To sluzi tome da se postinst skripte\r
51 pisu lakse, brze i pouzdanije temeljene na vec isprobanom kodu. Tu \r
52 su i primjeri provjerenih rjesenja za shell-skriptiranje da se nadju\r
53 pri ruci kad zatreba.\r
54 .\"\r
55 .SH FUNKCIJE\r
56 .TP\r
57 \fBcp_get_ifaddr\fR \fIinterface\fR\r
58 Funkcija vraca IP adresu mreznog sucelja. U slucaju da nije\r
59 naveden kao argument, vraca IP adresu od loopback sucelja (lo).\r
60 .TP\r
61 \fBcp_get_ifmask\fR \fIinterface\fR\r
62 Funkcija vraca IP netmask mreznog sucelja. U slucaju da nije\r
63 naveden kao argument, vraca IP netmask od loopback sucelja (lo).\r
64 .TP\r
65 \fBcp_get_ifdefault\fR [\fBdev\fR|\fBaddr\fR]\r
66 Funkcija vraca naziv uredjaj ili adresu podrazumne rute (default\r
67 route).\r
68 .TP\r
69 \fBcp_get_netaddr\fR \fIinterface\fR\r
70 Funkcija vraca podmrezu mreznog sucelja u CIDR obliku.  U slucaju\r
71 da nije naveden \fIinterface\fR argument, vraca CIDR sucelja preko\r
72 kojeg ide default route, a ako isti nije definiran, vraca CIDR\r
73 loopback sucelja (lo).\r
74 .TP\r
75 \fBcp_backup_conffile\fR \fIfile\fR [\fIbackup_file\fR]\r
76 .TP\r
77 \fBcp_check_and_backup\fR \fIfile\fR [\fIbackup_file\fR]\r
78 Funkcije backupiraju datoteku, kopija originala se sprema\r
79 u /var/backups/ direktorij sa dodanim .bak nastavkom.  Po potrebi se vrsi\r
80 rotacija prethodno spremljenih kopija ako postoje neke razlike.  Opcionalni\r
81 argument \fIbackup_file\fR zamjenuje ime backup datoteke u /var/backups \r
82 nekim drugim.  Na primjer:\r
83 .nf\r
84 cp_backup_conffile config.php\r
85 .fi\r
86   - backup ide u /var/backups/config.php.bak\r
87 .nf\r
88 cp_backup_conffile apache.conf squirrelmail-apache.conf\r
89 .fi\r
90   - backup ide u /var/backups/squirrelmail-apache.conf.bak\r
91 cp_backup_conffile uspjesno zavrsi ako nije bilo potrebno izvrsiti backup, \r
92 dok cp_check_and_backup u tom slucaju vraca status 3.\r
93 .TP\r
94 \fBcp_check_and_sed\fR \fIregexp\fR \fIsed\fR \fIfile\fR [\fIfile\fR ...]\r
95 Funkcija trazi (egrep) regularni izraz \fIregexp\fR u datotekama, te ako\r
96 postoji, izvrsi sed program \fIsed\fR nad tim datotekama.  Najcesce se\r
97 koristi za zamjenu stare vrijednosti postavke novom.\r
98 .TP\r
99 \fBcp_echo\fR [\fB-mailonly\fR|\fB-m\fR] \fIstring\fR\r
100 .TP\r
101 \fBcp_mail\fR [\fB-q\fR] \fIpackage\fR \fIversion\fR\r
102 U kombinaciji, ove funkcije sluze za slanje poruka na stdout \fUi\fR na\r
103 mail rootu.  Koristiti za informacije koje svakako treba dostaviti\r
104 sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji\r
105 kriticnih servisa), cak i ako ne cita dokumentaciju niti prati\r
106 poruke kod upgradea. :\-> Paket koji koristi cp_mail() mora imati\r
107 Depends: mail-transport-agent.\r
108 .PP\r
109 cp_echo se koristi umjesto echo.  Uz \fB-m\fR salje poruku samo na mail.\r
110 cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez\r
111 \fB-q\fR opcije \fBcp_mail\fR ce ispisati obavijest o slanju tog maila.\r
112 .PP\r
113 Ove dvije funkcije koriste globalnu varijablu \fBCP_NOTICE\fR u koju se\r
114 spremaju poruke za mail.\r
115 .TP\r
116 \fBcp_mv\fR \fInew-file\fR \fItarget-file\fR\r
117 Funkcija cija je namjena da novu datoteku \fInew-file\fR instalira kao\r
118 zadanu \fItarget-file\fR datoteku, koja moze i/ili ne postojati. Ako ta\r
119 datoteka postoji onda se novoj dodjeljuje jednako vlasnistvo i modovi\r
120 pristupa. Operacija je atomicna.\r
121 .PP\r
122 Funkcija \fBcp_mv\fR je prikladna za koristenje kod raznih\r
123 sed-like izmjena neke postojece datoteke iako se za samo sed-anje\r
124 preporuca koristiti funkciju \fBcp_check_and_sed\fR.\r
125 .TP\r
126 \fBcp_yes_no\fR [\fIprompt\fR]\r
127 Funkcija za jednostavni \fUy\fRes/\fUn\fRo dijalog. Odgovor '\fBy\fR' | '\fBn\fR'\r
128 vraca u RET. Valja napomenuti da je kao i sve ostalo sto koristi stdin/stdout\r
129 nekompatibilan s debconfom (doticnog treba ugasiti prvo).\r
130 .TP\r
131 \fBcp_db_get\fR \fIpackage\fR\fB/\fR\fIvariable\fR\r
132 Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane\r
133 greske vrati prazni \fBRET\fR. Kome treba greska neka ga ne koristi.\r
134 Funkcija je namijenjena koristenju na mjestu gdje se inace poziva\r
135 \fBdb_get\fR, sto znaci da korisnik mora sam napraviti sve potrebne\r
136 predradnje, od \fB. /usr/share/debconf/confmodule\fR nadalje.\r
137 .TP\r
138 \fBcp_get_ldap_suffix\fR\r
139 Funkcija vraca LDAP suffix kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
140 .TP\r
141 \fBcp_get_ldap_realm\fR\r
142 Funkcija vraca LDAP realm kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
143 .PP\r
144 U pravilu, funkcije cije ime pocinje sa \fBcp_get_\fR pohranjuju rezultat\r
145 u varijabli \fB$RET\fR, a one s prefiksom cp_check_ kao rezultat vracaju \r
146 exit status.  Pogledajte dolje koje se varijable okruzja mogu upotrijebiti\r
147 za utjecaj na nacin vracanja povratne vrijednosti.\r
148 .\"\r
149 .SH PRIMJER\r
150 Poziv \fBcp_get_\fRxxx funkcije i preuzimanje rezultata:\r
151 .Sp\r
152 .Vb 4\r
153 \&    . /usr/share/carnet-tools/functions.sh
154 \&\r
155 \&    cp_get_ifaddr ppp0\r
156 \&    addr="$RET"\r
157 .Ve
158 Poziv \fBcp_check_\fRxxx funkcije i nastavak toka programa:\r
159 .Sp\r
160 .Vb 6\r
161 \&    . /usr/share/carnet-tools/functions.sh
162 \&\r
163 \&    if ! cp_check_and_sed watter 's/watter/ice/' \\\r
164 \&                          /dev/fridge; then\r
165 \&      cp_echo "Clean the /dev/fridge!"\r
166 \&    fi\r
167 .Ve
168 .\"
169 .SH ENVIRONMENT\r
170 .TP
171 \fBCP_ECHO_RETURN\fR\r
172 .nf\r
173 kontrola nacina povrata vrijednosti, postaviti na 1\r
174 \fUnakon\fR ucitavanja datoteke s funkcijama da bi rezultat\r
175 \fBcp_get_*\fR funkcija isao i na stdout pored postavljanja \fB$RET\fR.\r
176 .fi\r
177 .TP\r
178 \fBCP_SCRIPT_DEBUG\fR\r
179 .nf\r
180 potpomaze debugiranje (set -vx)\r
181 .fi\r
182 .TP\r
183 \fBCP_NOTICE\fR\r
184 .nf\r
185 tijelo poruke koja se salje na mail\r
186 .fi\r
187 .TP\r
188 \fBRET\fR\r
189 .nf\r
190 povratna vrijednost iz \fBcp_get_\fRxxx funkcija\r
191 .fi
192 .\"
193 .SH DATOTEKE
194 Ne koriste se nikakve posebne datoteke.
195 .\"
196 .SH BUGOVI
197 Nema poznatih.
198 .\"
199 .SH AUTORI
200 Ivan 'ico' Rako, Zoran Dzelajlija, Damir Dzeko. SRCE <paketi@srce.hr>.\r
201 .\"
202 .SH "VEZANO"\r
203 .BR cp-update(1)\r
204 .\" End