update README to cover new inline media escapes.
SVN revision: 83872
This commit is contained in:
parent
84047693f8
commit
6f6b57d141
52
README
52
README
|
@ -82,7 +82,7 @@ Ctrl+Wheel = zoom font size up/down
|
|||
|
||||
Extended escapes for terminology only:
|
||||
|
||||
[\033][{][COMMAND][\000]
|
||||
[\033][}][COMMAND][\000]
|
||||
i.e.
|
||||
1. ESC char (\033 or 0x1b)
|
||||
2. } char
|
||||
|
@ -112,10 +112,10 @@ pq[FULL-PATH-OR-URL]
|
|||
= quque a popup for the given media file/url
|
||||
|
||||
bt[FULL-PATH-OR-URL]
|
||||
= set the terminal background me3edia file/url temporarily
|
||||
= set the terminal background media file/url temporarily
|
||||
|
||||
bp[FULL-PATH-OR-URL]
|
||||
= set the terminal background me3edia file/url permanently
|
||||
= set the terminal background media file/url permanently
|
||||
|
||||
at[on/true/yes/off/false/no]
|
||||
= set the terminal alpha state to be on, or off temporarily
|
||||
|
@ -131,3 +131,49 @@ qs
|
|||
where FW is the width of 1 character cell in pixels
|
||||
where FH is the height of 1 character cell in pixels
|
||||
|
||||
is[CW;H;FULL-PATH-OR-URL]
|
||||
= insert STRETCHED media (where image will stretch to fill the cell area)
|
||||
and define expected cell area to be W cells wide and H cells high,
|
||||
with the image/media/url.
|
||||
where C is the replace character to be identified in later text
|
||||
where W is the width in character cells (up to 511).
|
||||
where H is the height in character cells (up to 511).
|
||||
|
||||
note that this escape alone has no effect. it indicates a future
|
||||
intention of inserting media into the terminal. the terminal will
|
||||
EXPECT a grid of WxH "replace characters" to follow, with each
|
||||
sequence of such replace characters bebung with a 'ib' escape command
|
||||
and ending with an 'ie' escape command.
|
||||
|
||||
example:
|
||||
|
||||
printf("\033}is#5;3;%s\000"
|
||||
"\033}ib#####\033}ie\n"
|
||||
"\033}ib#####\033}ie\n"
|
||||
"\033}ib#####\033}ie\n", "/tmp/icon.png");
|
||||
|
||||
note that '#' is the replace character, and later '#' chars if inside
|
||||
begin/end escapes, will be replaced by the given media indicated
|
||||
in the insert media escape.
|
||||
|
||||
ic[CW;H;FULL-PATH-OR-URL]
|
||||
= insert CENTERED media (centered in cell area). otherwise paramaters are
|
||||
identical to the "is" command, but retains aspect and is padded by
|
||||
blank space.
|
||||
|
||||
if[CW;H;FULL-PATH-OR-URL]
|
||||
= insert FILLED media (fill in cell area). otherwise paramaters are
|
||||
identical to the "is" command but ensures the entire area is
|
||||
filled like a background even if media goes beyond cell bounds and is
|
||||
clipped.
|
||||
|
||||
it[CW;H;FULL-PATH-OR-URL]
|
||||
= insert THUMB media (thumbnail cell area). otherwise paramaters are
|
||||
identical to the "is" command, but uses thumbnail generation to
|
||||
make a fast to load but low resolution version (cached) of the media.
|
||||
|
||||
ib
|
||||
= begin media replace sequence run
|
||||
|
||||
ie
|
||||
= end media replace sequence run
|
||||
|
|
Loading…
Reference in New Issue