NAME

ANSI Encode

SYNOPSIS

A markup language to generate basic ANSI text

AUTHOR & COPYRIGHT

Richard Kelsch

Copyright (C) 2025 Richard Kelsch
All Rights Reserved
GNU Public License 3.0

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 one space on each side)

For example:

[% 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)
CLEAR      = Places cursor at top left, screen cleared
CLS        = Same as CLEAR
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

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 BLINK  = Slow cursor blink
RAPID BLINK = Rapid cursor blink

ATTRIBUTES

INVERT       = Invert text (flip background and foreground attributes)
REVERSE      = Reverse
CROSSED OUT  = Crossed out
DEFAULT FONT = Default font

COLORS

NORMAL = Sets colors to default

FOREGROUND

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

BACKGROUND

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