r39: Renamed carnet-tools.8 to carnet-tools.7
[carnet-tools-cn.git] / carnet-tools.7
diff --git a/carnet-tools.7 b/carnet-tools.7
new file mode 100644 (file)
index 0000000..37d10f8
--- /dev/null
@@ -0,0 +1,170 @@
+.\" Copied from from Pod::Man template\r
+.\" Wed, 23 Mar 2005 11:51:08 +0100\r
+.\"\r
+.\" Standard preamble:\r
+.\" ======================================================================\r
+.de Sh \" Subsection heading\r
+.br\r
+.if t .Sp\r
+.ne 5\r
+.PP\r
+\fB\\$1\fR\r
+.PP\r
+..\r
+.de Sp \" Vertical space (when we can't use .PP)\r
+.if t .sp .5v\r
+.if n .sp\r
+..\r
+.de Ip \" List item\r
+.br\r
+.ie \\n(.$>=3 .ne \\$3\r
+.el .ne 3\r
+.IP "\\$1" \\$2\r
+..\r
+.de Vb \" Begin verbatim text\r
+.ft CW\r
+.nf\r
+.ne \\$1\r
+..\r
+.de Ve \" End verbatim text\r
+.ft R
+
+.fi
+..\r
+.\"\r
+.\" For nroff, turn off justification.  Always turn off hyphenation; it\r
+.\" makes way too many mistakes in technical documents.\r
+.hy 0\r
+.if n .na\r
+.\"
+.IX Title "carnet-tools 7"
+.TH carnet-tools 7 "March 2005" CARNet "CARNet Packaging Tools"
+.SH NAME\r
+carnet-tools \- pomocni alati za laksi zivot package maintainera\r
+.\"\r
+.SH PREGLED\r
+.B . /usr/share/carnet-tools/functions.sh\r
+.\"\r
+.SH OPIS
+Paket carnet-tools-cn sadrzi skripte i shell funkcije koje se cesto\r
+koriste u CARNetovim paketima. To sluzi tome da se postinst skripte\r
+pisu lakse, brze i pouzdanije temeljene na vec isprobanom kodu. Tu \r
+su i primjeri provjerenih rjesenja za shell-skriptiranje da se nadju\r
+pri ruci kad zatreba.\r
+.\"\r
+.SH FUNKCIJE\r
+.TP\r
+\fBcp_get_ifaddr\fR \fIinterface\fR\r
+Funkcija vraca IP adresu mreznog sucelja. U slucaju da nije\r
+naveden kao argument, vraca IP adresu od loopback sucelja (lo).\r
+.TP\r
+\fBcp_get_ifmask\fR \fIinterface\fR\r
+Funkcija vraca IP netmask mreznog sucelja. U slucaju da nije\r
+naveden kao argument, vraca IP netmask od loopback sucelja (lo).\r
+.TP\r
+\fBcp_get_ifdefault\fR [\fBdev\fR|\fBaddr\fR]\r
+Funkcija vraca naziv uredjaj ili adresu podrazumne rute (default\r
+route).\r
+.TP\r
+\fBcp_get_netaddr\fR \fIinterface\fR\r
+Funkcija vraca podmrezu mreznog sucelja u CIDR obliku.  U slucaju\r
+da nije naveden \fIinterface\fR argument, vraca CIDR sucelja preko\r
+kojeg ide default route, a ako isti nije definiran, vraca CIDR\r
+loopback sucelja (lo).\r
+.TP\r
+\fBcp_backup_conffile\fR \fIfile\fR\r
+Funkcija backupira datoteku u /var/backups/ direktorij. Po\r
+potrebi rotira, ako postoje neke razlike.\r
+.TP\r
+\fBcp_check_and_sed\fR \fIregexp\fR \fIsed\fR \fIfile\fR [\fIfile\fR ...]\r
+Funkcija trazi (egrep) regularni izraz \fIregexp\fR u datotekama, te ako\r
+postoji, izvrsi sed program \fIsed\fR nad tim datotekama.  Najcesce se\r
+koristi za zamjenu stare vrijednosti postavke novom.\r
+.TP\r
+\fBcp_echo\fR [\fB-mailonly\fR|\fB-m\fR] \fIstring\fR\r
+.TP\r
+\fBcp_mail\fR [\fB-q\fR] \fIpackage\fR \fIversion\fR\r
+U kombinaciji, ove funkcije sluze za slanje poruka na stdout \fUi\fR na\r
+mail rootu.  Koristiti za informacije koje svakako treba dostaviti\r
+sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji\r
+kriticnih servisa), cak i ako ne cita dokumentaciju niti prati\r
+poruke kod upgradea. :\->\r
+.PP\r
+cp_echo se koristi umjesto echo.  Uz \fB-m\fR salje poruku samo na mail.\r
+cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez\r
+\fB-q\fR opcije \fBcp_mail\fR ce ispisati obavijest o slanju tog maila.\r
+.PP\r
+Ove dvije funkcije koriste globalnu varijablu \fBCP_NOTICE\fR u koju se\r
+spremaju poruke za mail.\r
+.TP\r
+\fBcp_mv\fR \fInew-file\fR \fItarget-file\fR\r
+Funkcija cija je namjena da novu datoteku \fInew-file\fR instalira kao\r
+zadanu \fItarget-file\fR datoteku, koja moze i/ili ne postojati. Ako ta\r
+datoteka postoji onda se novoj dodjeljuje jednako vlasnistvo i modovi\r
+pristupa. Operacija je atomicna.\r
+.PP\r
+Funkcija \fBcp_mv\fR je prikladna za koristenje kod raznih\r
+sed-like izmjena neke postojece datoteke iako se za samo sed-anje\r
+preporuca koristiti funkciju \fBcp_check_and_sed\fR.\r
+.TP\r
+\fBcp_yes_no\fR [\fIprompt\fR]\r
+Funkcija za jednostavni \fUy\fRes/\fUn\fRo dijalog. Odgovor '\fBy\fR' | '\fBn\fR'\r
+vraca u RET. Valja napomenuti da je kao i sve ostalo sto koristi stdin/stdout\r
+nekompatibilan s debconfom (doticnog treba ugasiti prvo).\r
+.TP\r
+\fBcp_db_get\fR \fIpackage\fR\fB/\fR\fIvariable\fR\r
+Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane\r
+greske vrati prazni \fBRET\fR. Kome treba greska neka ga ne koristi.\r
+Funkcija je namijenjena koristenju na mjestu gdje se inace poziva\r
+\fBdb_get\fR, sto znaci da korisnik mora sam napraviti sve potrebne\r
+predradnje, od \fB. /usr/share/debconf/confmodule\fR nadalje.\r
+.PP\r
+Funkcije cije ime pocinje sa \fBcp_get_\fR pohranjuju rezultat u varijabli \fB$RET\fR,\r
+a one s prefiksom cp_check_ kao rezultat vracaju exit status.  U pozivnoj\r
+skripti se mogu definirati sljedece varijable koje utjecu na rad svih\r
+pomocnih funkcija:\r
+\r
+.SH PRIMJER\r
+Poziv \fBcp_get_\fRxxx funkcije i preuzimanje rezultata:\r
+.Sp\r
+.Vb 4\r
+\&    . /usr/share/carnet-tools/functions.sh
+\&\r
+\&    cp_get_ifaddr ppp0\r
+\&    addr="$RET"\r
+.Ve
+Poziv \fBcp_check_\fRxxx funkcije i nastavak toka programa:\r
+.Sp\r
+.Vb 6\r
+\&    . /usr/share/carnet-tools/functions.sh
+\&\r
+\&    if ! cp_check_and_sed watter 's/watter/ice/' \\\r
+\&                          /dev/fridge; then\r
+\&      cp_echo "Clean the /dev/fridge!"\r
+\&    fi\r
+.Ve
+.\"
+.SH ENVIRONMENT
+\fBCP_ECHO_RETURN\fR   - kontrola nacina povrata vrijednosti\r
+.br\r
+.PP\r
+\fBCP_SCRIPT_DEBUG\fR  - potpomaze debugiranje (set -vx)\r
+.br\r
+.PP\r
+\fBCP_NOTICE\fR        - tijelo poruke koja se salje na mail\r
+.br\r
+.PP\r
+\fBRET\fR              - povrat vrijednosti iz \fBcp_get_\fRxxx funkcija
+.\"
+.SH DATOTEKE
+Ne koriste se nikakve posebne datoteke.
+.\"
+.SH BUGOVI
+Nema poznatih.
+.\"
+.SH AUTORI
+Ivan 'ico' Rako, Zoran Dzelajlija, Damir Dzeko. SRCE <paketi@srce.hr>.\r
+.\"
+.SH "VEZANO"\r
+.BR cp-update(1)\r
+.\" End