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. :\->\r
  92 .PP\r
  93 cp_echo se koristi umjesto echo.  Uz \fB-m\fR salje poruku samo na mail.\r
  94 cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez\r
  95 \fB-q\fR opcije \fBcp_mail\fR ce ispisati obavijest o slanju tog maila.\r
  96 .PP\r
  97 Ove dvije funkcije koriste globalnu varijablu \fBCP_NOTICE\fR u koju se\r
  98 spremaju poruke za mail.\r
  99 .TP\r
 100 \fBcp_mv\fR \fInew-file\fR \fItarget-file\fR\r
 101 Funkcija cija je namjena da novu datoteku \fInew-file\fR instalira kao\r
 102 zadanu \fItarget-file\fR datoteku, koja moze i/ili ne postojati. Ako ta\r
 103 datoteka postoji onda se novoj dodjeljuje jednako vlasnistvo i modovi\r
 104 pristupa. Operacija je atomicna.\r
 105 .PP\r
 106 Funkcija \fBcp_mv\fR je prikladna za koristenje kod raznih\r
 107 sed-like izmjena neke postojece datoteke iako se za samo sed-anje\r
 108 preporuca koristiti funkciju \fBcp_check_and_sed\fR.\r
 109 .TP\r
 110 \fBcp_yes_no\fR [\fIprompt\fR]\r
 111 Funkcija za jednostavni \fUy\fRes/\fUn\fRo dijalog. Odgovor '\fBy\fR' | '\fBn\fR'\r
 112 vraca u RET. Valja napomenuti da je kao i sve ostalo sto koristi stdin/stdout\r
 113 nekompatibilan s debconfom (doticnog treba ugasiti prvo).\r
 114 .TP\r
 115 \fBcp_db_get\fR \fIpackage\fR\fB/\fR\fIvariable\fR\r
 116 Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane\r
 117 greske vrati prazni \fBRET\fR. Kome treba greska neka ga ne koristi.\r
 118 Funkcija je namijenjena koristenju na mjestu gdje se inace poziva\r
 119 \fBdb_get\fR, sto znaci da korisnik mora sam napraviti sve potrebne\r
 120 predradnje, od \fB. /usr/share/debconf/confmodule\fR nadalje.\r
 121 .PP\r
 122 Funkcije cije ime pocinje sa \fBcp_get_\fR pohranjuju rezultat u varijabli \fB$RET\fR,\r
 123 a one s prefiksom cp_check_ kao rezultat vracaju exit status.  U pozivnoj\r
 124 skripti se mogu definirati sljedece varijable koje utjecu na rad svih\r
 125 pomocnih funkcija:\r
 126 \r
 127 .SH PRIMJER\r
 128 Poziv \fBcp_get_\fRxxx funkcije i preuzimanje rezultata:\r
 129 .Sp\r
 130 .Vb 4\r
 131 \&    . /usr/share/carnet-tools/functions.sh
 132 \&\r
 133 \&    cp_get_ifaddr ppp0\r
 134 \&    addr="$RET"\r
 135 .Ve
 136 Poziv \fBcp_check_\fRxxx funkcije i nastavak toka programa:\r
 137 .Sp\r
 138 .Vb 6\r
 139 \&    . /usr/share/carnet-tools/functions.sh
 140 \&\r
 141 \&    if ! cp_check_and_sed watter 's/watter/ice/' \\\r
 142 \&                          /dev/fridge; then\r
 143 \&      cp_echo "Clean the /dev/fridge!"\r
 144 \&    fi\r
 145 .Ve
 146 .\"
 147 .SH ENVIRONMENT
 148 \fBCP_ECHO_RETURN\fR   - kontrola nacina povrata vrijednosti\r
 149 .br\r
 150 .PP\r
 151 \fBCP_SCRIPT_DEBUG\fR  - potpomaze debugiranje (set -vx)\r
 152 .br\r
 153 .PP\r
 154 \fBCP_NOTICE\fR        - tijelo poruke koja se salje na mail\r
 155 .br\r
 156 .PP\r
 157 \fBRET\fR              - povrat vrijednosti iz \fBcp_get_\fRxxx funkcija
 158 .\"
 159 .SH DATOTEKE
 160 Ne koriste se nikakve posebne datoteke.
 161 .\"
 162 .SH BUGOVI
 163 Nema poznatih.
 164 .\"
 165 .SH AUTORI
 166 Ivan 'ico' Rako, Zoran Dzelajlija, Damir Dzeko. SRCE <paketi@srce.hr>.\r
 167 .\"
 168 .SH "VEZANO"\r
 169 .BR cp-update(1)\r
 170 .\" End