/ 
Term-ANSIEncode-1.33
River stage zero No dependents
/ ANSI

NAME

ANSI Encode

SYNOPSIS

A markup language to generate basic ANSI text

USAGE

ansi_encode.pl file

OPTIONS

--version or -v

Shows name, version information and brief licensing information.

--help or -h

Simple usage and options documentation

--tokens or -y

Shows the most used tokens available. A token is encapsulated within [% and %] (with at lease one space on each side)

--rawtokens or r

Raw dump of useable tokens.

--symbols or -s [search]

Similar to "tokens", but instead shows special symbol character tokens names.

You may also add a search string to shorten the list.

IT IS HIGHLY SUGGESTED YOU USE A SEARCH STRING.

--unicode or -u [search]

Similar to "tokens", but instead shows special symbol characters by unicode.

You may also add a search string to shorten the list.

IT IS HIGHLY SUGGESTED YOU USE A SEARCH STRING.

--dump or -d [search]

Does a raw dump of the symbols.

    [% RED %]This is written in red[% RESET %]

    RESET changes output text to normal.

TOKENS

GENERAL

[% RETURN %]

ASCII RETURN (13)

[% LINEFEED %]

ASCII LINEFEED (10)

[% NEWLINE %]

RETURN + LINEFEED (13 + 10)

[% CLS %]

Places cursor at top left, screen cleared

[% CLEAR %]

Clear screen only, cursor remains where it was

[% CLEAR LINE %]

Clear to the end of line

[% CLEAR DOWN %]

Clear down from current cursor position

[% CLEAR UP %]

Clear up from current cursor position

[% RESET %]

Reset all colors and attributes

CURSOR

[% HOME %]

Moves the cursor to the location 1,1.

[% UP %]

Moves cursor up one step

[% DOWN %]

Moves cursor down one step

[% RIGHT %]

Moves cursor right one step

[% LEFT %]

Moves cursor left one step

[% SAVE %]

Save cursor position

[% RESTORE %]

Place cursor at saved position

[% BOLD %]

Bold text (not all terminals support this)

[% FAINT %]

Faded text (not all terminals support this)

[% ITALIC %]

Italicized text (not all terminals support this)

[% UNDERLINE %]

Underlined text

Slow cursor blink

Rapid cursor blink

[% LOCATE column,row %]

Set cursor position

ATTRIBUTES

[% INVERT %]

Invert text (flip background and foreground attributes)

[% REVERSE %]

Reverse

[% CROSSED OUT %]

Crossed out

{% DEFAULT FONT %]

Default font

FRAMES

[% BOX color,x,y,width,height,type %] text here [% ENDBOX %]

Draw a frame around text

COLORS

[% NORMAL %]

Sets colors to default

FOREGROUND

BLACK = Black =item RED = Red =item PINK = Hot pink =item ORANGE = Orange =item NAVY = Deep blue =item GREEN = Green =item YELLOW = Yellow =item BLUE = Blue =item MAGENTA = Magenta =item CYAN = Cyan =item WHITE = White =item DEFAULT = Default foreground color =item BRIGHT BLACK = Bright black (dim grey) =item BRIGHT RED = Bright red =item BRIGHT GREEN = Lime =item BRIGHT YELLOW = Bright Yellow =item BRIGHT BLUE = Bright blue =item BRIGHT MAGENTA = Bright magenta =item BRIGHT CYAN = Bright cyan =item BRIGHT WHITE = Bright white

BACKGROUND

B_BLACK = Black =item B_RED = Red =item B_GREEN = Green =item B_YELLOW = Yellow =item B_BLUE = Blue =item B_MAGENTA = Magenta =item B_CYAN = Cyan =item B_WHITE = White =item B_DEFAULT = Default background color =item B_PINK = Hot pink =item B_ORANGE = Orange =item B_NAVY = Deep blue =item BRIGHT B_BLACK = Bright black (grey) =item BRIGHT B_RED = Bright red =item BRIGHT B_GREEN = Lime =item BRIGHT B_YELLOW = Bright yellow =item BRIGHT B_BLUE = Bright blue =item BRIGHT B_MAGENTA = Bright magenta =item BRIGHT B_CYAN = Bright cyan =item BRIGHT B_WHITE = Bright white

HORIZONAL RULES

Makes a solid blank line, the full width of the screen with the selected background color

HORIZONTAL RULE RED = A solid line of red background =item HORIZONTAL RULE GREEN = A solid line of green background =item HORIZONTAL RULE YELLOW = A solid line of yellow background =item HORIZONTAL RULE BLUE = A solid line of blue background =item HORIZONTAL RULE MAGENTA = A solid line of magenta background =item HORIZONTAL RULE CYAN = A solid line of cyan background =item HORIZONTAL RULE PINK = A solid line of hot pink background =item HORIZONTAL RULE ORANGE = A solid line of orange background =item HORIZONTAL RULE WHITE = A solid line of white background =item HORIZONTAL RULE BRIGHT RED = A solid line of bright red background =item HORIZONTAL RULE BRIGHT GREEN = A solid line of bright green background =item HORIZONTAL RULE BRIGHT YELLOW = A solid line of bright yellow background =item HORIZONTAL RULE BRIGHT BLUE = A solid line of bright blue background =item HORIZONTAL RULE BRIGHT MAGENTA = A solid line of bright magenta background =item HORIZONTAL RULE BRIGHT CYAN = A solid line of bright cyan background =item HORIZONTAL RULE BRIGHT WHITE = A solid line of bright white background

AUTHOR & COPYRIGHT

Richard Kelsch

Copyright (C) 2025 Richard Kelsch
All Rights Reserved
Perl Artistic License

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

16 POD Errors

The following errors were encountered while parsing the POD:

Around line 496:

'=item' outside of any '=over'

Around line 532:

You forgot a '=back' before '=head2'

Around line 534:

'=item' outside of any '=over'

Around line 590:

You forgot a '=back' before '=head2'

Around line 592:

'=item' outside of any '=over'

Around line 608:

You forgot a '=back' before '=head2'

Around line 610:

'=item' outside of any '=over'

Around line 614:

You forgot a '=back' before '=head2'

Around line 616:

'=item' outside of any '=over'

Around line 620:

You forgot a '=back' before '=head2'

Around line 622:

'=item' outside of any '=over'

Around line 643:

You forgot a '=back' before '=head2'

Around line 645:

'=item' outside of any '=over'

Around line 666:

You forgot a '=back' before '=head2'

Around line 670:

'=item' outside of any '=over'

Around line 687:

You forgot a '=back' before '=head1'