summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorThanatermesis <thanatermesis@gmail.com>2014-02-03 17:11:38 +0100
committerThanatermesis <thanatermesis@gmail.com>2014-02-03 17:11:38 +0100
commit4641ad1a0519138ff53b99d1c706c658680c17c3 (patch)
tree89aa3db7d5a1d029f1227574a52c789955ffbd3a /man
parentff02942bdbbe5907cf146667e5eafc8e19cc0f73 (diff)
improved manpage in formatting and a small bugfix
- The example code for the escape terminology command was rendered incorrectly in the manpage, this is now fixed - the formating was wrong rendered viewing with man, having too much newlines that broke the structure, this is better aligned now
Diffstat (limited to 'man')
-rw-r--r--man/terminology.1103
1 files changed, 47 insertions, 56 deletions
diff --git a/man/terminology.1 b/man/terminology.1
index e5864aa..064e074 100644
--- a/man/terminology.1
+++ b/man/terminology.1
@@ -285,74 +285,69 @@ i.e.
285 3... sequence of UTF8 chars other than nul (\\000 or 0x00). 285 3... sequence of UTF8 chars other than nul (\\000 or 0x00).
286 4 \\000 char (nul byte or 0x00 to indicate end of sequence) 286 4 \\000 char (nul byte or 0x00 to indicate end of sequence)
287e.g. 287e.g.
288 echo \-n '\\033}Hello world\000' 288 echo \-n '\\033}Hello world\\000'
289 289
290.B Commands: 290.B Commands:
291 291
292any values inside square brackets [] are to be replaced by some 292any values inside square brackets [] are to be replaced by some content (numbers, strings, paths, url's etc.). example:
293content (numbers, strings, paths, url's etc.). example:
294 293
295aa[PATH\-OF\-FILE] should be come something like: 294aa[PATH\-OF\-FILE] should be come something like:
296 aa/tmp/file.png 295 aa/tmp/file.png\n
297or aa[true/false] should become something like: 296or aa[true/false] should become something like:
298 aatrue 297 aatrue\n
299or 298or
300 aafalse 299 aafalse\n
301 300
302\-\-\- 301\-\-\-
303 302
304pn[FULL\-PATH\-OR\-URL] 303pn[FULL\-PATH\-OR\-URL]
305 = popup the given media file/url now 304 popup the given media file/url now
306 305
307pq[FULL\-PATH\-OR\-URL] 306pq[FULL\-PATH\-OR\-URL]
308 = quque a popup for the given media file/url 307 quque a popup for the given media file/url
309 308
310bt[FULL\-PATH\-OR\-URL] 309bt[FULL\-PATH\-OR\-URL]
311 = set the terminal background media file/url temporarily 310 set the terminal background media file/url temporarily
312 311
313bp[FULL\-PATH\-OR\-URL] 312bp[FULL\-PATH\-OR\-URL]
314 = set the terminal background media file/url permanently 313 set the terminal background media file/url permanently
315 314
316at[on/true/yes/off/false/no] 315at[on/true/yes/off/false/no]
317 = set the terminal alpha state to be on, or off temporarily 316 set the terminal alpha state to be on, or off temporarily
318 317
319ap[on/true/yes/off/false/no] 318ap[on/true/yes/off/false/no]
320 = set the terminal alpha state to be on, or off permanently 319 set the terminal alpha state to be on, or off permanently
321 320
322qs 321qs
323 = query grid and font size. stdin will have written to it: 322 query grid and font size. stdin will have written to it:
324 W;H;FW;FH\n 323 W;H;FW;FH\n
325 where W is the width of the terminal grid in characters 324 where W is the width of the terminal grid in characters\n
326 where H is the height of the terminal grid in characters 325 where H is the height of the terminal grid in characters\n
327 where FW is the width of 1 character cell in pixels 326 where FW is the width of 1 character cell in pixels\n
328 where FH is the height of 1 character cell in pixels 327 where FH is the height of 1 character cell in pixels\n
329 328
330is[CW;H;FULL\-PATH\-OR\-URL] 329is[CW;H;FULL\-PATH\-OR\-URL]
331 = insert STRETCHED media (where image will stretch to fill the cell area) 330 insert STRETCHED media (where image will stretch to fill the
332 and define expected cell area to be W cells wide and H cells high, 331 cell area) and define expected cell area to be W cells
333 with the image/media/url. 332 wide and H cells high, with the image/media/url.\n
334 where C is the replace character to be identified in later text 333 where C is the replace character to be identified in later
335 where W is the width in character cells (up to 511). 334 text where W is the width in character cells (up to 511).\n
336 where H is the height in character cells (up to 511). 335 where H is the height in character cells (up to 511).\n
337 336
338 note that this escape alone has no effect. it indicates a future 337 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.\n
339 intention of inserting media into the terminal. the terminal will
340 EXPECT a grid of WxH "replace characters" to follow, with each
341 sequence of such replace characters bebung with a 'ib' escape command
342 and ending with an 'ie' escape command.
343 338
344 the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may 339 the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may be of the form:
345 be of the form:
346 340
347 /full/path/to/file.png 341 /full/path/to/file.png
348 342
349 OR 343 OR
350 344
351 /full/path/to/link\n/full/path/to/file.png 345 /full/path/to/link\n/full/path/to/file.png
352 346
353 where a newline character separates a URI for a link and a full 347 where a newline character separates a URI for a link and
354 path to a file to display in the region. the link is the 348 a full path to a file to display in the region. the link
355 destination URI when a user may clikc on the given media image. 349 is the destination URI when a user may clikc on the given
350 media image.
356 351
357 example: 352 example:
358 353
@@ -361,37 +356,33 @@ is[CW;H;FULL\-PATH\-OR\-URL]
361 "\\\033}ib#####\\\033}ie\\\n" 356 "\\\033}ib#####\\\033}ie\\\n"
362 "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png"); 357 "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png");
363 358
364 note that '#' is the replace character, and later '#' chars if inside 359 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.
365 begin/end escapes, will be replaced by the given media indicated
366 in the insert media escape.
367 360
368ic[CW;H;FULL\-PATH\-OR\-URL] 361ic[CW;H;FULL\-PATH\-OR\-URL]
369 = insert CENTERED media (centered in cell area). otherwise paramaters are 362 insert CENTERED media (centered in cell area). otherwise
370 identical to the "is" command, but retains aspect and is padded by 363 paramaters are identical to the "is" command, but
371 blank space. 364 retains aspect and is padded by blank space.
372 365
373if[CW;H;FULL\-PATH\-OR\-URL] 366if[CW;H;FULL\-PATH\-OR\-URL]
374 = insert FILLED media (fill in cell area). otherwise paramaters are 367 insert FILLED media (fill in cell area). otherwise paramaters
375 identical to the "is" command but ensures the entire area is 368 are identical to the "is" command but ensures the entire
376 filled like a background even if media goes beyond cell bounds and is 369 area is filled like a background even if media goes beyond
377 clipped. 370 cell bounds and is clipped.
378 371
379it[CW;H;FULL\-PATH\-OR\-URL] 372it[CW;H;FULL\-PATH\-OR\-URL]
380 = insert THUMB media (thumbnail cell area). otherwise paramaters are 373 insert THUMB media (thumbnail cell area). otherwise paramaters
381 identical to the "is" command, but uses thumbnail generation to 374 are identical to the "is" command, but uses thumbnail
382 make a fast to load but low resolution version (cached) of the media. 375 generation to make a fast to load but low resolution version
376 (cached) of the media.
383 377
384ib 378ib
385 = begin media replace sequence run 379 begin media replace sequence run
386 380
387ie 381ie
388 = end media replace sequence run 382 end media replace sequence run
389 383
390.SH BUGS 384.SH BUGS
391If you find a bug or for known issues/bugs/feature requests please email 385If you find a bug or for known issues/bugs/feature requests please email enlightenment-devel@lists.sourceforge.net or visit the place where all the hard work is done http://phab.enlightenment.org/
392enlightenment-devel@lists.sourceforge.net or visit the place where all the hard
393work is done http://phab.enlightenment.org/
394 386
395.SH AUTHOR 387.SH AUTHOR
396Terminology was written by Carsten Haitzler <raster@rasterman.com> and others. See 388Terminology was written by Carsten Haitzler <raster@rasterman.com> and others. See AUTHORS file for other contributors.
397AUTHORS file for other contributors.