From 483acde2db9e48f1db7012d556cd867fbf7e94cb Mon Sep 17 00:00:00 2001 From: eddieantonio Date: Mon, 18 Dec 2023 13:35:25 +0000 Subject: [PATCH] chore(docs): build man page --- docs/imgcat.1 | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/imgcat.1 b/docs/imgcat.1 index 091cd12..4800af4 100644 --- a/docs/imgcat.1 +++ b/docs/imgcat.1 @@ -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. @@ -154,4 +163,4 @@ See GitHub Issues: .SH AUTHOR .PP \f[B]imgcat\f[R] was written by Eddie Antonio Santos -. + and contributors.