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 [\fB-n\fR] [[\fB-p\fR] \fB-d\fR \fIbackup_dir\fR] \fIfile\fR [\fIbackup_file\fR]\r
  76 .TP\r
  77 \fBcp_check_and_backup\fR [\fB-n\fR] [[\fB-p\fR] \fB-d\fR \fIbackup_dir\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.  Opcijom \fB-d\fR se moze podesiti alternativno odrediste, bilo \r
  83 apsolutnom putanjom do zeljenog direktorija ili relativnom unutar /var/backups.\r
  84 \fB-p\fR ce automatski stvoriti odredisni direktorij ako ne postoji.\r
  85 Opcija \fB-n\fR sprecava dodavanje .bak nastavka.  Na primjer:\r
  86 .nf\r
  87 cp_backup_conffile config.php\r
  88 .fi\r
  89   - backup ide u /var/backups/config.php.bak\r
  90 .nf\r
  91 cp_backup_conffile apache.conf squirrelmail-apache.conf\r
  92 .fi\r
  93   - backup ide u /var/backups/squirrelmail-apache.conf.bak\r
  94 cp_backup_conffile -n -d aai preinstall.ldif\r
  95 .fi\r
  96   - backup ide u /var/backups/aai/preinstall.ldif\r
  97 cp_backup_conffile uspjesno zavrsi ako nije bilo potrebno izvrsiti backup, \r
  98 dok cp_check_and_backup u tom slucaju vraca status 3.\r
  99 .TP\r
 100 \fBcp_check_and_sed\fR \fIregexp\fR \fIsed\fR \fIfile\fR [\fIfile\fR ...]\r
 101 Funkcija trazi (egrep) regularni izraz \fIregexp\fR u datotekama, te ako\r
 102 postoji, izvrsi sed program \fIsed\fR nad tim datotekama.  Najcesce se\r
 103 koristi za zamjenu stare vrijednosti postavke novom.\r
 104 .TP\r
 105 \fBcp_echo\fR [\fB-mailonly\fR|\fB-m\fR] \fIstring\fR\r
 106 .TP\r
 107 \fBcp_mail\fR [\fB-q\fR] \fIpackage\fR [\fIversion\fR]\r
 108 U kombinaciji, ove funkcije sluze za slanje poruka na stdout \fUi\fR na\r
 109 mail rootu.  Koristiti za informacije koje svakako treba dostaviti\r
 110 sistemcu (passwordi, nekompatibilne izmjene u konfiguraciji\r
 111 kriticnih servisa), cak i ako ne cita dokumentaciju niti prati\r
 112 poruke kod upgradea. :\-> Paket koji koristi cp_mail() mora imati\r
 113 Depends: mail-transport-agent.\r
 114 .PP\r
 115 cp_echo se koristi umjesto echo.  Uz \fB-m\fR salje poruku samo na mail.\r
 116 cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez\r
 117 \fB-q\fR opcije \fBcp_mail\fR ce ispisati obavijest o slanju tog maila.\r
 118 .PP\r
 119 Ove dvije funkcije koriste globalnu varijablu \fBCP_NOTICE\fR u koju se\r
 120 spremaju poruke za mail.\r
 121 .TP\r
 122 \fBcp_mv\fR \fInew-file\fR \fItarget-file\fR\r
 123 Funkcija cija je namjena da novu datoteku \fInew-file\fR instalira kao\r
 124 zadanu \fItarget-file\fR datoteku, koja moze i/ili ne postojati. Ako ta\r
 125 datoteka postoji onda se novoj dodjeljuje jednako vlasnistvo i modovi\r
 126 pristupa. Operacija je atomicna.\r
 127 .PP\r
 128 Funkcija \fBcp_mv\fR je prikladna za koristenje kod raznih\r
 129 sed-like izmjena neke postojece datoteke iako se za samo sed-anje\r
 130 preporuca koristiti funkciju \fBcp_check_and_sed\fR.\r
 131 .TP\r
 132 \fBcp_yes_no\fR [\fIprompt\fR]\r
 133 Funkcija za jednostavni \fUy\fRes/\fUn\fRo dijalog. Odgovor '\fBy\fR' | '\fBn\fR'\r
 134 vraca u RET. Valja napomenuti da je kao i sve ostalo sto koristi stdin/stdout\r
 135 nekompatibilan s debconfom (doticnog treba ugasiti prvo).\r
 136 .TP\r
 137 \fBcp_db_get\fR \fIpackage\fR\fB/\fR\fIvariable\fR\r
 138 Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane\r
 139 greske vrati prazni \fBRET\fR. Kome treba greska neka ga ne koristi.\r
 140 Funkcija je namijenjena koristenju na mjestu gdje se inace poziva\r
 141 \fBdb_get\fR, sto znaci da korisnik mora sam napraviti sve potrebne\r
 142 predradnje, od \fB. /usr/share/debconf/confmodule\fR nadalje.\r
 143 .TP\r
 144 \fBcp_get_ldap_suffix\fR\r
 145 Funkcija vraca LDAP suffix kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
 146 .TP\r
 147 \fBcp_get_ldap_realm\fR\r
 148 Funkcija vraca LDAP realm kojeg cita iz \fI/etc/ldap/slapd.conf\fR.\r
 149 .TP\r
 150 \fBcp_get_mx_domain\fR\r
 151 Funkcija vraca najopcenitiju domenu ciji MX zapis pokazuje\r
 152 na ovo racunalo. Na primjer, ako se racunalo zove fly.srk.fer.hr\r
 153 i MX zapisi u DNS-u za srk.fer.hr i fer.hr pokazuju na nj,\r
 154 funkcija ce vratiti niz "fer.hr". Ako nije pronadjena ni jedna\r
 155 domena, vraca se FQDN racunala, pa se usporedbom vracene vrijednosti\r
 156 i izlaza `hostname -f` moze ustanoviti je li ovo racunalo MX za\r
 157 domenu.\r
 158 .PP\r
 159 U pravilu, funkcije cije ime pocinje sa \fBcp_get_\fR pohranjuju rezultat\r
 160 u varijabli \fB$RET\fR, a one s prefiksom cp_check_ kao rezultat vracaju \r
 161 exit status.  Pogledajte dolje koje se varijable okruzja mogu upotrijebiti\r
 162 za utjecaj na nacin vracanja povratne vrijednosti.\r
 163 .\"\r
 164 .SH PRIMJER\r
 165 Poziv \fBcp_get_\fRxxx funkcije i preuzimanje rezultata:\r
 166 .Sp\r
 167 .Vb 4\r
 168 \&    . /usr/share/carnet-tools/functions.sh
 169 \&\r
 170 \&    cp_get_ifaddr ppp0\r
 171 \&    addr="$RET"\r
 172 .Ve
 173 Poziv \fBcp_check_\fRxxx funkcije i nastavak toka programa:\r
 174 .Sp\r
 175 .Vb 6\r
 176 \&    . /usr/share/carnet-tools/functions.sh
 177 \&\r
 178 \&    if ! cp_check_and_sed water 's/water/ice/' \\\r
 179 \&                          /dev/fridge; then\r
 180 \&      cp_echo "Clean the /dev/fridge!"\r
 181 \&    fi\r
 182 .Ve
 183 .\"
 184 .SH ENVIRONMENT\r
 185 .TP
 186 \fBCP_ECHO_RETURN\fR\r
 187 .nf\r
 188 kontrola nacina povrata vrijednosti, postaviti na 1\r
 189 \fUnakon\fR ucitavanja datoteke s funkcijama da bi rezultat\r
 190 \fBcp_get_*\fR funkcija isao i na stdout pored postavljanja \fB$RET\fR.\r
 191 .fi\r
 192 .TP\r
 193 \fBCP_SCRIPT_DEBUG\fR\r
 194 .nf\r
 195 potpomaze debugiranje (set -vx)\r
 196 .fi\r
 197 .TP\r
 198 \fBCP_NOTICE\fR\r
 199 .nf\r
 200 tijelo poruke koja se salje na mail\r
 201 .fi\r
 202 .TP\r
 203 \fBRET\fR\r
 204 .nf\r
 205 povratna vrijednost iz \fBcp_get_\fRxxx funkcija\r
 206 .fi
 207 .\"
 208 .SH DATOTEKE
 209 Ne koriste se nikakve posebne datoteke.
 210 .\"
 211 .SH BUGOVI
 212 cp_get_mx_domain ovisi o ispravnom radu DNS sustava.
 213 .\"
 214 .SH AUTORI
 215 Ivan 'ico' Rako, Zoran Dzelajlija, Damir Dzeko,\r
 216 Grupa za izradu paketa <paketi-team@CARNet.hr>.\r
 217 .\"
 218 .SH "VEZANO"\r
 219 .BR cp-update(1)\r
 220 .\" End