summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2013-02-13 13:29:44 +0000
committerCarsten Haitzler <raster@rasterman.com>2013-02-13 13:29:44 +0000
commit6f6b57d141a1c35053f98a22d33c245a4937bba8 (patch)
tree808fafe918809cf1674969b88cb55f458656c218 /README
parent84047693f8e2aee581025918454ecfd68b0bdc06 (diff)
update README to cover new inline media escapes.
SVN revision: 83872
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 49 insertions, 3 deletions
diff --git a/README b/README
index bdafdc7..0b488e4 100644
--- a/README
+++ b/README
@@ -82,7 +82,7 @@ Ctrl+Wheel = zoom font size up/down
82 82
83Extended escapes for terminology only: 83Extended escapes for terminology only:
84 84
85[\033][{][COMMAND][\000] 85[\033][}][COMMAND][\000]
86i.e. 86i.e.
87 1. ESC char (\033 or 0x1b) 87 1. ESC char (\033 or 0x1b)
88 2. } char 88 2. } char
@@ -112,10 +112,10 @@ pq[FULL-PATH-OR-URL]
112 = quque a popup for the given media file/url 112 = quque a popup for the given media file/url
113 113
114bt[FULL-PATH-OR-URL] 114bt[FULL-PATH-OR-URL]
115 = set the terminal background me3edia file/url temporarily 115 = set the terminal background media file/url temporarily
116 116
117bp[FULL-PATH-OR-URL] 117bp[FULL-PATH-OR-URL]
118 = set the terminal background me3edia file/url permanently 118 = set the terminal background media file/url permanently
119 119
120at[on/true/yes/off/false/no] 120at[on/true/yes/off/false/no]
121 = set the terminal alpha state to be on, or off temporarily 121 = set the terminal alpha state to be on, or off temporarily
@@ -131,3 +131,49 @@ qs
131 where FW is the width of 1 character cell in pixels 131 where FW is the width of 1 character cell in pixels
132 where FH is the height of 1 character cell in pixels 132 where FH is the height of 1 character cell in pixels
133 133
134is[CW;H;FULL-PATH-OR-URL]
135 = insert STRETCHED media (where image will stretch to fill the cell area)
136 and define expected cell area to be W cells wide and H cells high,
137 with the image/media/url.
138 where C is the replace character to be identified in later text
139 where W is the width in character cells (up to 511).
140 where H is the height in character cells (up to 511).
141
142 note that this escape alone has no effect. it indicates a future
143 intention of inserting media into the terminal. the terminal will
144 EXPECT a grid of WxH "replace characters" to follow, with each
145 sequence of such replace characters bebung with a 'ib' escape command
146 and ending with an 'ie' escape command.
147
148 example:
149
150 printf("\033}is#5;3;%s\000"
151 "\033}ib#####\033}ie\n"
152 "\033}ib#####\033}ie\n"
153 "\033}ib#####\033}ie\n", "/tmp/icon.png");
154
155 note that '#' is the replace character, and later '#' chars if inside
156 begin/end escapes, will be replaced by the given media indicated
157 in the insert media escape.
158
159ic[CW;H;FULL-PATH-OR-URL]
160 = insert CENTERED media (centered in cell area). otherwise paramaters are
161 identical to the "is" command, but retains aspect and is padded by
162 blank space.
163
164if[CW;H;FULL-PATH-OR-URL]
165 = insert FILLED media (fill in cell area). otherwise paramaters are
166 identical to the "is" command but ensures the entire area is
167 filled like a background even if media goes beyond cell bounds and is
168 clipped.
169
170it[CW;H;FULL-PATH-OR-URL]
171 = insert THUMB media (thumbnail cell area). otherwise paramaters are
172 identical to the "is" command, but uses thumbnail generation to
173 make a fast to load but low resolution version (cached) of the media.
174
175ib
176 = begin media replace sequence run
177
178ie
179 = end media replace sequence run