Add relevant help text

This commit is contained in:
2025-07-15 16:47:05 +02:00
parent 18dc81ba50
commit 3f8990b02f

View File

@@ -1,26 +1,36 @@
.Dd $Mdocdate$
.Dd July 15, 2025
.Dt termage 1
.Os
.Sh NAME
.Nm termage
.Nd one line about what it does
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Nd show images in the terminal
.Sh SYNOPSIS
.Nm
.Fl h
.Nm
.Fl \-version
.Nm
.Op Ar
.Ar
.Sh DESCRIPTION
The
.Nm
utility processes files ...
When no file arguments are given,
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
will read from the standard input.
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
@@ -29,31 +39,31 @@ Print help text and exit.
.It Fl \-version
Print version info and exit.
.El
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.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
.\" For sections 1, 6, and 8 only.
.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 ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.Sh SEE ALSO
.Xr ImageMagick 1 ,
.Xr netpbm 3 .
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
Bob Polis
.An Bob Polis
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.