r60: popravio, suggests, dodao mail-transport-agent u man page...
[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\r
76 Funkcija backupira datoteku u /var/backups/ direktorij. Po\r
77 potrebi rotira, ako postoje neke razlike.\r
78 .TP\r
79 \fBcp_check_and_sed\fR \fIregexp\fR \fIsed\fR \fIfile\fR [\fIfile\fR ...]\r
80 Funkcija trazi (egrep) regularni izraz \fIregexp\fR u datotekama, te ako\r
81 postoji, izvrsi sed program \fIsed\fR nad tim datotekama.  Najcesce se\r
82 koristi za zamjenu stare vrijednosti postavke novom.\r
83 .TP\r
84 \fBcp_echo\fR [\fB-mailonly\fR|\fB-m\fR] \fIstring\fR\r
85 .TP\r
86 \fBcp_mail\fR [\fB-q\fR] \fIpackage\fR \fIversion\fR\r
87 U kombinaciji, ove funkcije sluze za slanje poruka na stdout \fUi\fR na\r
88 mail rootu.  Koristiti za informacije koje svakako treba dostaviti\r
89 sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji\r
90 kriticnih servisa), cak i ako ne cita dokumentaciju niti prati\r
91 poruke kod upgradea. :\-> Ova funkcija nece raditi bez nekog\r
92 mail-transport-agenta (kao sendmail, postfix, ...).\r
93 .PP\r
94 cp_echo se koristi umjesto echo.  Uz \fB-m\fR salje poruku samo na mail.\r
95 cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez\r
96 \fB-q\fR opcije \fBcp_mail\fR ce ispisati obavijest o slanju tog maila.\r
97 .PP\r
98 Ove dvije funkcije koriste globalnu varijablu \fBCP_NOTICE\fR u koju se\r
99 spremaju poruke za mail.\r
100 .TP\r
101 \fBcp_mv\fR \fInew-file\fR \fItarget-file\fR\r
102 Funkcija cija je namjena da novu datoteku \fInew-file\fR instalira kao\r
103 zadanu \fItarget-file\fR datoteku, koja moze i/ili ne postojati. Ako ta\r
104 datoteka postoji onda se novoj dodjeljuje jednako vlasnistvo i modovi\r
105 pristupa. Operacija je atomicna.\r
106 .PP\r
107 Funkcija \fBcp_mv\fR je prikladna za koristenje kod raznih\r
108 sed-like izmjena neke postojece datoteke iako se za samo sed-anje\r
109 preporuca koristiti funkciju \fBcp_check_and_sed\fR.\r
110 .TP\r
111 \fBcp_yes_no\fR [\fIprompt\fR]\r
112 Funkcija za jednostavni \fUy\fRes/\fUn\fRo dijalog. Odgovor '\fBy\fR' | '\fBn\fR'\r
113 vraca u RET. Valja napomenuti da je kao i sve ostalo sto koristi stdin/stdout\r
114 nekompatibilan s debconfom (doticnog treba ugasiti prvo).\r
115 .TP\r
116 \fBcp_db_get\fR \fIpackage\fR\fB/\fR\fIvariable\fR\r
117 Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane\r
118 greske vrati prazni \fBRET\fR. Kome treba greska neka ga ne koristi.\r
119 Funkcija je namijenjena koristenju na mjestu gdje se inace poziva\r
120 \fBdb_get\fR, sto znaci da korisnik mora sam napraviti sve potrebne\r
121 predradnje, od \fB. /usr/share/debconf/confmodule\fR nadalje.\r
122 .TP\r
123 \fBcp_get_ldap_suffix\fR\r
124 Funkcija vraca LDAP suffix kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
125 .TP\r
126 \fBcp_get_ldap_realm\fR\r
127 Funkcija vraca LDAP realm kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
128 .PP\r
129 U pravilu, funkcije cije ime pocinje sa \fBcp_get_\fR pohranjuju rezultat\r
130 u varijabli \fB$RET\fR, a one s prefiksom cp_check_ kao rezultat vracaju \r
131 exit status.  Pogledajte dolje koje se varijable okruzja mogu upotrijebiti\r
132 za utjecaj na nacin vracanja povratne vrijednosti.\r
133 .\"\r
134 .SH PRIMJER\r
135 Poziv \fBcp_get_\fRxxx funkcije i preuzimanje rezultata:\r
136 .Sp\r
137 .Vb 4\r
138 \&    . /usr/share/carnet-tools/functions.sh
139 \&\r
140 \&    cp_get_ifaddr ppp0\r
141 \&    addr="$RET"\r
142 .Ve
143 Poziv \fBcp_check_\fRxxx funkcije i nastavak toka programa:\r
144 .Sp\r
145 .Vb 6\r
146 \&    . /usr/share/carnet-tools/functions.sh
147 \&\r
148 \&    if ! cp_check_and_sed watter 's/watter/ice/' \\\r
149 \&                          /dev/fridge; then\r
150 \&      cp_echo "Clean the /dev/fridge!"\r
151 \&    fi\r
152 .Ve
153 .\"
154 .SH ENVIRONMENT
155 \fBCP_ECHO_RETURN\fR   - kontrola nacina povrata vrijednosti\r
156 .br\r
157 .PP\r
158 \fBCP_SCRIPT_DEBUG\fR  - potpomaze debugiranje (set -vx)\r
159 .br\r
160 .PP\r
161 \fBCP_NOTICE\fR        - tijelo poruke koja se salje na mail\r
162 .br\r
163 .PP\r
164 \fBRET\fR              - povrat vrijednosti iz \fBcp_get_\fRxxx funkcija
165 .\"
166 .SH DATOTEKE
167 Ne koriste se nikakve posebne datoteke.
168 .\"
169 .SH BUGOVI
170 Nema poznatih.
171 .\"
172 .SH AUTORI
173 Ivan 'ico' Rako, Zoran Dzelajlija, Damir Dzeko. SRCE <paketi@srce.hr>.\r
174 .\"
175 .SH "VEZANO"\r
176 .BR cp-update(1)\r
177 .\" End