Skip to content

cecho.md

Latest commit

 

History

History
82 lines (45 loc) · 1.83 KB

cecho.md

File metadata and controls

82 lines (45 loc) · 1.83 KB
Raw

src/cecho.bash

Colored Echo: output text in color.

Overview

cecho is a wrapper around tput and echo for outputting colored text.

Index

cecho

cecho is a wrapper around tput and echo for outputting colored text.

cecho support one of these text color modifiers:

  • 'black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'

cecho support one of these background color modifiers:

  • 'bgBlack', 'bgRed', 'bgGreen', 'bgYellow', 'bgBlue', 'bgMagenta', 'bgCyan', 'bgWhite'

cecho support one or more of these styles modifiers:

  • 'bold', 'stout', 'under', 'blink', 'reverse', 'italic'

cecho provides theses custom styles:

  • 'INFO', 'WARNING', 'ERROR', 'SUCCESS', 'DEBUG'

Example

source "${BASH_SOURCE[0]%/*}/libs/biapy-bashlings/src/cecho.bash"
cecho "red bold reverse" "A reversed red bold text"
cecho "INFO" "Info: there is news !"
cecho "ERROR" "Error: the news is false !"
cecho "DEBUG" "Debug: \$news is set by a waring party."

Options

  • -f | --force

    Force colored output to pipe. Allow to print colored output in files.

  • -n

    Do not output the trailing newline

  • -e

    Enable interpretation of backslash escapes

  • -E

    Disable interpretation of backslash escapes (default)

Arguments

  • $1 (string): (optional) The output color style ( color + background color + styles).
  • ... (string): The outputted contents.

Exit codes

  • 0: If the text is outputted successfully.
  • 1: If $1 contains an unsupported color code.

Output on stdout

  • A colored (or not) text. If stdout is a pipe, the coloring is disabled unless `--force`` is used.

Output on stderr

  • Error if $1 contains an unsupported code.

See also