slitaz-base-files annotate doc/libtaz.txt @ rev 164
Improve libtaz.sh doc and log function + add log to testsuite.sh
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sat May 12 02:31:39 2012 +0200 (2012-05-12) |
| parents | 524eab3120ae |
| children | 581ddfa0d620 |
| 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 |
| pankso@139 | 8 utilities. It provide common SHell script functions, parse the cmdline |
| pankso@164 | 9 options and store values in a variable. The output messages can be |
| pankso@139 | 10 formated for raw/text, gtk, html and by default they are formated 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@164 | 15 status Return command status [Done|Failed] |
| pankso@164 | 16 separator Display a line separator |
| pankso@164 | 17 newline Echo a new line if gettext or echo -n is used |
| pankso@164 | 18 boldify [string] Usae bold font for term, html or GTK output |
| pankso@164 | 19 indent Ident text in term mode |
| pankso@164 | 20 check_root Check if user is logged as root |
| pankso@164 | 21 confirm Read anser to confirm an action |
| pankso@164 | 22 log [string] Log activity, $activity must be set |
| pankso@139 | 23 |
| pankso@139 | 24 OPTIONS |
| pankso@139 | 25 --output=[raw|gtk|html] |
| pankso@164 | 26 --activity=/path/files/activity |
| pankso@164 | 27 |
| pankso@164 | 28 EXAMPLES |
| pankso@164 | 29 log "Message" |
| pankso@164 | 30 check_root |
| pankso@139 | 31 |
| pankso@139 | 32 AUTHOR |
| pankso@139 | 33 Written by Christophe Lincoln |
| pankso@164 | 34 |