slitaz-base-files diff 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 |
line diff
1.1 --- a/doc/libtaz.txt Tue Apr 24 10:26:35 2012 +0200 1.2 +++ b/doc/libtaz.txt Sat May 12 02:31:39 2012 +0200 1.3 @@ -6,20 +6,29 @@ 1.4 DESCRIPTION 1.5 LibTaz is the base SliTaz SHell library used by almost all tools and 1.6 utilities. It provide common SHell script functions, parse the cmdline 1.7 - options and store values in a variable. The output messages can be 1.8 + options and store values in a variable. The output messages can be 1.9 formated for raw/text, gtk, html and by default they are formated for 1.10 a standard terminal supporting colors. LibTaz is in the directory 1.11 /lib/libtaz.sh since it is used when /usr may not be mounted. 1.12 - 1.13 + 1.14 FUNCTIONS 1.15 - status 1.16 - separator 1.17 - boldify [string] 1.18 - check_root 1.19 + status Return command status [Done|Failed] 1.20 + separator Display a line separator 1.21 + newline Echo a new line if gettext or echo -n is used 1.22 + boldify [string] Usae bold font for term, html or GTK output 1.23 + indent Ident text in term mode 1.24 + check_root Check if user is logged as root 1.25 + confirm Read anser to confirm an action 1.26 + log [string] Log activity, $activity must be set 1.27 1.28 OPTIONS 1.29 --output=[raw|gtk|html] 1.30 + --activity=/path/files/activity 1.31 + 1.32 +EXAMPLES 1.33 + log "Message" 1.34 + check_root 1.35 1.36 AUTHOR 1.37 Written by Christophe Lincoln 1.38 - 1.39 +