bob/termage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add relevant help text

Browse Source
This commit is contained in:
Bob Polis
2025-07-15 16:47:05 +02:00
parent 18dc81ba50
commit 3f8990b02f
1 changed files with 33 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
man/man1/termage.1
View File

@@ -1,26 +1,36 @@
.Dd $Mdocdate$ .Dd July 15, 2025
.Dt termage 1 .Dt termage 1
.Os .Os
.Sh NAME .Sh NAME
.Nm termage .Nm termage
.Nd one line about what it does .Nd show images in the terminal
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl h .Fl h
.Nm .Nm
.Fl \-version .Fl \-version
.Nm .Nm
.Op Ar .Ar
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility processes files ... utility tries to read the given image file and displays it in the terminal,
When no file arguments are given, using UTF-8 block characters.
For every terminal line, there will be two pixel rows possible.
.Pp
.Nm .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 .Pp
The options are as follows: The options are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
@@ -29,31 +39,31 @@ Print help text and exit.
.It Fl \-version .It Fl \-version
Print version info and exit. Print version info and exit.
.El .El
.\" .Sh CONTEXT .Sh ENVIRONMENT
.\" For section 9 functions only. .Bl -tag -width Ds
.\" .Sh IMPLEMENTATION NOTES .It Ev TERM
.\" Not used in OpenBSD. This variable indicates the capabilities of your terminal, with the number of
.\" .Sh RETURN VALUES colors supported as one of the properties.
.\" For sections 2, 3, and 9 function return values only. .It Ev COLORTERM
.\" .Sh ENVIRONMENT 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. .\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES .\" .Sh FILES
.Sh EXIT STATUS .Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.Nm .Nm
exits 0 on success, and 1 if an error occurs. exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES .\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS .\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. .\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .Sh ERRORS .Sh SEE ALSO
.\" For sections 2, 3, 4, and 9 errno settings only. .Xr ImageMagick 1 ,
.\" .Sh SEE ALSO .Xr netpbm 3 .
.\" .Xr foobar 1
.\" .Sh STANDARDS .\" .Sh STANDARDS
.\" .Sh HISTORY .\" .Sh HISTORY
.Sh AUTHORS .Sh AUTHORS
Bob Polis .An Bob Polis
.\" .Sh CAVEATS .\" .Sh CAVEATS
.\" .Sh BUGS .\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS .\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.