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 committed Oct 31, 2023
1 parent f0c3723 commit 1d61420
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions docs/imgcat.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\" Automatically generated by Pandoc 3.1.1
.\"
.TH "IMGCAT" "1" "October 30, 2023" "imgcat User Manual" "meow"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "IMGCAT" "1" "October 31, 2023" "imgcat User Manual" "meow"
.hy
.SH NAME
.PP
Expand All @@ -17,7 +31,7 @@
\f[B]imgcat\f[R] prints an image to your terminal screen.
.PP
The image can either be provided as a command line argument, or can be
piped in through \f[C]stdin\f[R].
piped in through \f[V]stdin\f[R].
.PP
By default, the image is printed at the full width and color depth
detected for your terminal.
Expand Down Expand Up @@ -49,7 +63,7 @@ file, or piped into another program), then the image is \f[B]not\f[R]
resized and the color depth is set to 8 colors.
Overriding both width, height, and color depth still work.
.PP
\f[B]Make sure your \f[CB]TERM\f[B] environment variable is set to a
\f[B]Make sure your \f[VB]TERM\f[B] environment variable is set to a
terminfo with the full capabilities of you terminal!\f[R] See
\f[B]Troubleshooting\f[R] if you\[cq]re having a problem with this.
.SS Options
Expand All @@ -59,7 +73,7 @@ Explicitly set the output color depth to one of \f[B]ansi\f[R],
\f[B]8\f[R] (alias of \f[B]ansi\f[R]), \f[B]256\f[R], \f[B]24bit\f[R],
\f[B]true\f[R] (alias of \f[B]24bit\f[R]) or \f[B]iterm\f[R].
If not provided, the output color depth will be inferred with
\f[C]tput colors\f[R].
\f[V]tput colors\f[R].
.TP
\f[B]-h\f[R], \f[B]\[en]help\f[R]
Show common options and quit.
Expand Down Expand Up @@ -110,10 +124,11 @@ Same as \f[B]\[en]depth=iterm2\f[R].
\f[B]imgcat\f[R] supports iTerm2\[cq]s full-color inline images (use
\f[B]-d iterm\f[R] to explicitly enable this).
However, iTerm2 is bundled with a script that is also called
\f[B]imgcat\f[R]! To use this program in preference to the script
bundled with iTerm2, edit your shell\[cq]s configuration file such that,
after the line that sources iTerm2\[cq]s shell integration and
utilities, you unalias its built-in script:
\f[B]imgcat\f[R]!
To use this program in preference to the script bundled with iTerm2,
edit your shell\[cq]s configuration file such that, after the line that
sources iTerm2\[cq]s shell integration and utilities, you unalias its
built-in script:
.IP
.nf
\f[C]
Expand All @@ -132,7 +147,7 @@ $ tput colors
.fi
.PP
If this is not what you expect, you might want to change your
\f[C]TERM\f[R] environment variable.
\f[V]TERM\f[R] environment variable.
For example, iTerm2 users will probably want the following:
.IP
.nf
Expand All @@ -142,7 +157,7 @@ $ export TERM=xterm-256color
.fi
.PP
However, it\[cq]s better that your terminal emulator reports itself with
the proper value for \f[C]TERM\f[R].
the proper value for \f[V]TERM\f[R].
For iTerm2, again, look under the current profile settings > Terminal >
Terminal Emulation > and change \[lq]Report Terminal Type\[rq].
.SH BUGS
Expand Down

0 comments on commit 1d61420

Please sign in to comment.