slitaz-base-files view doc/libtaz.txt @ rev 167

Add colorize() to libtaz.sh
author Christophe Lincoln <pankso@slitaz.org>
date Tue May 15 15:48:14 2012 +0200 (2012-05-15)
parents 581ddfa0d620
children 4ca3c7426952
line source
2 SYNOPSIS
3 . /lib/libtaz.sh
4 function
6 DESCRIPTION
7 LibTaz is the base SliTaz SHell library used by almost all tools and
8 utilities. It provides common SHell script functions, parses the cmdline
9 options and store values in a variable. The output messages can be
10 formatted for raw/text, gtk, html and by default they are formatted for
11 a standard terminal supporting colors. LibTaz is in the directory
12 /lib/libtaz.sh since it is used when /usr may not be mounted.
14 FUNCTIONS
15 status Return command status [Done|Failed]
16 separator Display a line separator
17 newline Echo a new line if gettext or echo -n is used
18 boldify [string] Use a bold font for term, html or GTK output
19 colorize [string] NB Colorize a string in term mode
20 indent Indent text in term mode
21 check_root Check if user is logged as root
22 confirm Read answer to confirm an action
23 log [string] Log activity, $activity must be set
25 OPTIONS
26 --output=[raw|gtk|html]
27 --activity=/path/files/activity
29 EXAMPLES
30 log "Message"
31 check_root
33 AUTHORS
34 Written by Christophe Lincoln