slitaz-base-files annotate doc/libtaz.txt @ rev 219
libtaz.sh: add (and use) short gettext aliases: _ and _n
| author | Aleksej Bobylev <al.bobylev@gmail.com> |
|---|---|
| date | Fri Aug 09 15:38:43 2013 +0300 (2013-08-09) |
| parents | d4df77afbed6 |
| children | 259c174621c7 |
| 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 |
| al@219 | 15 _ string Short name for "gettext string; echo" |
| al@219 | 16 _n string Short name for "gettext string" |
| pankso@167 | 17 status Return command status [Done|Failed] |
| pankso@167 | 18 separator Display a line separator |
| pankso@167 | 19 newline Echo a new line if gettext or echo -n is used |
| pankso@167 | 20 boldify [string] Use a bold font for term, html or GTK output |
| al@193 | 21 colorize NB [string] Colorize a string in term mode |
| pankso@171 | 22 indent NB [string] Indent text in term mode |
| al@193 | 23 emsg [string] Output mark up messages |
| pankso@167 | 24 check_root Check if user is logged as root |
| pankso@171 | 25 debug [string] Display a DEBUG message when --debug is used |
| pankso@167 | 26 confirm Read answer to confirm an action |
| pankso@167 | 27 log [string] Log activity, $activity must be set |
| pankso@139 | 28 |
| pankso@139 | 29 OPTIONS |
| pankso@139 | 30 --output=[raw|gtk|html] |
| pankso@164 | 31 --activity=/path/files/activity |
| pankso@164 | 32 |
| pankso@164 | 33 EXAMPLES |
| pankso@164 | 34 log "Message" |
| pankso@164 | 35 check_root |
| al@193 | 36 emsg "<b>bold</b> <c 31>red</c> <c 32>green</c> separator<-> newline<n> <i 26>indent" |
| pankso@139 | 37 |
| paul@166 | 38 AUTHORS |
| pankso@139 | 39 Written by Christophe Lincoln |
| pankso@164 | 40 |