slitaz-base-files view doc/libtaz.txt @ rev 166
Edit docs
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Sat May 12 21:08:08 2012 +0100 (2012-05-12) |
| parents | dd17cc10cd6d |
| children | 1db99ad848a8 |
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 indent Indent text in term mode
20 check_root Check if user is logged as root
21 confirm Read answer to confirm an action
22 log [string] Log activity, $activity must be set
24 OPTIONS
25 --output=[raw|gtk|html]
26 --activity=/path/files/activity
28 EXAMPLES
29 log "Message"
30 check_root
32 AUTHORS
33 Written by Christophe Lincoln