r37: Skracen readme - referira na man-stranice.
authorDamir Dzeko <Damir.Dzeko@CARNet.hr>
Thu, 31 Mar 2005 07:34:10 +0000 (07:34 +0000)
committerDamir Dzeko <Damir.Dzeko@CARNet.hr>
Thu, 31 Mar 2005 07:34:10 +0000 (07:34 +0000)
README.CARNet

index 3ddfb05..0cd8a17 100644 (file)
@@ -12,96 +12,11 @@ Trenutna verzija sadrzi:
  - /usr/share/carnet-tools/functions.sh datoteku koja sadrzi sljedece
    shell funkcije:
 
-cp_get_ifaddr <interface>
+Man-stranice  cp-update(1) i  carnet-tools(8) donose popis funkcija koje
+ti alati podrzavaju/sadrzavaju te upute za njihovo koristenje.
 
-       Funkcija vraca IP adresu mreznog sucelja. U slucaju da nije
-       naveden kao argument, vraca IP adresu od loopback sucelja (lo).
+O eventualnim problemima / ispravkama / zahtjevima za novim funkcijama
+posaljite poruku Grupi za izradu paketa <paketi@srce.hr>.
 
-cp_get_ifmask <interface>
+ -- Damir Dzeko <ddzeko@srce>  Thu, 31 Mar 2005 09:29:28 +0200
 
-       Funkcija vraca IP netmask mreznog sucelja. U slucaju da nije
-       naveden kao argument, vraca IP netmask od loopback sucelja (lo).
-
-cp_get_ifdefault [dev|addr]
-
-       Funkcija vraca naziv uredjaj ili adresu podrazumne rute (default
-       route).
-
-cp_get_netaddr <interface>
-
-       Funkcija vraca podmrezu mreznog sucelja u CIDR obliku.  U slucaju
-       da nije naveden <interface> argument, vraca CIDR sucelja preko
-       kojeg ide default route, a ako isti nije definiran, vraca CIDR
-       loopback sucelja (lo).
-
-cp_backup_conffile <file>
-
-       Funkcija backupira datoteku u /var/backups/ direktorij. Po
-       potrebi rotira, ako postoje neke razlike.
-
-cp_check_and_sed <regexp> <sed> <file> [<file> ...]
-
-       Funkcija trazi regularni izraz <regexp> u datotekama, te ako
-       postoji, izvrsi sed program <sed> nad tim datotekama.  Najcesce se
-       koristi za zamjenu stare vrijednosti postavke novom.
-
-cp_echo [-mailonly|-m] <string>
-
-cp_mail [-q] <package> <version>
-
-       U kombinaciji, ove funkcije sluze za slanje poruka na stdout _i_ 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. :->
-
-       cp_echo se koristi umjesto echo.  Uz -m salje poruku samo na mail.
-       cp_mail se poziva na kraju (postinsta), kad posalje mail.  Bez
-       -q opcije cp_mail ce ispisati obavijest o slanju tog maila.
-
-       Ove dvije funkcije koriste globalnu varijablu CP_NOTICE u koju se
-       spremaju poruke za mail.
-
-cp_mv <new-file> <target-file>
-
-       Funkcija cija je namjena da novu datoteku <new-file> instalira kao
-       zadanu <target-file> datoteku, koja moze i/ili ne postojati. Ako ta
-       datoteka postoji onda se novoj dodjeljuje njeno vlasnistvo i modovi
-       pristupa. Operacija je atomicna.
-
-       Funkcija cp_mv je prikladna za koristenje kod raznih sed-like
-       izmjena neke postojece datoteke iako se za samo sed-anje preporuca
-       koristiti funkciju cp_check_and_sed.
-
-cp_yes_no [<prompt>]
-
-       Funkcija za jednostavni (y)es/(n)o dijalog. Odgovor y/n vraca u RET.
-       Valja napomenuti da je kao i sve ostalo sto trosi stdin/stdout 
-       nekompatibilan s debconfom (doticnog treba pogasiti prvo).
-
-cp_db_get <package>/<variable>
-
-       Wrapper za debconfovu funkciju db_get koji umjesto neke neocekivane
-       greske vrati prazni RET. Kome treba greska neka ga ne koristi.
-       Funkcija je namijenjena koristenju na mjestu gdje se inace poziva 
-       db_get, sto znaci da korisnik mora sam napraviti sve potrebne 
-       predradnje, od  . /usr/share/debconf/confmodule  nadalje.
-
-Funkcije cije ime pocinje sa cp_get_ pohranjuju rezultat u varijabli $RET,
-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:
-
-$CP_SCRIPT_DEBUG
-
-       Potpomaze debugiranje (set -vx).
-
-$CP_ECHO_RETURN
-
-       Vracanje rezultata na stdout i u varijabli $RET.
-       Ako se cp_ funkcija koja vraca string poziva unutar neke druge cp_
-       funkcije, treba iskljucivo koristiti $RET konvenciju, i sacuvati
-       prethodno stanje varijable CP_ECHO_RETURN.
-
-
--- Ivan 'ico' Rako <irako@srce.hr>  Wed, 16 Mar 2005 14:25:14 +0100