slitaz-base-files annotate doc/libtaz.txt @ rev 193
remove unboldify(), add emsg(); small fix i18n; make pot && make msgmerge, up ru.po
| author | Aleksej Bobylev <al.bobylev@gmail.com> |
|---|---|
| date | Sun Jun 03 14:09:18 2012 +0000 (2012-06-03) |
| parents | 4ca3c7426952 |
| children | b2311939ad7e |
| rev | line source |
|---|---|
| pankso@139 | 1 |
| pankso@139 | 2 SYNOPSIS |
| pankso@139 | 3 . /lib/libtaz.sh |
| pankso@139 | 4 function |
| pankso@139 | 5 |
| pankso@139 | 6 DESCRIPTION |
| pankso@139 | 7 LibTaz is the base SliTaz SHell library used by almost all tools and |
| paul@166 | 8 utilities. It provides common SHell script functions, parses the cmdline |
| pankso@164 | 9 options and store values in a variable. The output messages can be |
| paul@166 | 10 formatted for raw/text, gtk, html and by default they are formatted for |
| pankso@139 | 11 a standard terminal supporting colors. LibTaz is in the directory |
| pankso@139 | 12 /lib/libtaz.sh since it is used when /usr may not be mounted. |
| pankso@164 | 13 |
| pankso@139 | 14 FUNCTIONS |
| pankso@167 | 15 status Return command status [Done|Failed] |
| pankso@167 | 16 separator Display a line separator |
| pankso@167 | 17 newline Echo a new line if gettext or echo -n is used |
| pankso@167 | 18 boldify [string] Use a bold font for term, html or GTK output |
| al@193 | 19 colorize NB [string] Colorize a string in term mode |
| pankso@171 | 20 indent NB [string] Indent text in term mode |
| al@193 | 21 emsg [string] Output mark up messages |
| pankso@167 | 22 check_root Check if user is logged as root |
| pankso@171 | 23 debug [string] Display a DEBUG message when --debug is used |
| pankso@167 | 24 confirm Read answer to confirm an action |
| pankso@167 | 25 log [string] Log activity, $activity must be set |
| pankso@139 | 26 |
| pankso@139 | 27 OPTIONS |
| pankso@139 | 28 --output=[raw|gtk|html] |
| pankso@164 | 29 --activity=/path/files/activity |
| pankso@164 | 30 |
| pankso@164 | 31 EXAMPLES |
| pankso@164 | 32 log "Message" |
| pankso@164 | 33 check_root |
| al@193 | 34 emsg "<b>bold</b> <c 31>red</c> <c 32>green</c> separator<-> newline<n> <i 26>indent" |
| pankso@139 | 35 |
| paul@166 | 36 AUTHORS |
| pankso@139 | 37 Written by Christophe Lincoln |
| pankso@164 | 38 |