summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man1/ppmtoterm.1
blob: 0c3a4a09236cf29b4bef079fd3ffe46535817b53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Ppmtoterm User Manual" 0 "17 June 2017" "netpbm documentation"

.SH NAME

ppmtoterm - convert a PPM image to a ANSI ISO 6429 ascii image

.UN synopsis
.SH SYNOPSIS

\fBppmtoterm\fP

[\fIppmfile\fP]
.PP
All options can be abbreviated to their shortest unique prefix.
You may use two hyphens instead of one.  You may separate an option
name and its value with white space instead of an equals sign.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&. 
.PP
This program tries to produce an accurate representation of a PPM
image on an terminal that implements the ANSI ISO 6429 standard.  It
approximates colors, finding the minimum Cartesian distance between the
input RGB vectors and the ones in the generated palette.  As the
available color palette is somewhat restricted, you get the best
results when the colors in the original image are few and the RGB
intensities are close to zero, half of maximum, and maximum.
.PP
You can usually get good results with cartoons or images with
plain colors (no gradients).  With photos, results can vary, but are
usually not very accurate.
.PP
The output image has one line for each row and one character for each
column of the input image.  E.g. an 80 pixel by 25 pixel PPM image would
fill up an 80x25 terminal screen.  Use \fBpamscale\fP or \fBpamcut\fP
to make your image fit properly on your screen.
.PP
Furthermore, use \fBpamscale\fP to recover the proper aspect ratio,
because a character on a terminal screen is rarely square.  Typically, a
character is twice has high as it is wide, so in order for a 20x20 image to
appear square on your terminal, as it should, you'll want to squash it
vertically or stretch it horizontally by a factor of two (resulting int 10x20
characters are 20x40 characters).
.PP
The image starts at the current cursor position on the terminal
screen.  Each successive row starts at Column 0 on the screen.  If you want
to shift the image up or down, for example to center it, use
\fBpnmpad\fP on the input.
.PP
This program was born with the objective of displaying nice color
images on the Linux console, e.g. a proper logo at Linux boot.
.PP
\fBppmtoascii\fP does a similar things, but combines 2 or 8 pixels into
one character, where the character roughly represents those particular pixels,
whereas \fBppmtoterm\fP displays each character of the image as a single
pixel.
.PP
\fBpbmto4425\fP does a similar thing for black and white images, using
line drawing characters, on some terminals.

.UN options
.SH OPTIONS
.PP
There are no command line options defined specifically
for \fBppmtoterm\fP, but it recognizes the options common to all
programs based on libnetpbm (See 
.UR index.html#commonoptions
 Common Options
.UE
\&.)

.UN seealso
.SH SEE ALSO
.BR "pamscale" (1)\c
\&,
.BR "pamcut" (1)\c
\&,
.BR "ppmtoascii" (1)\c
\&,
.BR "pbmtoascii" (1)\c
\&,
.BR "pbmto4425" (1)\c
\&,
.BR "ppm" (5)\c
\&


.UN author
.SH AUTHOR

Copyright (C) 2002 by Ero Carrera.


.UN history
.SH HISTORY
.PP
This program was new in Netpbm 10.9 (August 2002).
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/ppmtoterm.html
.PP