X-Git-Url: http://ftp.carnet.hr/carnet-debian/scm?a=blobdiff_plain;f=carnet-tools.7;fp=carnet-tools.7;h=37d10f8b1a825cf0e73365f922789d3ace9bde91;hb=7ffd1ec8deed02002064cbe340d2b1aa2c812e95;hp=0000000000000000000000000000000000000000;hpb=f98b8bf1105eb129c91f8263555a708ae7523b86;p=carnet-upgrade.git

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