-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
49 lines (35 loc) · 1.38 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
NAME
CLI::Display - a set of text display helpers, and more, for command line
tools.
SYNOPSIS
use CLI::Display qw/:prints continue_or_abort/;
print_g "this is my green: ", $text, "\n";
print_y "highlighting this using yellow color\n";
print_e "a multi "; print_y "color "; print_g "line"; print "...\n";
# wait for user to continue or abort the script and indent
# all output by 1 tab
continue_or_abort 1;
DESCRIPTION
A simple lib of methods that help colorize your CLI tool output using
the Term::ANSIColor lib.
More helpers are introduced as I need more for my CLI tools.
FUNCTIONS
print_g (@)
Works just like regular 'print' but it colors the output as green.
print_y (@)
Same as print_g but uses yellow.
print_r (@)
Same as print_g but uses red.
continue_or_abort (@)
Halts the script waiting for user input, which needs to be either 'y' or
'n'.
SEE ALSO
Term::ANSIColor::Print a much better alternative if you want something
more complex in generating output. It's OO though.
AUTHOR
J.B. Ribeiro, <vredens@gmail.com>
COPYRIGHT AND LICENSE
Copyright (C) 2012 by J.B. Ribeiro
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself, either Perl version 5.12.3 or, at
your option, any later version of Perl 5 you may have available.