slitaz-base-files annotate doc/libtaz.txt @ rev 171
Make pot/msgmerge and up libtaz doc
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Thu May 17 08:57:20 2012 +0200 (2012-05-17) |
| parents | 1db99ad848a8 |
| children | d4df77afbed6 |
| 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 |
| pankso@167 | 19 colorize [string] NB Colorize a string in term mode |
| pankso@171 | 20 indent NB [string] Indent text in term mode |
| pankso@167 | 21 check_root Check if user is logged as root |
| pankso@171 | 22 debug [string] Display a DEBUG message when --debug is used |
| pankso@167 | 23 confirm Read answer to confirm an action |
| pankso@167 | 24 log [string] Log activity, $activity must be set |
| pankso@139 | 25 |
| pankso@139 | 26 OPTIONS |
| pankso@139 | 27 --output=[raw|gtk|html] |
| pankso@164 | 28 --activity=/path/files/activity |
| pankso@164 | 29 |
| pankso@164 | 30 EXAMPLES |
| pankso@164 | 31 log "Message" |
| pankso@164 | 32 check_root |
| pankso@139 | 33 |
| paul@166 | 34 AUTHORS |
| pankso@139 | 35 Written by Christophe Lincoln |
| pankso@164 | 36 |