Files
termage/man/man1/termage.1
2025-07-15 16:47:05 +02:00

70 lines
1.4 KiB
Groff

.Dd July 15, 2025
.Dt termage 1
.Os
.Sh NAME
.Nm termage
.Nd show images in the terminal
.Sh SYNOPSIS
.Nm
.Fl h
.Nm
.Fl \-version
.Nm
.Ar
.Sh DESCRIPTION
The
.Nm
utility tries to read the given image file and displays it in the terminal,
using UTF-8 block characters.
For every terminal line, there will be two pixel rows possible.
.Pp
.Nm
uses
.Xr ImageMagick 1
to interpret the image.
It also needs the
.Xr netpbm 3
library for reading the image data supplied by ImageMagick.
.Pp
The best results are obtained when the terminal supports true color.
Otherwise,
.Nm
will try to match the colors as closely as possible, given the available color
palette.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h, \-help
Print help text and exit.
.It Fl \-version
Print version info and exit.
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev TERM
This variable indicates the capabilities of your terminal, with the number of
colors supported as one of the properties.
.It Ev COLORTERM
When this variable has the value
.Ar truecolor ,
this indicates your terminal supports true colors.w
.El
.\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES
.Sh EXIT STATUS
.Nm
exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.Sh SEE ALSO
.Xr ImageMagick 1 ,
.Xr netpbm 3 .
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
.An Bob Polis
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS