Skip to content

Commit 5c5560d

Browse files
committed
Update manpage.
1 parent af53c33 commit 5c5560d

File tree

5 files changed

+547
-543
lines changed

5 files changed

+547
-543
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Options:
123123
--version : Print version and exit.
124124
--verbose : Print some stats after images shown.
125125
-h : Print this help and exit.
126-
--help : Print detailed help and exit.
126+
--help : Page through detailed manpage-like help and exit.
127127
128128
Scrolling
129129
--scroll=[<ms>] : Scroll horizontally (optionally: delay ms (60)).

man/timg.1

+4-3
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ correctly, but they look more `blocky'.
9191
\f[B]quarter\f[R] (short `q')
9292
This chooses a Unicdoe character with small sub-blocks for four pixels
9393
per characcter cell.
94-
:
9594
Quarter blocks will have a pixel aspect ratio of 1:2 (timg will stretch
9695
the picture accordingly, no worries), and can only
9796
represent colors approximately, as the four quadrant sub-pixels can only
@@ -116,7 +115,6 @@ The Kitty terminal implements an image protocol that allows for full
116115
24Bit RGB/32 Bit RGBA images to be displayed.
117116
This is implemented in the
118117
\f[V]kitty\f[R] terminal but also e.g.\ \f[V]konsole\f[R].
119-
:
120118
This is the only protocol that currently also works within
121119
\f[V]tmux\f[R],
122120
but since it requires some very specific workarounds to \f[V]tmux\f[R]
@@ -360,9 +358,12 @@ Print version and exit.
360358
Print some useful information such as observed terminal cells, chosen
361359
pixelation, or observed frame-rate.
362360
.TP
363-
\f[B]-h\f[R], \f[B]--help\f[R]
361+
\f[B]-h\f[R]
364362
Print command line option help and exit.
365363
.TP
364+
\f[B]--help\f[R]
365+
Page through detailed manpage-like help and exit.
366+
.TP
366367
\f[B]--debug-no-frame-delay\f[R]
367368
Don\[cq]t delay frames in videos or animations but emit as fast as
368369
possible.

man/timg.1.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ With **-I** or **-V** you can choose to use only one of these file decoders
6868
**quarter** (short 'q')
6969
: This chooses a Unicdoe character with small sub-blocks for four pixels
7070
: per characcter cell.
71-
:
7271
: Quarter blocks will have a pixel aspect ratio of 1:2 (timg will stretch
7372
: the picture accordingly, no worries), and can only
7473
: represent colors approximately, as the four quadrant sub-pixels can only
@@ -88,7 +87,6 @@ With **-I** or **-V** you can choose to use only one of these file decoders
8887
: The Kitty terminal implements an image protocol that allows for full
8988
: 24Bit RGB/32 Bit RGBA images to be displayed. This is implemented in the
9089
: `kitty` terminal but also e.g. `konsole`.
91-
:
9290
: This is the only protocol that currently also works within `tmux`,
9391
: but since it requires some very specific workarounds to `tmux`
9492
: reluctance to support graphics (Unicode placeholders), it might only
@@ -286,9 +284,12 @@ With **-I** or **-V** you can choose to use only one of these file decoders
286284
: Print some useful information such as observed terminal cells,
287285
chosen pixelation, or observed frame-rate.
288286

289-
**-h**, **-\-help**
287+
**-h**
290288
: Print command line option help and exit.
291289

290+
**-\-help**
291+
: Page through detailed manpage-like help and exit.
292+
292293
**-\-debug-no-frame-delay**
293294
: Don't delay frames in videos or animations but emit as fast as possible.
294295
This might be useful for developers of terminal emulations to do performace

0 commit comments

Comments
 (0)