summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorBoris Faure <billiob@gmail.com>2014-08-09 12:22:02 +0200
committerBoris Faure <billiob@gmail.com>2014-08-09 12:22:19 +0200
commit30825d3098b3d20f56fb0d11bbe0a029a31b52aa (patch)
tree4dc36fb499afa0d5339d0f569e3ced5db0ddbd25 /man
parentca8f4ce2d3f5ca6cf8d42d79eaade967a01192d0 (diff)
moar bold on terminology's man page!
Diffstat (limited to 'man')
-rw-r--r--man/terminology.1105
1 files changed, 54 insertions, 51 deletions
diff --git a/man/terminology.1 b/man/terminology.1
index 5705075..5655d31 100644
--- a/man/terminology.1
+++ b/man/terminology.1
@@ -37,7 +37,7 @@ Type: STR.
37. 37.
38.TP 38.TP
39.B \-g=GEOMETRY, \-\-geometry=GEOMETRY 39.B \-g=GEOMETRY, \-\-geometry=GEOMETRY
40Terminal geometry to use (eg 80x24 or 80x24+50+20 etc.). 40Terminal geometry to use (eg \fB80x24\fP or \fB80x24+50+20\fP etc.).
41Type: STR. 41Type: STR.
42. 42.
43.TP 43.TP
@@ -97,7 +97,8 @@ Type: STR.
97. 97.
98.TP 98.TP
99.B \-v=VIDEO\-MODULE, \-\-video-module=VIDEO\-MODULE 99.B \-v=VIDEO\-MODULE, \-\-video-module=VIDEO\-MODULE
100Set emotion module to use. Choices are: auto, gstreamer, xine, generic. 100Set emotion module to use. Choices are: \fBauto\fP, \fBgstreamer\fP,
101\fBxine\fP, \fBgeneric\fP.
101. 102.
102.TP 103.TP
103.B \-l=LOGIN, \-\-login=LOGIN 104.B \-l=LOGIN, \-\-login=LOGIN
@@ -306,10 +307,11 @@ Display big font size (10x20 bitmap, or size 20 with scalable).
306. 307.
307.TP 308.TP
308.B gNxM 309.B gNxM
309Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20. 310Make terminal NxM chars in size (if possible). e.g. \fBg80x48\fP \fBg40x20\fP.
310If just one number is provided, it will use the following shortcuts: 311If just one number is provided, it will use the following shortcuts:
311g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60; 312\fBg0=80x24\fP; \fBg1=80x40\fP; \fBg2=80x60\fP; \fBg3=80x80\fP;
312g7=120x80; g8=120x120 313\fBg4=120x24\fP; \fBg5=120x40\fP; \fBg6=120x60\fP;
314\fBg7=120x80\fP; \fBg8=120x120\fP
313. 315.
314.TP 316.TP
315.B b 317.B b
@@ -320,7 +322,7 @@ Reset the background (no media)
320Set the background media to an absolute file PATH 322Set the background media to an absolute file PATH
321 323
322.SH THEMES: 324.SH THEMES:
323Themes can be stored in ~/.config/terminology/themes/ . 325Themes can be stored in \fB~/.config/terminology/themes/\fP .
324 326
325 327
326.SH EXTENDED ESCAPES FOR TERMINOLOGY: 328.SH EXTENDED ESCAPES FOR TERMINOLOGY:
@@ -328,69 +330,70 @@ Themes can be stored in ~/.config/terminology/themes/ .
328.TP 330.TP
329.B [\\\033][}][COMMAND][\\\000] 331.B [\\\033][}][COMMAND][\\\000]
330i.e. 332i.e.
331 1. ESC char (\\033 or 0x1b) 333 1. ESC char (\fB\\033\fP or \fB0x1b\fP)
332 2. } char 334 2. \fB}\fP char
333 3... sequence of UTF8 chars other than nul (\\000 or 0x00). 335 3... sequence of UTF8 chars other than nul (\fB\\000\fP or \fB0x00\fP).
334 4 \\000 char (nul byte or 0x00 to indicate end of sequence) 336 4 \fB\\000\fP char (nul byte or \fB0x00\fP to indicate end of sequence)
335e.g. 337e.g.
336 echo \-n '\\033}Hello world\\000' 338 \fBecho \-n '\\033}Hello world\\000'\fP
337 339
338.B Commands: 340.B Commands:
339 341
340any values inside square brackets [] are to be replaced by some content (numbers, strings, paths, url's etc.). example: 342any values inside square brackets [] are to be replaced by some content (numbers, strings, paths, url's etc.). example:
341 343
342aa[PATH\-OF\-FILE] should be come something like: 344\fBaa[PATH\-OF\-FILE]\fP should be come something like:
343 aa/tmp/file.png 345 \fBaa/tmp/file.png\fP
344or aa[true/false] should become something like: 346or \fBaa[true/false]\fP should become something like:
345 aatrue 347 \fBaatrue\fP
346or 348or
347 aafalse 349 \fBaafalse\fP
348 350
349\-\-\- 351\-\-\-
350 352
351pn[FULL\-PATH\-OR\-URL] 353\fBpn[FULL\-PATH\-OR\-URL]\fP
352 popup the given media file/url now 354 popup the given media file/url now
353 355
354pq[FULL\-PATH\-OR\-URL] 356\fBpq[FULL\-PATH\-OR\-URL]\fP
355 quque a popup for the given media file/url 357 quque a popup for the given media file/url
356 358
357bt[FULL\-PATH\-OR\-URL] 359\fBbt[FULL\-PATH\-OR\-URL]\fP
358 set the terminal background media file/url temporarily 360 set the terminal background media file/url temporarily
359 361
360bp[FULL\-PATH\-OR\-URL] 362\fBbp[FULL\-PATH\-OR\-URL]\fP
361 set the terminal background media file/url permanently 363 set the terminal background media file/url permanently
362 364
363at[on/true/yes/off/false/no] 365\fBat[on/true/yes/off/false/no]\fP
364 set the terminal alpha state to be on, or off temporarily 366 set the terminal alpha state to be on, or off temporarily
365 367
366ap[on/true/yes/off/false/no] 368\fBap[on/true/yes/off/false/no]\fP
367 set the terminal alpha state to be on, or off permanently 369 set the terminal alpha state to be on, or off permanently
368 370
369qs 371\fBqs\fP
370 query grid and font size. stdin will have written to it: 372 query grid and font size. stdin will have written to it:
371 W;H;FW;FH 373 \fBW;H;FW;FH\fP
372 where W is the width of the terminal grid in characters 374 where \fBW\fP is the width of the terminal grid in characters
373 where H is the height of the terminal grid in characters 375 where \fBH\fP is the height of the terminal grid in characters
374 where FW is the width of 1 character cell in pixels 376 where \fBFW\fP is the width of 1 character cell in pixels
375 where FH is the height of 1 character cell in pixels 377 where \fBFH\fP is the height of 1 character cell in pixels
376 378
377is[CW;H;FULL\-PATH\-OR\-URL] 379\fBis[CW;H;FULL\-PATH\-OR\-URL]\fP
378 insert STRETCHED media (where image will stretch to fill the 380 insert STRETCHED media (where image will stretch to fill the
379 cell area) and define expected cell area to be W cells 381 cell area) and define expected cell area to be \fBW\fP cells
380 wide and H cells high, with the image/media/url. 382 wide and \fBH\fP cells high, with the image/media/url.
381 where C is the replace character to be identified in later 383 where \fBC\fP is the replace character to be identified in later
382 text where W is the width in character cells (up to 511). 384 text where \fBW\fP is the width in character cells (up to 511).
383 where H is the height in character cells (up to 511). 385 where \fBH\fP is the height in character cells (up to 511).
384 386
385 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. 387 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 \fBW\fPx\fBH\fP "replace characters" to follow, with each sequence of such replace characters bebung with a \fBib\fP escape command and ending with an \fBie\fP escape command.
386 388
387 the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may be of the form: 389 the \fBFULL\-PATH\-OR\-URL\fP for all the \fBi\fP commands (\fBis\fP,
390 \fBic\fP, \fBif\fP, \fBit\fP) may be of the form:
388 391
389 /full/path/to/file.png 392 \fB/full/path/to/file.png\fP
390 393
391 OR 394 OR
392 395
393 /full/path/to/link\n/full/path/to/file.png 396 \fB/full/path/to/link\n/full/path/to/file.png\fP
394 397
395 where a newline character separates a URI for a link and 398 where a newline character separates a URI for a link and
396 a full path to a file to display in the region. the link 399 a full path to a file to display in the region. the link
@@ -399,34 +402,34 @@ is[CW;H;FULL\-PATH\-OR\-URL]
399 402
400 example: 403 example:
401 404
402 printf("\\\033}is#5;3;%s\000" 405 \fBprintf("\\\033}is#5;3;%s\000"\fP
403 "\\\033}ib#####\\\033}ie\\\n" 406 \fB"\\\033}ib#####\\\033}ie\\\n"\fP
404 "\\\033}ib#####\\\033}ie\\\n" 407 \fB"\\\033}ib#####\\\033}ie\\\n"\fP
405 "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png"); 408 \fB"\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png");\fP
406 409
407 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. 410 note that \fB#\fP is the replace character, and later \fB#\fP chars if inside begin/end escapes, will be replaced by the given media indicated in the insert media escape.
408 411
409ic[CW;H;FULL\-PATH\-OR\-URL] 412\fBic[CW;H;FULL\-PATH\-OR\-URL]\fP
410 insert CENTERED media (centered in cell area). otherwise 413 insert CENTERED media (centered in cell area). otherwise
411 paramaters are identical to the "is" command, but 414 paramaters are identical to the \fBis\fP command, but
412 retains aspect and is padded by blank space. 415 retains aspect and is padded by blank space.
413 416
414if[CW;H;FULL\-PATH\-OR\-URL] 417\fBif[CW;H;FULL\-PATH\-OR\-URL]\fP
415 insert FILLED media (fill in cell area). otherwise paramaters 418 insert FILLED media (fill in cell area). otherwise paramaters
416 are identical to the "is" command but ensures the entire 419 are identical to the \fBis\fP command but ensures the entire
417 area is filled like a background even if media goes beyond 420 area is filled like a background even if media goes beyond
418 cell bounds and is clipped. 421 cell bounds and is clipped.
419 422
420it[CW;H;FULL\-PATH\-OR\-URL] 423\fBit[CW;H;FULL\-PATH\-OR\-URL]\fP
421 insert THUMB media (thumbnail cell area). otherwise paramaters 424 insert THUMB media (thumbnail cell area). otherwise paramaters
422 are identical to the "is" command, but uses thumbnail 425 are identical to the \fBis\fP command, but uses thumbnail
423 generation to make a fast to load but low resolution version 426 generation to make a fast to load but low resolution version
424 (cached) of the media. 427 (cached) of the media.
425 428
426ib 429\fBib\fP
427 begin media replace sequence run 430 begin media replace sequence run
428 431
429ie 432\fBie\fP
430 end media replace sequence run 433 end media replace sequence run
431 434
432.SH BUGS 435.SH BUGS