Skip to content

Commit

Permalink
chore(docs): build man page
Browse files Browse the repository at this point in the history
  • Loading branch information
eddieantonio authored and github-actions[bot] committed Dec 18, 2023
1 parent e4dfb67 commit 483acde
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/imgcat.1
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,16 @@ Maintains the original image\[cq]s aspect ratio if \f[B]\[en]width\f[R]
is NOT provided.
.TP
\f[B]-P\f[R], \f[B]\[en]no-preserve-aspect-ratio\f[R]
Does not preserve aspect ratio during image resizing.
Allows for arbitrary image resizing when specifying both
\f[C]--width\f[R] and \f[C]--height\f[R].
By default, if both \f[C]--width\f[R] and \f[C]--height\f[R] are
provided, the image\[cq]s aspect ratio is preserved (it does not get
stretched in any direction), and the \f[C]--width\f[R] and
\f[C]--height\f[R] specify the maximum amount of characters that the
image be resized to.
If you provide \f[C]--no-preserve-aspect-ratio\f[R], then
\f[C]--width\f[R] and \f[C]--height\f[R] are exact dimensions, and the
image might be squished accordingly.
.TP
\f[B]-R\f[R], \f[B]\[en]no-resize\f[R]
Does not resize the image to fit the terminal\[cq]s width.
Expand Down Expand Up @@ -154,4 +163,4 @@ See GitHub Issues: <https://github.com/eddieantonio/imgcat/issues>
.SH AUTHOR
.PP
\f[B]imgcat\f[R] was written by Eddie Antonio Santos
<https://eddieantonio.ca/>.
<https://eddieantonio.ca/> and contributors.

0 comments on commit 483acde

Please sign in to comment.